Scroll-driven Animations

1. Introduction

This specification defines mechanisms for driving the progress of an animation based on the scroll progress of a scroll container. These scroll-driven animations use a timeline based on scroll position, rather than one based on clock time. This module provides both an imperative API building on the Web Animations API as well as a declarative API building on CSS Animations. [WEB-ANIMATIONS-1]

There are two types of scroll-driven timelines:

• Scroll Progress Timelines, which are linked to the scroll progress of a particular scroll container

• View Progress Timelines, which are linked to the view progress of a particular box through a scrollport

Note: Scroll-driven animations, whose progress is linked to the scroll position, are distinct from scroll-triggered animations, which are triggered by a scroll position, but whose progress is driven by time.

1.1. Relationship to other specifications

Web Animations [WEB-ANIMATIONS-1] defines an abstract conceptual model for animations on the Web platform, with elements of the model including animations and their timelines, and associated programming interfaces. This specification extends the Web Animations model by defining scroll-driven timelines and allowing them to drive progress in animations to create scroll-driven animations.

This specification introduces both programming interfaces for interacting with these concepts, as well as CSS properties that apply these concepts to CSS Animations [CSS-ANIMATIONS-1]. To the extent the behavior of these CSS properties is described in terms of the programming interfaces, User Agents that do not support scripting may still conform to this specification by implementing the CSS features to behave as if the underlying programming interfaces were in place.

Like most operations in CSS besides selector matching, features in this specification operate over the flattened element tree.

1.2. Relationship to asynchronous scrolling

Some user agents support scrolling that is asynchronous with respect to layout or script. This specification is intended to be compatible with such an architecture.

Specifically, this specification allows expressing scroll-driven effects in a way that does not require script to run each time the effect is sampled. User agents that support asynchronous scrolling are allowed (but not required) to sample such effects asynchronously as well.

1.3. Value Definitions

This specification follows the CSS property definition conventions from [CSS2] using the value definition syntax from [CSS-VALUES-3]. Value types not defined in this specification are defined in CSS Values & Units [CSS-VALUES-3]. Combination with other CSS modules may expand the definitions of these value types.

In addition to the property-specific values listed in their definitions, all properties defined in this specification also accept the CSS-wide keywords as their property value. For readability they have not been repeated explicitly.

2. Scroll Progress Timelines

Scroll progress timelines are timelines linked to progress in the scroll position of a scroll container along a particular axis. The startmost scroll position represents 0% progress and the endmost scroll position represents 100% progress.

Scroll progress timelines can be referenced in animation-timeline anonymously using the scroll() functional notation or by name (see § 4.2 Named Timeline Scoping and Lookup) after declaring them using the scroll-timeline properties. In the Web Animations API, they can be represented anonymously by a ScrollTimeline object.

2.1. Calculating Progress for a Scroll Progress Timeline

Progress (the current time) for a scroll progress timeline is calculated as: scroll offset ÷ (scrollable overflow size − scroll container size)

If the 0% position and 100% position coincide (i.e. the denominator in the current time formula is zero), the timeline is inactive.

In paged media, scroll progress timelines that would otherwise reference the document viewport are also inactive.

2.2. Anonymous Scroll Progress Timelines

2.2.1. The scroll() notation

The scroll() functional notation can be used as a <single-animation-timeline> value in animation-timeline and specifies a scroll progress timeline. Its syntax is

<scroll()> = scroll( [ <scroller> || <axis> ]? )
<axis> = block | inline | vertical | horizontal
<scroller> = root | nearest | self

By default, scroll() references the block axis of the nearest ancestor scroll container. Its arguments modify this lookup as follows:

block

Specifies to use the measure of progress along the block axis of the scroll container. (Default.)

inline

Specifies to use the measure of progress along the inline axis of the scroll container.

vertical

Specifies to use the measure of progress along the vertical axis of the scroll container.

horizontal

Specifies to use the measure of progress along the horizontal axis of the scroll container.

nearest

Specifies to use the nearest ancestor scroll container. (Default.)

root

Specifies to use the document viewport as the scroll container.

self

Specifies to use the element’s own principal box as the scroll container. If the principal box is not a scroll container, then the scroll progress timeline is inactive.

Note: Progress is in reference to the scroll origin, which can flip depending on writing mode, even when horizontal or vertical is specified.

References to the root element propagate to the document viewport (which functions as its scroll container).

Each use of scroll() corresponds to its own instance of ScrollTimeline in the Web Animations API, even if multiple elements use scroll() to refer to the same scroll container with the same arguments.

2.2.2. The ScrollTimeline Interface

enum ScrollAxis {
  "block",
  "inline",
  "horizontal",
  "vertical"
};

dictionary ScrollTimelineOptions {
  Element? source;
  ScrollAxis axis = "block";
};

[Exposed=Window]
interface ScrollTimeline : AnimationTimeline {
  constructor(optional ScrollTimelineOptions options = {});
  readonly attribute Element? source;
  readonly attribute ScrollAxis axis;
};

A ScrollTimeline is an AnimationTimeline that represents a scroll progress timeline. It can be passed to the Animation constructor or the animate() method to link the animation to a scroll progress timeline.

source, of type Element, readonly, nullable

The scroll container element whose scroll position drives the progress of the timeline.

axis, of type ScrollAxis, readonly

The axis of scrolling that drives the progress of the timeline. See value definitions for <axis>, above.

Inherited attributes:

currentTime (inherited from AnimationTimeline)

Represents the scroll progress of the scroll container as a percentage CSSUnitValue, with 0% representing its startmost scroll position (in the writing mode of the scroll container). Null when the timeline is inactive.

While 0% will usually represent the scroll container’s initial scroll position, it might not depending on its content distribution. See CSS Box Alignment 3 § 5.3 Overflow and Scroll Positions. Is this what we want?

Add a note about whether currentTime can be negative or > 100%.

ScrollTimeline(options)

Creates a new ScrollTimeline object using the following procedure:

1. Let timeline be the new ScrollTimeline object.

2. Set the source of timeline to:

   If the source member of options is present and not null,

   The source member of options.

   Otherwise,

   The scrollingElement of the Document associated with the Window that is the current global object.

3. Set the axis property of timeline to the corresponding value from options.

If the source of a ScrollTimeline is an element whose principal box does not exist or is not a scroll container, or if there is no scrollable overflow, then the ScrollTimeline is inactive.

A ScrollTimeline’s duration is 100%.

The values of source and currentTime are both computed when either is requested or updated.

2.3. Named Scroll Progress Timelines

Scroll progress timelines can also be defined on the scroll container itself, and then referenced by name by elements within the name’s scope (see § 4.2 Named Timeline Scoping and Lookup).

Such named scroll progress timelines are declared in the coordinated value list constructed from the longhands of the scroll-timeline shorthand property, which form a coordinating list property group with scroll-timeline-name as the coordinating list base property. See CSS Values 4 § A Coordinating List-Valued Properties.

Depending on its name attachment (scroll-timeline-attachment), a name specified by scroll-timeline-name can be attached to a scroll progress timeline defined on the element’s own box (local), declared for the element’s scope but deferred to a descendant scroll container’s scroll progress timeline (defer), or used to attach the element’s scroll progress timeline to a name declared and deferred by an ancestor (ancestor), effectively allowing its scope to expand beyond this element and its descendants.

2.3.1. Naming a Scroll Progress Timeline: the scroll-timeline-name property

Specifies names for the named scroll progress timelines associated with this element. Depending on the name’s attachment (view-timeline-attachment), this element can declare a name, define its scroll progress timeline, or both (the default).

2.3.2. Axis of a Scroll Progress Timeline: the scroll-timeline-axis property

Specifies the axis of any named scroll progress timelines sourced from this scroll container. If this box is not a scroll container, then the corresponding named scroll progress timeline is inactive.

Values are as defined for scroll().

Note: This property has no effect when combined with a scroll-timeline-attachment of defer.

2.3.3. Attachment of a Scroll Progress Timeline: the scroll-timeline-attachment property

Specifies the name attachment of each scroll progress timeline name specified by scroll-timeline-name.

Values have the following meanings:

local

This scroll progress timeline name attaches to the corresponding scroll progress timeline defined on this box.

defer

This scroll progress timeline name’s attachment is deferred to its descendants. In other words, this element declares a scroll progress timeline’s name and defines its scope (see § 4.2 Named Timeline Scoping and Lookup), but defers the timeline’s definition (scroll container source and axis) to its descendants.

If more than one matching descendant scroll progress timeline exists, or if no such timeline exists, then the timeline name has no attachment, and represents an inactive timeline.

Should it instead be ignored (be invisible to lookup)? (This might make it harder to implement.) If multiple, should it attach instead to the last declared timeline (in tree order) rather than invalidating the attachment?

