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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update the web-animations description #2251

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c71261d
Update the web-animations description to include direct construction …
flackr Nov 15, 2024
8c30122
Update features/web-animations.yml
flackr Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion features/web-animations.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Collaborator

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?

Suggested change
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.

spec: https://drafts.csswg.org/web-animations-1/
caniuse: web-animation
group: animation
Copy link
Collaborator

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.

Expand Down