Skip to content

[web-animations-1] Add timeline to animate() options (#5013) #5033

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

Merged
merged 2 commits into from
May 8, 2020
Merged

[web-animations-1] Add timeline to animate() options (#5013) #5033

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ebac2f
[web-animations-1] Add timeline to animate options (#5013)
majido Apr 30, 2020
d117954
[scroll-animations-1] Addres bbirtles@ feedback (#5013)
majido May 7, 2020
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
30 changes: 20 additions & 10 deletions web-animations-1/Overview.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5789,6 +5789,7 @@ interface mixin Animatable {

dictionary KeyframeAnimationOptions : KeyframeEffectOptions {
DOMString id = "";
AnimationTimeline? timeline;
};

dictionary GetAnimationsOptions {
Expand All @@ -5813,17 +5814,21 @@ dictionary GetAnimationsOptions {
If the above procedure causes an exception to be thrown, propagate the
exception and abort this procedure.

1. If <var>options</var> is a {{KeyframeAnimationOptions}} object, let
<var>timeline</var> be the <code>timeline</code> member of
<var>options</var> or, if <code>timeline</code> member of
<var>options</var> is missing, be the <a>default document timeline</a>
of the <a>node document</a> of the element on which this method was
called.

1. Construct a new {{Animation}} object, <var>animation</var>, in
the <a>relevant Realm</a> of <var>target</var> by using the
same procedure as the {{Animation()}} constructor, passing
<var>effect</var> as the argument of the same name, and
the <a>default document timeline</a> of the <a>node document</a>
of the element on which this method was called as the
<var>timeline</var> argument.
<var>effect</var> and <var>timeline</var> as arguments of the same name.

1. If <var>options</var> is a {{KeyframeAnimationOptions}} object,
assign the value of the <code>id</code> member of <var>options</var> to
<var>animation</var>'s {{Animation/id}} attribute.
assign the value of the <code>id</code> member of <var>options</var>
to <var>animation</var>'s {{Animation/id}} attribute.

1. Run the procedure to <a>play an animation</a> for
<var>animation</var> with the <var>auto-rewind</var> flag set to true.
Expand Down Expand Up @@ -5856,10 +5861,8 @@ animation.play();</pre>
same interpretation as defined for that constructor.
: <dfn argument for="Animatable/animate(keyframes, options)"
lt="options">options</dfn>
:: The timing and animation options for the created {{KeyframeEffect}}.
This value is passed to the {{KeyframeEffect(target, keyframes,
options)}} constructor as the <var>options</var> parameter and has the
same interpretation as defined for that constructor.
:: The timing and animation options for the created {{KeyframeEffect}} and
{{Animation}}.

</div>

Expand Down Expand Up @@ -5910,6 +5913,13 @@ animation.play();</pre>
:: The string to assign to the generated {{Animation}}'s {{Animation/id}}
attribute.

: <dfn dict-member for=KeyframeAnimationOptions>timeline</dfn>
:: An optional value which, if present, specifies the <a>timeline</a>
with which to associate the newly-created <a>animation</a>.
If missing, the <a>default document timeline</a> of the
{{Document}} <a lt="document associated with a window">associated</a>
with the {{Window}} that is the <a>current global object</a> is used.

: <dfn dict-member for=GetAnimationsOptions>subtree</dfn>
:: If true, indicates that [=animations=] associated with an
[=animation effect=] whose [=target element=] is a [=descendant=]
Expand Down