fix(core)!: stop firing onRest when an active animation is retargeted#2467
Open
joshuaellis wants to merge 2 commits into
Open
fix(core)!: stop firing onRest when an active animation is retargeted#2467joshuaellis wants to merge 2 commits into
joshuaellis wants to merge 2 commits into
Conversation
Calling spring.start() with a new "to" value mid-flight no longer invokes the previous animation's onRest handler. onRest is documented as called when the animation comes to a stand-still, and a retarget is not a stand-still — the spring keeps moving toward the new goal. The start() promise still resolves with finished: false on retarget, so callers that need the old goal-abandoned signal can read it there. onRest continues to fire on reset, cancel, and normal settle.
🦋 Changeset detectedLatest commit: ad0624c The changes in this PR will be included in the next version bump. This PR includes changesets to release 13 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
joshuaellis
changed the title
joshuaellis
force-pushed
the
next
branch
3 times, most recently
from
aeb1a92 to
5812ef4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Breaking change. Calling
spring.start()with a newtovalue mid-flight currently fires the previous animation'sonRestwith{ finished: false }.onRestis documented as "called when the animation comes to a stand-still" — a retarget is not a stand-still, the spring keeps moving toward the new goal.Behaviour change
After this PR, the retarget path no longer fires
onRest. Normal settle,reset,cancel, and asynctoare unchanged. Thestart()promise still resolves withfinished: falsefor callers that need the old-goal-abandoned signal.The asymmetry lived in a single
raf.batchedUpdatesblock inSpringValue._merge— the oldonRestfired unconditionally while the matchingonStartwas already guarded byif (!reset). The fix movesonRestinside theif (reset)branch.Migration
Consumers doing side effects in
onRestwithout inspectingresult.finishedwill see fewer calls. If you relied on the retarget call (cleanup, analytics, navigation), read thefinished: falseresolution from thestart()promise instead, or move the side effect toonChange.