Interface ISwipeMutableProps

interface ISwipeMutableProps {
    __mutableProp?: null;
    axis?: null | "x" | "y";
    directionThreshold?: number;
    edgeSwipeThreshold?: number;
    enabled?: boolean;
    grabCursor?: boolean;
    inertia?: boolean;
    inertiaDuration?: (distance: number) => number;
    inertiaEasing?: TEasingType;
    inertiaRatio?: number;
    minTime?: number;
    preventEdgeSwipe?: boolean;
    preventTouchMove?: boolean;
    relative?: boolean;
    requireCtrlKey?: boolean;
    threshold?: number;
    willAbort?: (props: ISwipeCanMoveArg) => boolean;
}

Hierarchy (View Summary)

Properties

__mutableProp? axis? directionThreshold? edgeSwipeThreshold? enabled? grabCursor? inertia? inertiaDuration? inertiaEasing? inertiaRatio? minTime? preventEdgeSwipe? preventTouchMove? relative? requireCtrlKey? threshold? willAbort?

Properties

Optional__mutableProp

__mutableProp?: null

Optionalaxis

axis?: null | "x" | "y"

Primary swiping axis.

Default

null

OptionaldirectionThreshold

directionThreshold?: number

Minimum swipe distance (px) for directional callbacks.

Default

50

OptionaledgeSwipeThreshold

edgeSwipeThreshold?: number

Edge swipe threshold (px) from the left/right edge.

Default

20

Optionalenabled

enabled?: boolean

Enables or disables swipe events.

Default

true

OptionalgrabCursor

grabCursor?: boolean

Shows "grab" and "grabbing" cursors during interaction.

Default

false

Optionalinertia

inertia?: boolean

Enables inertia animation.

Default

false

OptionalinertiaDuration

inertiaDuration?: (distance: number) => number

Inertia duration.

Default

(distance) => clamp(distance, 350, 1000)

OptionalinertiaEasing

inertiaEasing?: TEasingType

Easing function for inertia.

Default

EaseOutCubic

OptionalinertiaRatio

inertiaRatio?: number

Inertia strength.

Default

0.5

OptionalminTime

minTime?: number

Minimum duration (ms) to trigger swipe move.

Default

0

OptionalpreventEdgeSwipe

preventEdgeSwipe?: boolean

Prevents edge swiping (iOS swipe-back gesture).

Default

true

OptionalpreventTouchMove

preventTouchMove?: boolean

Prevents touchmove event.

Default

true

Optionalrelative

relative?: boolean

Calculates coordinates relative to the container.

Default

false

OptionalrequireCtrlKey

requireCtrlKey?: boolean

Requires Ctrl key for swipe (mouse only).

Default

false

Optionalthreshold

threshold?: number

Minimum swipe distance (px) to trigger swipe start.

Default

5

OptionalwillAbort

willAbort?: (props: ISwipeCanMoveArg) => boolean

Determines if swipe should be aborted.

Default

() => false

Settings

Member Visibility

On This Page

Properties