Interface SwipeDeckMotion

interface SwipeDeckMotion {
    direction: SwipeDeckMotionDirection;
    index: number;
    isSettled: boolean;
    offset: number;
    offsetRatio: number;
    position: number;
    scrollOffset: number;
    viewportSize: number;
}

Properties

Direction of the latest observed movement.

index: number

Item nearest the viewport center.

isSettled: boolean

Whether the nearest item is aligned with the viewport.

offset: number

Nearest item's offset from its settled position, in pixels.

offsetRatio: number

Nearest item's offset normalized by viewport size.

position: number

Continuous item position. For example, 1.5 is halfway from item 1 to item 2.

scrollOffset: number

Clamped scroll offset along the deck's active axis, in pixels.

viewportSize: number

Current viewport size along the deck's active axis, in pixels.