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`	A destination index to go to, including clones'.
`index`	A slide index.
`prev`	A previous index.

`jump()`

jump( index: number ): void

Jumps to the slide at the specified index.

Params

`index`	An index to jump to.

`translate()`

translate( position: number ): void

Moves the slider to the provided position.

Params

`position`	The position to move to.

`cancel()`

cancel(): void

Cancels transition.

`toIndex()`

toIndex( position: number ): number

Converts the provided position to the closest slide index.

Params

`position`	A position to convert.

Return

The closest index to the position.

`toPosition()`

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

Converts the provided index to the position in pixel.

Params

`index`	An index to convert.
`trimming`	Optional. Whether to trim edge spaces or not.

Return

The position corresponding with the index.

`getPosition()`

getPosition(): number

Returns the current position.

Return

The position of the list element.

`getLimit()`

getLimit( max: boolean ): number

Returns the limit position that the slider can move to.

Params

`max`	Determines whether to return the maximum or minimum limit.

Return

The border position.

`isBusy()`

isBusy(): boolean

Checks if the slider can move now or not.

Return

true if the slider can move, or otherwise false.

`exceededLimit()`

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

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

Params

`max`	Optional. `true` for testing max, `false` for min, and `undefined` for both.
`position`	Optional. A position to test. If omitted, tests the current position.

Return

true if the position exceeds the limit, or otherwise false.