ancestor

This scroll progress timeline definition, attaches to the closest matching scroll progress timeline name that was deferred (defer) by an ancestor (if any).

If no such ancestor exists, the attachment is treated as local.

2.3.4. Scroll Timeline Shorthand: the scroll-timeline shorthand

This property is a shorthand for setting scroll-timeline-name, scroll-timeline-axis, and scroll-timeline-attachment in a single declaration.

3. View Progress Timelines

Often animations are desired to start and end during the portion of the scroll progress timeline that a particular box (the view progress subject) is in view within the scrollport. View progress timelines are segments of a scroll progress timeline that are scoped to the scroll positions in which any part of the subject element’s principal box intersects its nearest ancestor scrollport (or more precisely, the relevant view progress visibility range of that scrollport). The startmost such scroll position represents 0% progress, and the endmost such scroll position represents 100% progress; see § 3.2 Calculating Progress for a View Progress Timeline.

Note: The 0% and 100% scroll positions are not always reachable, e.g. if the box is positioned at the start edge of the scrollable overflow rectangle, it might not be possible to scroll to < 32% progress.

View progress timelines can be referenced anonymously using the view() functional notation or by name (see § 4.2 Named Timeline Scoping and Lookup) after declaring them using the view-timeline properties on the view progress subject. In the Web Animations API, they can be represented anonymously by a ViewTimeline object.

3.1. View Progress Timeline Ranges

View progress timelines define the following named timeline ranges:

cover

Represents the full range of the view progress timeline:

• 0% progress represents the latest position at which the start border edge of the element’s principal box coincides with the end edge of its view progress visibility range.

• 100% progress represents the earliest position at which the end border edge of the element’s principal box coincides with the start edge of its view progress visibility range.

contain

Represents the range during which the principal box is either fully contained by, or fully covers, its view progress visibility range within the scrollport.

• 0% progress represents the earliest position at which either:

  • the start border edge of the element’s principal box coincides with the start edge of its view progress visibility range.

  • the end border edge of the element’s principal box coincides with the end edge of its view progress visibility range.

• 100% progress represents the latest position at which either:

  • the start border edge of the element’s principal box coincides with the start edge of its view progress visibility range.

  • the end border edge of the element’s principal box coincides with the end edge of its view progress visibility range.

entry

Represents the range during which the principal box is entering the view progress visibility range.

• 0% is equivalent to 0% of the cover range.

• 100% is equivalent to 0% of the contain range.

exit

Represents the range during which the principal box is exiting the view progress visibility range.

• 0% is equivalent to 100% of the contain range.

• 100% is equivalent to 100% of the cover range.

entry-crossing

Represents the range during which the principal box crosses the end border edge

• 0% progress represents the latest position at which the start border edge of the element’s principal box coincides with the end edge of its view progress visibility range.

• 100% progress represents the earliest position at which the end border edge of the element’s principal box coincides with the end edge of its view progress visibility range.

exit-crossing

Represents the range during which the principal box crosses the start border edge

• 0% progress represents the latest position at which the start border edge of the element’s principal box coincides with the start edge of its view progress visibility range.

• 100% progress represents the earliest position at which the end border edge of the element’s principal box coincides with the start edge of its view progress visibility range.

Insert diagrams.

In all cases, the writing mode used to resolve the start and end sides is the writing mode of the relevant scroll container. Transforms are ignored, but relative and absolute positioning are accounted for.

Note: For sticky-positioned boxes the 0% and 100% progress conditions can sometimes be satisfied by a range of scroll positions rather than just one. Each range therefore indicates whether to use the earliest or latest qualifying position.

[CSS-POSITION-3] [CSS-TRANSFORMS-1]

3.2. Calculating Progress for a View Progress Timeline

Progress (the current time) in a view progress timeline is calculated as: distance ÷ range where:

• distance is the current scroll offset minus the scroll offset corresponding to the start of the cover range

• range is the scroll offset corresponding to the start of the cover range minus the scroll offset corresponding to the end of the cover range

If the 0% position and 100% position coincide (i.e. the denominator in the current time formula is zero), the timeline is inactive.

In paged media, view progress timelines that would otherwise reference the document viewport are also inactive.

3.3. Anonymous View Progress Timelines

3.3.1. The view() notation

The view() functional notation can be used as a <single-animation-timeline> value in animation-timeline and specifies a view progress timeline in reference to the nearest ancestor scroll container. Its syntax is

