Interface DragProps

Props of the useDrag hook.

interface DragProps {
    isDisabled?: boolean;
    onDrag?: ((info: DragInfo) => void);
    onDragChange?: ((isDragged: boolean) => void);
    onDragEnd?: ((info: DragInfo) => void);
    onDragStart?: ((info: DragInfo) => void);
}

Hierarchy (view full)

Properties

isDisabled? onDrag? onDragChange? onDragEnd? onDragStart?

Properties

OptionalisDisabled

isDisabled?: boolean

If true drag listeners are disabled.

Default

false

OptionalonDrag

onDrag?: ((info: DragInfo) => void)

A handler that is called when a user is actively dragging an element.

Type declaration

    • (info): void

    • Parameters

      • info: DragInfo

        An info about the current drag frame.

      Returns void

OptionalonDragChange

onDragChange?: ((isDragged: boolean) => void)

A handler that is called when the drag state changes.

Type declaration

    • (isDragged): void

    • Parameters

      • isDragged: boolean

        true if an element is dragged.

      Returns void

OptionalonDragEnd

onDragEnd?: ((info: DragInfo) => void)

A handler that is called when a user stops dragging an element.

Type declaration

    • (info): void

    • Parameters

      • info: DragInfo

        An info about the current drag frame.

      Returns void

OptionalonDragStart

onDragStart?: ((info: DragInfo) => void)

A handler that is called when a user starts to drag an element.

Type declaration

    • (info): void

    • Parameters

      • info: DragInfo

        An info about the current drag frame.

      Returns void

Settings

Member Visibility

On This Page

Properties