Class ScrollSnapDraggable

Classdesc

Plugin that enables mouse/pointer drag. Note, that touch interaction is enabled natively in all browsers.

Hierarchy (view full)

Constructors

constructor

Properties

quickSwipeDistance lastX startX slider

Accessors

id

Methods

enable disable onSlideStopAfterDrag getFinalSlide mouseMove startDragging stopDragging

Constructors

constructor

Properties

quickSwipeDistance

quickSwipeDistance: number

If this is null: The next/previous slide will not be reached unless you drag for more than half the slider's width.

If this is a number: Dragging any slide for more than this distance in pixels will slide to the next slide in the desired direction.

Private lastX

lastX: number

Last drag event position

Private startX

startX: number

Where the dragging started

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

Private onSlideStopAfterDrag

Private getFinalSlide

Private mouseMove

  • mouseMove(event): void

  • Scroll the slider the appropriate amount of pixels and update the last event position

    Parameters

    • event: MouseEvent

    Returns void

Private startDragging

  • startDragging(event): void

  • Clear disable timeout, set up variables and styles and attach the listener.

    Parameters

    • event: MouseEvent

    Returns void

Private stopDragging

  • stopDragging(event): void

  • Remove listener and clean up the styles. Note: We first restore the smooth behaviour, then manually snap to the current slide. Using a timeout, we then restore the rest of the snap behaviour.

    Parameters

    • event: MouseEvent

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc