Move

You're browsing the documentation for v3

Overview

The Move component moves the slider by applying styles to the list element.

Methods

move()

move( dest: number, index: number, prev: number ): void

Moves the slider to the dest index with the Transition component. This method does not update the current index. Use Controller#go instead.

Params

dest
index
prev

jump()

jump( index: number ): void

Jumps to the slide at the specified index.

Params

index

translate()

translate( position: number ): void

Moves the slider to the provided position.

Params

position

cancel()

cancel(): void

Cancels transition.


toIndex()

toIndex( position: number ): number

Converts the provided position to the closest slide index.

Params

position

toPosition()

toPosition( index: number, trimming?: boolean ): number

Converts the provided index to the position in pixel.

Params

index
trimming

getPosition()

getPosition(): number

Returns the current position.


getLimit()

getLimit( max: boolean ): number

Returns the limit position that the slider can move to.

Params

max

isBusy()

isBusy(): boolean

Checks if the slider can move now or not.


exceededLimit()

exceededLimit( max?: boolean | undefined, position?: number ): boolean

Checks if the provided position exceeds the minimum or maximum limit or not.

Params

max
position