Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency @tweenjs/tween.js to v24 - autoclosed #4691

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 5, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@tweenjs/tween.js ^23.1.1 -> ^24.0.0 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

tweenjs/tween.js (@​tweenjs/tween.js)

v24.0.0: - groupies!

Compare Source

This release finally deprecates usage of TWEEN as a default Group. All new Tweens now default to having no group, and must be explicitly added to a group if desired. Plus some other improvements to related to groups, including breaking changes (see below for all details and how to migrate if affected).

What's Changed

New Contributors


More Details

 
feat: do not automatically add/remove a tween to/from its associated group, and do not automatically add new Tweens to the global TWEEN group by default.

feat: the tween.group(group) method now has a reciprocal tween.remove() method that will remove a tween from its associated group, and unassociate the group. tween.group() without an arg is no longer valid, see breaking changes and migration below.

fix: when a tween is stopped before its end time, do not allow its update method to continue, therefore preventing logic (f.e. repeat logic) from being triggered

docs: improved the docs, adding some missing information, removing all examples of the global TWEEN group which has been deprecated, and adding docs on how to manage groups of tweens. Also updated samples to use import syntax for importing Tween, avoiding the use of the TWEEN UMD global variable which has been deprecated.

feat: A new Group.allStopped() method returns true if all tweens in a group are not playing (i.e. stopped, and not paused), otherwise false. Useful for stopping an animation loop once all tweens in a group have finished their animation.

deprecated: Methods on TWEEN that come from Group are now deprecated to be removed in a future major version. Migrate forward by making a new Group instead of using TWEEN as a group.

deprecated: The UMD script that creates a global TWEEN variable is deprecated to be removed in a future major version.

deprecated: The CommonJS build is deprecated to be removed in a future major version.

BREAKING:

  • Tweens are no longer automatically added or removed from groups by default when you call any Tween methods such as start(), stop(), or pause(), and the preserve parameter to Group.update() now defaults to true and is deprecated to be removed in a future major version.
    • MIGRATION: To keep old behavior for a while, explicitly call group.update() with false for the second parameter. To migrate forward, do not rely on automatic add/remove of tweens, and instead add/remove tweens to/from groups manually.
  • Group.update() no longer returns a boolean indicating if all tweens have been removed.
    • MIGRATION: Don't rely on auto-add/remove to/from groups. This boolean return was previously useful for stopping an animation loop once all tweens were finished animating. Instead, use the new Group.allStopped() method to check if all tweens in a group are stopped in order to determine whether or not to continue an animation loop.
  • The second group parameter to Tween.constructor now defaults to undefined instead of the global TWEEN group. Additionally it accepts a value of true to restore the old default behavior. The true value is deprecated and will be removed in a future major version.
    • MIGRATION: For the time being the parameter can be set to true to restore the old behavior. To migrate forward, use tween.group(group) or group.add(tween) instead.
  • The argless tween.group() signature has been removed.
    • MIGRATION: Use group.add(tween) or group.remove(tween) instead. tween.group(TWEEN), TWEEN.add(tween), and TWEEN.remove(tween) will also work for now, but they are deprecated and will be removed in a future major version.
  • Group.update's second parameter preserve defaults to true now, and is deprecated to be removed in a future major version, at which point tweens of a group will no longer be automatically added/remove to/from a group when calling any Tween methods such as start(), pause(), or stop().
    • MIGRATION: For now, explicitly set the parameter to false to restore old default behavior when calling group.update(). To migrate forward, do not rely on the automatic add/remove behavior, and instead manually add or remove tweens to or from groups.
  • To make the fix for tween.update() to be a no-op for stopped tweens, we had to break an undocumented feature that allowed tweens to move backward in time (https://github.com/tweenjs/tween.js/pull/271).
    • MIGRATION: To move tweens backward in time after they have already completed, first call tween.start(startTime) then proceed to call tween.update(time) in reverse order as before (see the unit test with "go backward in time" in its name). Without calling tween.start() nothing will happen because stopped/completed tweens will now always return early from update(), as they are considered to be no longer running.

Full Changelog: tweenjs/tween.js@v23.1.3...v24.0.0

v23.1.3: - tisk tisk tisk

Compare Source

Unfortunately we had to revert the fix for yoyo in v23.1.2 because it broke the yoyo demo. lol

So, this ironically fixes yoyo so that it is more fixed than how fixed we thought it was, and we will have to circle back to #​677 again get yoyo even more fixed. 🥴

Full Changelog: tweenjs/tween.js@v23.1.2...v23.1.3


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from a team as a code owner August 5, 2024 03:41
@renovate renovate bot added dependencies Pull requests that update a dependency file slack PRs and issues with this label will be pushed to Slack labels Aug 5, 2024
Copy link

github-actions bot commented Aug 5, 2024

There were failures in the visual tests workflow.
Image diffs for visual tests can be downloaded as an artifact here.

Copy link

github-actions bot commented Aug 5, 2024

There were failures in the visual tests workflow.
Image diffs for visual tests can be downloaded as an artifact here.

Copy link

github-actions bot commented Aug 5, 2024

There were failures in the visual tests workflow.
Image diffs for visual tests can be downloaded as an artifact here.

@renovate renovate bot changed the title fix(deps): update dependency @tweenjs/tween.js to v24 fix(deps): update dependency @tweenjs/tween.js to v24 - autoclosed Aug 5, 2024
@renovate renovate bot closed this Aug 5, 2024
@renovate renovate bot deleted the renovate/tweenjs-tween.js-24.x branch August 5, 2024 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file slack PRs and issues with this label will be pushed to Slack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants