fix: handle cases when Animation.persist() does not exist #33282
+91
−2
Conversation
This file contains 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
The Animation.persist() API is in our full suport matrix but was added after browsers in our partial support matrix. As no polyfill exists for this feature and it cannot be compiled away this commit explicitly handles the case when the API does not exist. When .persist() is not available we short-circuit the animation, using the existing "is reduced motion" code path to make the animation effectively instant while still firing all animation events, etc.
spmonahan
commented
Nov 16, 2024
| @@ -2,6 +2,9 @@ import * as React from 'react'; | |||
| import type { AnimationHandle, AtomMotion } from '../types'; | |||
|
|
|||
| function useAnimateAtomsInSupportedEnvironment() { | |||
| // eslint-disable-next-line @nx/workspace-no-restricted-globals | |||
| const SUPPORTS_PERSIST = typeof window !== 'undefined' && typeof window.Animation?.prototype.persist === 'function'; | |||
There was a problem hiding this comment.
Not in love with having this here. Ideally it would live in global scope because SUPPORTS_PERSIST will be constant for any given environment.
I moved it here because I could not find a good way to test it with Jest.
There was a problem hiding this comment.
You could move this to a function check in another module and mock that moduile in the tests, but I don't mind keeping it like this ELEMENT_SUPPORTS_WEB_ANIMATIONS is done similarly
📊 Bundle size report
Unchanged fixtures
|
|
Pull request demo site: URL |
fabricteam
reviewed
Nov 16, 2024
| @@ -0,0 +1,7 @@ | |||
| { | |||
There was a problem hiding this comment.
🕵🏾♀️ visual regressions to review in the fluentuiv9 Visual Regression Report
Avatar Converged 2 screenshots
| Image Name | Diff(in Pixels) | Image Type |
|---|---|---|
| Avatar Converged.badgeMask.chromium.png | 6 | Changed |
| Avatar Converged.Badge Mask RTL.chromium.png | 2 | Changed |
Drawer 2 screenshots
| Image Name | Diff(in Pixels) | Image Type |
|---|---|---|
| Drawer.Full Overlay Dark Mode.chromium.png | 2561 | Changed |
| Drawer.overlay drawer full.chromium.png | 3320 | Changed |
ling1726
reviewed
Nov 20, 2024
| }); | ||
|
|
||
| animation.persist(); | ||
| SUPPORTS_PERSIST && animation.persist(); |
There was a problem hiding this comment.
How about we just create a polyfill for https://developer.mozilla.org/en-US/docs/Web/API/Animation/commitStyles?
if (SUPPORTS_PERSIST) {
animation.persist();
} else {
const resultKeyframe = keyframes[keyframes.length - 1];
Object.assign(element.style, resultKeyframe);
}This would ensure that we don't have weirdness when multiple animations are composed https://stackblitz.com/edit/typescript-hqxwu6?file=index.ts
ling1726
reviewed
Nov 21, 2024
| @@ -19,10 +22,10 @@ function useAnimateAtomsInSupportedEnvironment() { | |||
| fill: 'forwards', | |||
|
|
|||
| ...params, | |||
| ...(isReducedMotion && { duration: 1 }), | |||
| ...((isReducedMotion || !SUPPORTS_PERSIST) && { duration: 1 }), | |||
There was a problem hiding this comment.
Why do you need to go through the reduced motion path? the animation will still work without persist - the main consequence is that with for multiple animations that target the same property, the latest animation will replace older ones
There was a problem hiding this comment.
I don't strictly need to. My thinking is twofold:
- It reduces the likelihood of multiple animations targeting the same property. I don't know if this is really true in practice but if you had multiple, delayed animations it seems like it would be.
- If your browser doesn't support
.persist()you don't really fully support this feature so we just opt you out of it. Using reduced motion ensures the functionality is observably the same (barring the multiple animation situation) as all animation events will fire, etc. This only affects browsers in our partial support matrix so a graceful degradation approach feels fine to me.
Open to changing this but as-is seems best to me.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previous Behavior
The Animation.persist() API is in our full support matrix but was added after browsers in our partial support matrix. As no polyfill exists for this feature and it cannot be compiled away this commit explicitly handles the case when the API does not exist.
New Behavior
When .persist() is not available we short-circuit the animation, using the existing "is reduced motion" code path to make the animation effectively instant while still firing all animation events, etc.