Interface ISwipeMutableProps

interface ISwipeMutableProps {
    __mutableProp?: true;
    axis?: null | "x" | "y";
    bounceDuration?: number;
    bounds?: null | (coords: ISwipeCoords) => null | ISwipeAxes;
    canBounce?: () => boolean;
    directionThreshold?: number;
    edgeSwipeThreshold?: number;
    enabled?: boolean;
    grabCursor?: boolean;
    inertia?: boolean;
    inertiaBounceEase?: number;
    inertiaDecay?: number;
    inertiaDistanceModifier?:
        | null
        | (distance: ISwipeVec3) => null | ISwipeVec3;
    inertiaDistanceThreshold?: number;
    inertiaDuration?: (distance: number) => number;
    inertiaEasing?: TEasingType;
    inertiaRatio?: number;
    inertiaThreshold?: number;
    maxVelocity?: ISwipeVec3;
    minTime?: number;
    overflow?: () => number;
    preventEdgeSwipe?: boolean;
    preventTouchMove?: boolean;
    ratio?: number;
    recalculateBoundsOnInertia?: boolean;
    relative?: boolean;
    requireCtrlKey?: boolean;
    snap?: null | () => null | ISwipeAxes;
    snapRadius?: null | number;
    threshold?: number;
    velocityModifier?: false | (velocity: ISwipeState) => ISwipeState;
    willAbort?: (props: ISwipeCanMoveArg) => boolean;
}

Hierarchy (View Summary)

Properties

__mutableProp? axis? bounceDuration? bounds? canBounce? directionThreshold? edgeSwipeThreshold? enabled? grabCursor? inertia? inertiaBounceEase? inertiaDecay? inertiaDistanceModifier? inertiaDistanceThreshold? inertiaDuration? inertiaEasing? inertiaRatio? inertiaThreshold? maxVelocity? minTime? overflow? preventEdgeSwipe? preventTouchMove? ratio? recalculateBoundsOnInertia? relative? requireCtrlKey? snap? snapRadius? threshold? velocityModifier? willAbort?

Properties

Optional__mutableProp

__mutableProp?: true

Optionalaxis

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

Primary swiping axis.

Default

null

OptionalbounceDuration

bounceDuration?: number

Duration of the bounce-back timeline when movement exceeds bounds and inertia does not run.

Default

250

Optionalbounds

bounds?: null | (coords: ISwipeCoords) => null | ISwipeAxes

Movement limits per axis. Unset axis is unbounded.

Default

null

OptionalcanBounce

canBounce?: () => boolean

Determines whether the swipe is allowed to bounce back.

Default

() => true

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 release inertia (RAF-based decay).

Default

false

OptionalinertiaBounceEase

inertiaBounceEase?: number

Easing factor for pulling inertia back inside bounds (per frame, FPS-independent).

Default

0.3

OptionalinertiaDecay

inertiaDecay?: number

Inertia velocity decay per frame (higher = stops sooner).

Default

0.05

OptionalinertiaDistanceModifier

inertiaDistanceModifier?: null | (distance: ISwipeVec3) => null | ISwipeVec3

Inertia distance modifier. Called when inertia distance is predicted but not yet started.

Default

null

OptionalinertiaDistanceThreshold

inertiaDistanceThreshold?: number

Deprecated

Timelined inertia is not supported anymore.

OptionalinertiaDuration

inertiaDuration?: (distance: number) => number

Deprecated

Timelined inertia is not supported anymore.

OptionalinertiaEasing

inertiaEasing?: TEasingType

Deprecated

Timelined inertia is not supported anymore.

OptionalinertiaRatio

inertiaRatio?: number

Multiplier applied to release velocity.

Default

1

OptionalinertiaThreshold

inertiaThreshold?: number

Minimum release speed to start inertia (px/s for x/y, deg/s for angle).

Default

1

OptionalmaxVelocity

maxVelocity?: ISwipeVec3

Max release velocity per axis (coord/ms for x/y, deg/ms for angle). Falsy axis value disables inertia on that axis.

Default

{ x: 7, y: 7, angle: 3 }

OptionalminTime

minTime?: number

Minimum duration (ms) to trigger swipe move.

Default

0

Optionaloverflow

overflow?: () => number

Rubber-band distance past bounds (px for x/y, degrees for angle).

Default

() => 50

OptionalpreventEdgeSwipe

preventEdgeSwipe?: boolean

Prevents edge swiping (iOS swipe-back gesture).

Default

true

OptionalpreventTouchMove

preventTouchMove?: boolean

Prevents touchmove event.

Default

true

Optionalratio

ratio?: number

Swipe movement scale.

Default

1

OptionalrecalculateBoundsOnInertia

recalculateBoundsOnInertia?: boolean

Enable bounds recalculation when inertia is active

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

Optionalsnap

snap?: null | () => null | ISwipeAxes

Snap targets per axis in movement space.

Default

null

OptionalsnapRadius

snapRadius?: null | number

Max distance to a snap target (same units as the axis). Falsy = no radius limit.

Default

null

Optionalthreshold

threshold?: number

Minimum swipe distance (px) to trigger swipe start.

Default

5

OptionalvelocityModifier

velocityModifier?: false | (velocity: ISwipeState) => ISwipeState

Deprecated

Timelined inertia is not supported anymore.

OptionalwillAbort

willAbort?: (props: ISwipeCanMoveArg) => boolean

Returns true to abort before the swipe starts (after threshold / axis checks).

Default

() => false

Settings

Member Visibility

On This Page

Properties