v25.0.0 - end of the end
BREAKING: no longer auto-start tweens by default when calling tween.update()
. To restore previous behavior for the whole app, set the static Tween.autoStartOnUpdate
property to true
.
fix: make the end()
method work better by setting the end time to start + duration instead of Infinity.
Full Changelog: https://github.com/tweenjs/tween.js/compare/v24.0.0...v25.0.0
v24.0.0 - groupies!
This release finally deprecates usage of TWEEN
as a default Group
. All new Tween
s 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).
- Tiny readme fix for import-map example code. by @Bug-Reaper in https://github.com/tweenjs/tween.js/pull/685
- do not default to global TWEEN group for new Tweens, do not auto-add/remove tweens from groups, and update docs accordingly by @trusktr in https://github.com/tweenjs/tween.js/pull/688
- @Bug-Reaper made their first contribution in https://github.com/tweenjs/tween.js/pull/685
feat: do not automatically add/remove a tween to/from its associated group, and do not automatically add new Tween
s 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()
, orpause()
, and thepreserve
parameter toGroup.update()
now defaults totrue
and is deprecated to be removed in a future major version.- MIGRATION: To keep old behavior for a while, explicitly call
group.update()
withfalse
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.
- MIGRATION: To keep old behavior for a while, explicitly call
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.
- 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
- The second
group
parameter toTween.constructor
now defaults toundefined
instead of the globalTWEEN
group. Additionally it accepts a value oftrue
to restore the old default behavior. Thetrue
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, usetween.group(group)
orgroup.add(tween)
instead.
- MIGRATION: For the time being the parameter can be set to
- The argless
tween.group()
signature has been removed.- MIGRATION: Use
group.add(tween)
orgroup.remove(tween)
instead.tween.group(TWEEN)
,TWEEN.add(tween)
, andTWEEN.remove(tween)
will also work for now, but they are deprecated and will be removed in a future major version.
- MIGRATION: Use
Group.update
's second parameterpreserve
defaults totrue
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 asstart()
,pause()
, orstop()
.- MIGRATION: For now, explicitly set the parameter to
false
to restore old default behavior when callinggroup.update()
. To migrate forward, do not rely on the automatic add/remove behavior, and instead manually add or remove tweens to or from groups.
- MIGRATION: For now, explicitly set the parameter to
- 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 calltween.update(time)
in reverse order as before (see the unit test with "go backward in time" in its name). Without callingtween.start()
nothing will happen because stopped/completed tweens will now always return early fromupdate()
, as they are considered to be no longer running.
- MIGRATION: To move tweens backward in time after they have already completed, first call
Full Changelog: https://github.com/tweenjs/tween.js/compare/v23.1.3...v24.0.0
v23.1.3 - tisk tisk tisk
Unfortunately we had to revert the fix for yoyo in v23.1.2 because it broke the yoyo demo. lol
- #687
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: https://github.com/tweenjs/tween.js/compare/v23.1.2...v23.1.3
v23.1.2 - yo yo yo yo!
- fix yoyo repeat bug by @humodz in https://github.com/tweenjs/tween.js/pull/683
- Change the Easing.Linear methods to pure function so that saving them to a variable and calling them won't error. F.e. this no longer errors:
let in = TWEEN.Easing.Linear.In; in()
. by @soumen-pradhan in https://github.com/tweenjs/tween.js/pull/682
- @humodz made their first contribution in https://github.com/tweenjs/tween.js/pull/682
- @soumen-pradhan made their first contribution in https://github.com/tweenjs/tween.js/pull/682
Full Changelog: https://github.com/tweenjs/tween.js/compare/v23.1.1...v23.1.2
v23.1.1
What's Changed
- fixbug:when duration is negative,there should has no animate,not a bad result by @jackletter in https://github.com/tweenjs/tween.js/pull/669
New Contributors
- @jackletter made their first contribution in https://github.com/tweenjs/tween.js/pull/669
Full Changelog: https://github.com/tweenjs/tween.js/compare/v23.1.0...v23.1.1
v23.0.0 - Time Travel
What's Changed
- Add : tests for onRepeat callback by @MasatoMakino in https://github.com/tweenjs/tween.js/pull/609
- Handling of repeats with browser tab sleep by @MasatoMakino in https://github.com/tweenjs/tween.js/pull/564
- When updates are skipped (f.e. due to
requestAnimationFrame
not firing for unfocused tabs) and then start firing again later, things now work (tweens can travel properly into the future).
- When updates are skipped (f.e. due to
- BREAKING: negative values for
.delay()
are no longer valid (it was not a documented feature). See df8214619f671162034b9c881f81eafcdcbcad92 for migration example. - Update examples to avoid removed features by @trusktr
Full Changelog: https://github.com/tweenjs/tween.js/compare/v22.0.0...v23.0.0
v22.0.0 - CommonJS is not so common anymore!
But! Some people might still be using it, so:
Fixes
- Fix CJS entry point by @inukshuk in https://github.com/tweenjs/tween.js/pull/659, thanks!
- BREAKING: This is a potentially breaking change because
dist/index.cjs.js
was renamed todist/index.cjs
. If you relied ondist/index.cjs.js
, update your paths and you'll be good to go.
- BREAKING: This is a potentially breaking change because
New Contributors
- @inukshuk made their first contribution in https://github.com/tweenjs/tween.js/pull/659
Full Changelog: https://github.com/tweenjs/tween.js/compare/v21.1.1...v22.0.0
v21.1.1 - TypeScript all day every day!
Fixes:
- fix the
exports
field so that types will be discoverable by TypeScript out of the box when importing tween.js into a TS project. Thanks @tazyong @jramstedt @keiya01!
Docs:
- fix broken tutorial link. Thanks @victorbnl!
Full Changelog: https://github.com/tweenjs/tween.js/compare/v21.0.0...v21.1.1
v21.0.0 - Back to the Future
Docs:
- bf50c1f529a96b646e3c5fffececb918c4ea7384- Chinese docs up to date with the latest English source. Thanks @mk965!
🎉
Possibly Breaking Change:
- 283e66e3b1d3c90cfd186b1b6ea83bb5c542cb56 - An
exports
field was added topackage.json
to make it compatible with ESM tools (to override themain
field currently pointing at a CommonJS file which doesn't make sense for ESM, but does for old Node.js). To be safe, we made this a major version because there's a chance it can break someone's app (f.e. if they imported from dist/ directly, that will now be blocked, and they would need to changeimport ... from '@tweenjs/tween.js/dist/tween.esm.js'
toimport ... from '@tweenjs/tween.js'
). Thanks for this @christjt!
v20.0.0 - Good luck, bunnies!
You won't be able to outrun the fox!
Fixes
- Fixed the video_and_time example which sometimes didn't play a video.
Breaking changes:
- By default, the "dynamic to" feature is no longer enabled. To enable it, you must now enable it with
tween.dynamic(true)
.Warning When
dynamic
is set tofalse
, Tween makes a copy of the object passed intotween.to()
and will never modify it (hence updating the original object from the outside is not dynamic). Whendynamic
istrue
, Tween uses the original object as the source of values during animation (every update reads the values, hence they can be modified dynamically) but note that in dynamic mode, Tween will modify any interpolation arrays of the object passed intotween.to()
which may cause side-effects on any external code that may also rely on the same object. We've added two new dynamic_to examples. In each example, when dynamic is disabled, the fox cannot catch any rabbits. When dynamic is enabled, the rabbits have no chance! tween.to()
now throws if it is called when a tween is started (even if paused). Calltween.stop()
first before setting a new.to()
value.