Class ScrollSnapAutoplay

Classdesc

Plugin that automatically changes slides.

Hierarchy (view full)

Constructors

constructor

Properties

intervalDuration timeoutDuration debounceId interval events slider

Accessors

id

Methods

enable disable disableTemporarily onInterval

Constructors

constructor

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

Private debounceId

debounceId: number

Used to debounce the re-enabling after a user interaction

Private interval

interval: number

Interval ID

Private Readonly events

events: string[]

Event names that temporarily disable the autoplay behaviour

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

Methods

enable

disable

disableTemporarily

  • disableTemporarily(): void

  • Disable the autoplay behaviour and set a timeout to re-enable it.

    Returns void

onInterval

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc