Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The ViewTimeline()
constructor creates a new ViewTimeline
object instance.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The ViewTimeline()
constructor creates a new ViewTimeline
object instance.
js
new ViewTimeline(options)
options
An object that can contain the following properties:
subject
A reference to an Element
representing the subject element whose visibility within its nearest ancestor scrollable element (scroller) 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"
.
inset
Optional
A value or array of values representing an adjustment to the position of the scrollport (see Scroll container for more details) in which the subject is deemed to be visible. Possible values are:
"auto"
: The default box position is used.auto
or a CSS <length-percentage>
value. To put it another way, the string should be a valid view-timeline-inset
value."auto"
or a suitable CSSNumericValue
to represent a length or percentage offset (for example CSS.px()
or CSS.percent()
. If an array is provided, the first value represents the start inset (which affects the ViewTimeline.endOffset
value) and the second value represents the end inset (which affects the ViewTimeline.startOffset
value).If the array has only one value, it is duplicated.
If omitted, inset
defaults to auto
.
A new ViewTimeline
object instance.
See the main ViewTimeline
page for an example.
Specification |
---|
Scroll-driven Animations # dom-viewtimeline-viewtimeline |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
ViewTimeline |
115 | 115 | No | No | 101 | No | 115 | 115 | No | No | No | No |
© 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/ViewTimeline/ViewTimeline