W3cubDocs

/Web APIs

ScrollTimeline: ScrollTimeline() constructor

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

Syntax

js

new ScrollTimeline(options)

Parameters

options

An object that can contain the following properties:

source

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

axis Optional

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".

Return value

A new ScrollTimeline object instance.

Examples

See the main ScrollTimeline page for an example.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
ScrollTimeline 115 115 No No 101 No 115 115 No No No No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ScrollTimeline/ScrollTimeline