Preparing search index...

    Interface DragDropContextProps

    interface DragDropContextProps {
        children: ReactNode;
        dragHandleUsageInstructions?: string;
        enableDefaultSensors?: boolean;
        nonce?: string;
        sensors?: (
            (
                api: {
                    canGetLock: (id: string) => boolean;
                    findClosestDraggableId: (event: Event) => null | string;
                    findOptionsForDraggable: (
                        id: string,
                    ) =>
                        | null
                        | {
                            canDragInteractiveElements: boolean;
                            isEnabled: boolean;
                            shouldRespectForcePress: boolean;
                        };
                    isLockClaimed: () => boolean;
                    tryGetLock: (
                        draggableId: string,
                        forceStop?: () => void,
                        options?: { sourceEvent?: Event },
                    ) => null | PreDragActions;
                    tryReleaseLock: () => void;
                },
            ) => void
        )[];
        onBeforeCapture(before: BeforeCapture): void;
        onBeforeDragStart(initial: DragStart): void;
        onDragEnd(
            result: DropResult,
            provided: { announce: (message: string) => void },
        ): void;
        onDragStart(
            initial: DragStart,
            provided: { announce: (message: string) => void },
        ): void;
        onDragUpdate(
            initial: DragUpdate,
            provided: { announce: (message: string) => void },
        ): void;
    }
    Index

    Properties

    children dragHandleUsageInstructions? enableDefaultSensors? nonce? sensors?

    Methods

    onBeforeCapture? onBeforeDragStart? onDragEnd onDragStart? onDragUpdate?

    Properties

    children: ReactNode
    dragHandleUsageInstructions?: string
    enableDefaultSensors?: boolean
    nonce?: string
    sensors?: (
        (
            api: {
                canGetLock: (id: string) => boolean;
                findClosestDraggableId: (event: Event) => null | string;
                findOptionsForDraggable: (
                    id: string,
                ) =>
                    | null
                    | {
                        canDragInteractiveElements: boolean;
                        isEnabled: boolean;
                        shouldRespectForcePress: boolean;
                    };
                isLockClaimed: () => boolean;
                tryGetLock: (
                    draggableId: string,
                    forceStop?: () => void,
                    options?: { sourceEvent?: Event },
                ) => null | PreDragActions;
                tryReleaseLock: () => void;
            },
        ) => void
    )[]

    Methods

    • Parameters

      Returns void

    • Parameters

      • result: DropResult
      • provided: { announce: (message: string) => void }

      Returns void

    • Parameters

      • initial: DragStart
      • provided: { announce: (message: string) => void }

      Returns void

    • Parameters

      • initial: DragUpdate
      • provided: { announce: (message: string) => void }

      Returns void

    On This Page

    Properties
    Methods