<view()> = view( [ <axis> || <'view-timeline-inset'> ]? )

By default, view() references the block axis; as for scroll(), this can be changed by providing an explicit <axis> value.

The optional <'view-timeline-inset'> value provides an adjustment of the view progress visibility range, as defined for view-timeline-inset.

Each use of view() corresponds to its own instance of ViewTimeline in the Web Animations API, even if multiple elements use view() to reference the same element with the same arguments.

3.3.2. The ViewTimeline Interface

dictionary ViewTimelineOptions {
  Element subject;
  ScrollAxis axis = "block";
  (DOMString or sequence<(CSSNumericValue or CSSKeywordValue)>) inset = "auto";
};

[Exposed=Window]
interface ViewTimeline : ScrollTimeline {
  constructor(optional ViewTimelineOptions options = {});
  readonly attribute Element subject;
  readonly attribute CSSNumericValue startOffset;
  readonly attribute CSSNumericValue endOffset;
};

A ViewTimeline is an AnimationTimeline that specifies a view progress timeline. It can be passed to the Animation constructor or the animate() method to link the animation to a view progress timeline.

subject, of type Element, readonly

The element whose principal box’s visibility in the scrollport defines the progress of the timeline.

startOffset, of type CSSNumericValue, readonly

Represents the starting (0% progress) scroll position of the view progress timeline as a length offset (in px) from the scroll origin. Null when the timeline is inactive.

endOffset, of type CSSNumericValue, readonly

Represents the ending (100% progress) scroll position of the view progress timeline as a length offset (in px) from the scroll origin. Null when the timeline is inactive.

Note: The values of startOffset and endOffset are relative to the scroll origin, not the physical top left corner. Depending on the writing mode of the scroll container, they therefore might not match scrollLeft or scrollTop values, for example in the horizontal axis in a right-to-left (rtl) writing mode.

Inherited attributes:

source (inherited from ScrollTimeline)

The nearest ancestor of the subject whose principal box establishes a scroll container, whose scroll position drives the progress of the timeline.

axis (inherited from ScrollTimeline)

Specifies the axis of scrolling that drives the progress of the timeline. See <axis>, above.

currentTime (inherited from AnimationTimeline)

Represents the current progress of the view progress timeline as a percentage CSSUnitValue representing its scroll container’s scroll progress at that position. Null when the timeline is inactive.

ViewTimeline(options)

Creates a new ViewTimeline object using the following procedure:

1. Let timeline be the new ViewTimeline object.

2. Set the subject and axis properties of timeline to the corresponding values from options.

3. Set the source of timeline to the subject’s nearest ancestor scroll container element.

4. If a DOMString value is provided as an inset, parse it as a <'view-timeline-inset'> value; if a sequence is provided, the first value represents the start inset and the second value represents the end inset. If the sequence has only one value, it is duplicated. If it has zero values or more than two values, or if it contains a CSSKeywordValue whose value is not "auto", throw a TypeError.

   These insets define the ViewTimeline’s view progress visibility range.

If the source or subject of a ViewTimeline is an element whose principal box does not exist, or if its nearest ancestor scroll container has no scrollable overflow (or if there is no such ancestor, e.g. in print media), then the ViewTimeline is inactive.

The values of subject, source, and currentTime are all computed when any of them is requested or updated.

3.4. Named View Progress Timelines

View progress timelines can also be defined declaratively and then referenced by name by elements within the name’s scope (see § 4.2 Named Timeline Scoping and Lookup).

Such named view progress timelines are declared in the coordinated value list constructed from the view-timeline-* properties, which form a coordinating list property group with view-timeline-name as the coordinating list base property. See CSS Values 4 § A Coordinating List-Valued Properties.

As for named scroll progress timelines, named view progress timelines can have various name attachments, allowing a name specified by view-timeline-name to be attached to the box’s own view progress timeline, deferring it to a descendant box’s view progress timeline, or connecting the box’s view progress timeline to the scope of an ancestor.

3.4.1. Naming a View Progress Timeline: the view-timeline-name property

Specifies names for the named view progress timelines associated with this element. Depending on the name’s attachment (view-timeline-attachment), this element can declare a name, define its view progress timeline, or both (the default).

3.4.2. Axis of a View Progress Timeline: the view-timeline-axis property

Specifies the axis of any named view progress timelines derived from this element’s principal box.

Values are as defined for view().

Note: This property has no effect when combined with a view-timeline-attachment of defer.

3.4.3. Inset of a View Progress Timeline: the view-timeline-inset property

Specifies an inset (positive) or outset (negative) adjustment of the scrollport when determining whether the box is in view when setting the bounds of the corresponding view progress timeline. The first value represents the start inset in the relevant axis; the second value represents the end inset. If the second value is omitted, it is set to the first. The resulting range of the scrollport is the view progress visibility range.

auto

Indicates to use the value of scroll-padding.

<length-percentage>

Like scroll-padding, defines an inward offset from the corresponding edge of the scrollport.

Note: This property has no effect when combined with a view-timeline-attachment of defer.

3.4.4. Attachment of a View Progress Timeline: the view-timeline-attachment property

Specifies the name attachment of each view progress timeline name specified by view-timeline-name.

Values have the following meanings:

local

This view progress timeline name attaches to the corresponding view progress timeline defined on this box.

defer

This view progress timeline name’s attachment is deferred to its descendants. In other words, this element declares a view progress timeline’s name and defines its scope (see § 4.2 Named Timeline Scoping and Lookup), but defers the timeline’s definition (subject, scroll container source, axis, and visibility range) to its descendants.

If more than one matching descendant view progress timeline exists, or if no such timeline exists, then this timeline name has no attachment, and represents an inactive timeline.

ancestor

This view progress timeline definition attaches to the closest matching view progress timeline name that was deferred (defer) by an ancestor (if any).

If no such ancestor exists, the attachment is treated as local.

3.4.5. View Timeline Shorthand: the view-timeline shorthand

This property is a shorthand for setting view-timeline-name, view-timeline-axis, and view-timeline-attachment in a single declaration. It does not set view-timeline-inset.

Should it reset view-timeline-inset also?

4. Attaching Animations to Scroll-driven Timelines

Animations can be attached to scroll-driven timelines using the scroll-timeline property (in CSS) or the AnimationTimeline parameters (in the Web Animations API). The timeline range to which their active interval is attached can also be further restricted to a particular timeline range (see Attaching Animations to Timeline Ranges).

Time-based delays (animation-delay) do not apply to scroll-driven animations, which are distance-based.

4.1. Finite Timeline Calculations

Unlike time-driven timelines, scroll-driven timelines are finite, thus scroll-driven animations are always attached to a finite attachment range—which may be further limited by animation-range (see Appendix A: Timeline Ranges). The animation’s

Note: If the animation has an infinite iteration count, each iteration duration—and the resulting active duration—will be zero.

Animations that include absolutely-positioned keyframes (those pinned to a specific point on the timeline, e.g. using named timeline range keyframe selectors in @keyframes) are assumed to have an iteration count of 1 for the purpose of finding those keyframes’ positions relative to 0% and 100%; the entire animation is then scaled to fit the iteration duration and repeated for each iteration.

Note: It’s unclear what the use case might be for combining absolutely-positioned keyframes with iteration counts above 1; this at least gives a defined behavior. (An alternative, but perhaps weirder, behavior would be to take such absolutely-positioned keyframes “out of flow” while iterating the remaining keyframes.) The editors would be interested in hearing about any real use cases for multiple iterations here.

4.2. Named Timeline Scoping and Lookup

A named scroll progress timeline or view progress timeline is referenceable by:

• the name-declaring element itself

• that element’s descendants

If multiple elements have declared the same timeline name, the matching timeline is the one declared on the nearest element in tree order. In case of a name conflict on the same element, names declared later in the naming property (scroll-timeline-name, view-timeline-name) take precedence, and scroll progress timelines take precedence over view progress timelines.

Note: Although only names on the ancestor chain are visible to a timeline name lookup, a deferred name attachment allows a name declared on an ancestor to be attached to a timeline sourced elsewhere in its subtree, effectively allowing lookup of a timeline sourced from a sibling, cousin, or descendant. See scroll-timeline-attachment/view-timeline-attachment.

<style>
  @keyframes anim {
    from { color: red; }
    to { color: green; }
  }

  .root {
    scroll-timeline: scroller defer;
  }

  .root .animation {
    animation: anim;
    animation-timeline: scroller;
  }

  .root .animation + .scroller {
    scroll-timeline: scroller ancestor;
  }
</style>
&hellip;
<section class="root">
  <div class="animation">Animating Box</div>
  <div class="scroller">Scrollable Box</div>
</section>

If a timeline name has been declared, but does not have a usable attachment (e.g. if it is declared with defer, but no scroll progress timeline or view progress timeline is attached to it), it refers to an inactive timeline.

4.3. Animation Events

Scroll-driven animations dispatch all the same animation events as the more typical time-driven animations as described in Web Animations § 4.4.18 Animation events, CSS Animations 1 § 4 Animation Events, and CSS Animations 2 § 4.1 Event dispatch.

Note: When scrolling backwards, the animationstart event will fire at the end of the active interval, and the animationend event will fire at the start of the active interval. However, since the finish event is about entering the finished play state, it only fires when scrolling forwards.

5. Frame Calculation Details

5.1. HTML Processing Model: Event loop

The ability for scrolling to drive the progress of an animation, gives rise to the possibility of layout cycles, where a change to a scroll offset causes an animation’s effect to update, which in turn causes a new change to the scroll offset.

To avoid such layout cycles, animations with a scroll progress timeline update their current time once during step 7.10 of the HTML Processing Model event loop, as step 1 of update animations and send events.

During step 7.14.1 of the HTML Processing Model, any created scroll progress timelines or view progress timelines are collected into an initially stale set. After step 7.14.1 if there are any initially stale timelines, they update their current time, the set of initially stale timelines is cleared and we run and we run an additional step to recalculate styles and update layout. As we only gather stale timelines during the first style and layout calculation, this can only directly cause one additional style recalculation.

Note: Without this additional round of style and layout, initially stale timelines would remain stale (i.e. they would not have a current time) for the remainder of the frame where the timeline was created. This means that animations linked to such a timeline would not produce any effect value for that frame, which could lead to an undesirable initial "flash" in the rendered output.

Note: This section has no effect on forced style and layout calculations triggered by getComputedStyle() or similar. In other words, initially stale timelines are visible as such through those APIs.

If the step 7.14 of the HTML Processing Model would result in a change of time for any scroll progress timelines or view progress timelines, they will not be re-sampled to reflect the new offset until the next update of the rendering.

Nothing in this section is intended to require that scrolling block on layout or script. If a user agent normally composites frames where scrolling has occurred but the consequences of scrolling have not been fully propagated in layout or script (for example, scroll event listeners have not yet run), the user agent may likewise choose not to sample scroll-driven animations for that composited frame. In such cases, the rendered scroll offset and the state of a scroll-driven animation may be inconsistent in the composited frame.

6. Privacy Considerations

There are no known privacy impacts of the features in this specification.

7. Security Considerations

There are no known security impacts of the features in this specification.

Appendix A: Timeline Ranges

This section should move to CSS-ANIMATIONS-2 and WEB-ANIMATIONS-2.

This specification introduces the concepts of named timeline ranges and animation attachment ranges to CSS Animations and Web Animations.

Named Timeline Ranges

A named timeline range is a named segment of an animation timeline. The start of the segment is represented as 0% progress through the range; the end of the segment is represented as 100% progress through the range. Multiple named timeline ranges can be associated with a given timeline, and multiple such ranges can overlap. For example, the contain range of a view progress timeline overlaps with its cover range. Named timeline ranges are represented by the <timeline-range-name> value type, which indicates a CSS identifier representing one of the predefined named timeline ranges.

Note: In this specification, named timeline ranges must be defined to exist by a specification such as [SCROLL-ANIMATIONS-1]. A future level may introduce APIs for authors to declare their own custom named timeline ranges.

Named Timeline Range Keyframe Selectors

Named timeline range names and percentages can be used to attach keyframes to specific progress points within the named timeline range. The CSS @keyframes rule is extended thus:

<keyframe-selector> = from | to | <percentage [0,100]> | <timeline-range-name> <percentage>

where <timeline-range-name> is the CSS identifier that represents a chosen predefined named timeline range, and the <percentage> after it represents the percentage progress between the start and end of that named timeline range.

Keyframes are attached to the specified point in the timeline. If the timeline does not have a corresponding named timeline range, then any keyframes attached to points on that named timeline range are ignored. It is possible that these attachment points are outside the active interval of the animation; in these cases the automatic from (0%) and to (100%) keyframes are only generated for properties that don’t have keyframes at or earlier than 0% or at or after 100% (respectively).

Attaching Animations to Timeline Ranges

