Defines the options for the draggableGsap action.

type DraggableGsapOptions = {
    button?: number;
    enabled?: boolean;
    hasTargetClassList?: Iterable<string>;
    ignoreTargetClassList?: Iterable<string>;
    inertia: boolean;
    inertiaOptions: GsapInertiaOptions;
    position: TJSPosition | Positionable;
    storeDragging?: Writable<boolean>;
    tween?: boolean;
    tweenOptions?: GsapTweenOptions;
}
Index

Properties

button?: number

MouseEvent button that activates dragging; default: 0

enabled?: boolean

A boolean value; controlling the enabled state.

hasTargetClassList?: Iterable<string>

When defined any event targets that have a class in this list are allowed.

ignoreTargetClassList?: Iterable<string>

When defined any event targets that have a class in this list are ignored.

inertia: boolean

When true inertia plugin options are enabled.

inertiaOptions: GsapInertiaOptions

Inertia plugin options.

A position or positionable instance.

storeDragging?: Writable<boolean>

A writable store that tracks "dragging" state.

tween?: boolean

When true tweening is enabled; default: false

tweenOptions?: GsapTweenOptions

Quick tween options.