ScrollTimeline: ScrollTimeline() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The ScrollTimeline() constructor creates a new ScrollTimeline object instance.

Syntax

new ScrollTimeline(options)

An object that can contain the following properties:

A reference to an Element representing the scrollable element (scroller) whose scroll position will drive the progress of the timeline.

An enumerated value representing the scroll axis that will drive the progress of the timeline. Possible values are:

"block": The scrollbar on the block axis of the scroll container, which is the axis in the direction perpendicular to the flow of text within a line. For horizontal writing modes, such as standard English, this is the same as "y", while for vertical writing modes, it is the same as "x".
"inline": The scrollbar on the inline axis of the scroll container, which is the axis in the direction parallel to the flow of text in a line. For horizontal writing modes, this is the same as "x", while for vertical writing modes, this is the same as "y".
"y": The scrollbar on the vertical axis of the scroll container.
"x": The scrollbar on the horizontal axis of the scroll container.

If omitted, axis defaults to "block".