React Hookers - v6.3.0
    Preparing search index...

    Interface DragProps

    Props for 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 Summary)

    Index

    Properties

    isDisabled? onDrag? onDragChange? onDragEnd? onDragStart?

    Properties

    isDisabled?: boolean

    If true, drag listeners are disabled.

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

    A handler that is called while the user is actively dragging the element.

    Type Declaration

      • (info: DragInfo): void

      • Parameters

        • info: DragInfo

          Info about the current drag frame.

        Returns void

    onDragChange?: (isDragged: boolean) => void

    A handler that is called when the drag state changes.

    Type Declaration

      • (isDragged: boolean): void

      • Parameters

        • isDragged: boolean

          true if the element is being dragged.

        Returns void

    onDragEnd?: (info: DragInfo) => void

    A handler that is called when the user stops dragging the element.

    Type Declaration

      • (info: DragInfo): void

      • Parameters

        • info: DragInfo

          Info about the current drag frame.

        Returns void

    onDragStart?: (info: DragInfo) => void

    A handler that is called when the user starts dragging the element.

    Type Declaration

      • (info: DragInfo): void

      • Parameters

        • info: DragInfo

          Info about the current drag frame.

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties