-
Notifications
You must be signed in to change notification settings - Fork 115
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
Update the web-animations description #2251
base: main
Are you sure you want to change the base?
Conversation
…and modifying CSS animations and transitions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggesting some changes to the description.
Also based on my comment here #2244 (comment) I would add the following BCD keys to the feature:
- api.Document.getAnimations
- api.Element.getAnimations
- api.ShadowRoot.getAnimations
Co-authored-by: Patrick Brosset <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I've caught up on the discussion here and in the original issue. I've got some ideas for the description (to avoid losing the context of Element
and such) and an idea to fix the computed status too. Thank you!
@@ -1,5 +1,5 @@ | |||
name: Web animations | |||
description: The `animate()` method of `Element` objects programmatically animates elements over time and can synchronize the animations of multiple elements. | |||
description: The `animate()` method, together with the `Animation` interface, animates an element over time, possibly synchronizing the animations of multiple elements. The `getAnimations()` method queries and modifies current CSS animations, transitions, and web animations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, after reading this it's almost as if we're trying to do too much to tease out the individual pieces of the API. Instead, I'm wondering if we can't give an overview and hint at what things to go look up in the docs. What do you think of something like this?
description: The `animate()` method, together with the `Animation` interface, animates an element over time, possibly synchronizing the animations of multiple elements. The `getAnimations()` method queries and modifies current CSS animations, transitions, and web animations. | |
description: The `animate()` method of `Element` objects, the `document.getAnimations()` method, and the `Animation` interface animate elements over time and coordinate elements' scripted animations, CSS animations, and transitions. |
@@ -1,5 +1,5 @@ | |||
name: Web animations | |||
description: The `animate()` method of `Element` objects programmatically animates elements over time and can synchronize the animations of multiple elements. | |||
description: The `animate()` method, together with the `Animation` interface, animates an element over time, possibly synchronizing the animations of multiple elements. The `getAnimations()` method queries and modifies current CSS animations, transitions, and web animations. | |||
spec: https://drafts.csswg.org/web-animations-1/ | |||
caniuse: web-animation | |||
group: animation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's out of range of the diff, so I can't directly suggest it, but to match the description and fully resolve #2244 we also need to change which keys drive the headline status. This will also line us more closely with caniuse.
You'll need this in the current YAML file:
status:
compute_from:
- api.Element.animate
- api.Animation
- api.Document.getAnimations
and you'll need to run npm install
and npm run dist
and commit the results.
Update the web-animations description to include
Animation
directlygetAnimations()
This fixes #2244.