A set of animation keyframes can be attached in reference to an animation attachment range, restricting the animation’s active interval to that range of a timeline, with the animation-range properties. Delays (see animation-delay) are set within this restricted range, further reducing the time available for auto durations and infinite iterations. Any frames positioned outside the attachment range are used for interpolation as needed, but are outside the active interval and therefore dropped from the animation itself, effectively truncating the animation at the end of its attachment range.

range start┐             ╺┉┉active interval┉┉╸           ┌range end
┄┄┄┄┄┄┄┄┄┄┄├─────────────╊━━━━━━━━━━━━━━━━━━━╉───────────┤┄┄┄┄┄┄┄┄
           ╶┄start delay┄╴                   ╶┄end delay┄╴
                         ╶┄┄┄┄┄ duration┄┄┄┄┄╴

The animation-range properties are reset-only sub-properties of the animation shorthand.

Define application to time-driven animations.

Specifying an Animation’s Timeline Range: the animation-range shorthand

The animation-range property is a shorthand that sets animation-range-start and animation-range-end together in a single declaration, associating the animation with the specified animation attachment range.

If <'animation-range-end'> is omitted and <'animation-range-start'> includes a <timeline-range-name> component, then animation-range-end is set to that same <timeline-range-name> and 100%. Otherwise, any omitted longhand is set to its initial value.

animation-range: entry 10% exit 90%;
animation-range-start: entry 10%;
animation-range-end: exit 90%;

animation-range: entry;
animation-range-start: entry 0%;
animation-range-end: entry 100%;

animation-range: entry exit;
animation-range-start: entry 0%;
animation-range-end: exit 100%;

animation-range: 10%;
animation-range-start: 10%;
animation-range-end: normal;

animation-range: 10% 90%;
animation-range-start: 10%;
animation-range-end: 90%;

animation-range: entry 10% exit;
animation-range-start: entry 10%;
animation-range-end: exit 100%;

animation-range: 10% exit 90%;
animation-range-start: 10%;
animation-range-end: exit 90%;

animation-range: entry 10% 90%;
animation-range-start: entry 10%;
animation-range-end: 90%;

What’s the best way to handle defaulting of omitted values here? [Issue #8438]

Specifying an Animation’s Timeline Range Start: the animation-range-start property

Specifies the start of the animations’s attachment range, shifting the start time of the animation (i.e. where keyframes mapped to 0% progress are attached when the iteration count is 1) accordingly.

Values have the following meanings:

normal

The start of the animation’s attachment range is the start of its associated timeline; the start of the animation’s active interval is determined as normal.

<length-percentage>

The animation attachment range starts at the specified point on the timeline measuring from the start of the timeline.

<timeline-range-name> <length-percentage>?

The animation attachment range starts at the specified point on the timeline measuring from the start of the specified named timeline range. If the <length-percentage> is omitted, it defaults to 0%.

Specifying an Animation’s Timeline Range End: the animation-range-end property

Specifies the end of the animations’s attachment range, potentially shifting the end time of the animation (i.e. where keyframes mapped to 100% progress are attached when the iteration count is 1) and/or truncating the animation’s active interval.

Values have the following meanings:

normal

The end of the animation’s attachment range is the end of its associated timeline; the end of the animation’s active interval is determined as normal.

<length-percentage>

The animation attachment range ends at the specified point on the timeline measuring from the start of the timeline.

<timeline-range-name> <length-percentage>?

The animation attachment range ends at the specified point on the timeline measuring from the start of the specified named timeline range. If the <length-percentage> is omitted, it defaults to 100%.

Reporting Timeline Range Progress: the getCurrentTime() method

Progress through named ranges is exposed on the AnimationTimeline object by the getCurrentTime() method:

dictionary AnimationTimeOptions {
  DOMString? range;
};

[Exposed=Window]
partial interface AnimationTimeline {
  CSSNumericValue? getCurrentTime(optional AnimationTimeOptions options = {});
};

This method is related to currentTime but not quite the same; should it have a different name? [Issue #8201]

This method returns percentages relative to a ScrollTimeline’s range when a range name is provided. But for time-based timelines, if a range name is provided, should it return percentage progress through that range, or time progress through that range?

8. Changes

Changes since the previous (6 April 2023) Working Draft include:

• Adding scroll-timeline-attachment and view-timeline-attachment. (Issue 7759)

• Switching getCurrentTime() to take a dictionary of options. (Issue 8201)

• Clarified how view timeline ranges are calculated with position: sticky. (Issue 8298)