Class ScrollSnapAutoplay

Plugin that automatically changes slides.

Hierarchy (View Summary)

ScrollSnapPlugin
- ScrollSnapAutoplay

Index

Constructors

Properties

intervalDuration timeoutDuration slider

Accessors

Methods

enable disable disableTemporarily onInterval

Constructors

constructor

new ScrollSnapAutoplay(
    intervalDuration?: number,
    timeoutDuration?: number,
    events?: string[],
): ScrollSnapAutoplay
Parameters
- intervalDuration: number = 3141
- timeoutDuration: number = 6282
- events: string[] = ...
Returns ScrollSnapAutoplay
Overrides ScrollSnapPlugin.constructor
- Defined in src/lib/ScrollSnapAutoplay.ts:32

Properties

intervalDuration

intervalDuration: number

Duration in milliseconds between slide changes

timeoutDuration

timeoutDuration: number

Duration in milliseconds after human interaction where the slider will not autoplay

slider

slider: ScrollSnapSlider

Reference to the slider this plugin is attached to.

Accessors

id

get id(): string
Unique Plugin ID, used as index in ScrollSnapSlider::plugins.

Returns string
See
Overrides ScrollSnapPlugin.id
- Defined in src/lib/ScrollSnapAutoplay.ts:44

Methods

enable

enable(): void
Add listeners, compute things and enable the desired behaviour. Override this with custom behaviour.

Returns void
Overrides ScrollSnapPlugin.enable
- Defined in src/lib/ScrollSnapAutoplay.ts:52

disable

disable(): void
Remove listeners, clean up dependencies and free up memory. Override this with custom behaviour.

Returns void
Overrides ScrollSnapPlugin.disable
- Defined in src/lib/ScrollSnapAutoplay.ts:66

disableTemporarily

disableTemporarily(): void
Disable the autoplay behaviour and set a timeout to re-enable it.

Returns void
- Defined in src/lib/ScrollSnapAutoplay.ts:80

onInterval

onInterval(): void
Callback for regular intervals to continue to the next slide

Returns void
- Defined in src/lib/ScrollSnapAutoplay.ts:95