Interface ScrollToElementOptions

Options of the scrollToElement function.

interface ScrollToElementOptions {
    animation?: Partial<Animation>;
    paddingBottom?: number;
    paddingTop?: number;
    signal?: AbortSignal;
}

Index

Properties

animation? paddingBottom? paddingTop? signal?

Properties

`Optional`animation

animation?: Partial<Animation>

The animation that the scroll should use. By default, no animation is applied and an element is centered instantly.

`Optional`paddingBottom

paddingBottom?: number

Bottom scroll padding.

Default

`Optional`paddingTop

paddingTop?: number

Top scroll padding.

Default

`Optional`signal

signal?: AbortSignal

The signal that cancels the animation.