Interface ScrollingOptions

An options object for the scroll-self animation.

interface ScrollingOptions {
    preserveX?: boolean;
    preserveY?: boolean;
    scrollableOffset?: [
        x: number
        | MultiUnitPlacementX,
        y: number | MultiUnitPlacementY,
    ];
    targetOffset?: [
        x: number
        | MultiUnitPlacementX,
        y: number | MultiUnitPlacementY,
    ];
}

Index

Properties

preserveX? preserveY? scrollableOffset? targetOffset?

Properties

`Optional`preserveX

preserveX?: boolean

If true, the scrolling container will not scroll horizontally.

`Optional`preserveY

preserveY?: boolean

If true, the scrolling container will not scroll vertically.

`Optional`scrollableOffset

scrollableOffset?: [
    x: number
    | MultiUnitPlacementX,
    y: number | MultiUnitPlacementY,
]

Determines the intersection point of the scrolling container with respect to its top-left bound.

`Optional`targetOffset

targetOffset?: [
    x: number
    | MultiUnitPlacementX,
    y: number | MultiUnitPlacementY,
]

Determines the intersection point of the scroll target with respect to its top-left corner.