Interface DragDropContextProps

Public

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;
}

Properties

children dragHandleUsageInstructions? enableDefaultSensors? nonce? sensors?

Methods

onBeforeCapture? onBeforeDragStart? onDragEnd onDragStart? onDragUpdate?

Properties

children

children: ReactNode

OptionaldragHandleUsageInstructions

dragHandleUsageInstructions?: string

OptionalenableDefaultSensors

enableDefaultSensors?: boolean

Optionalnonce

nonce?: string

Optionalsensors

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

OptionalonBeforeCapture

  • onBeforeCapture(before): void

  • Parameters

    Returns void

OptionalonBeforeDragStart

  • onBeforeDragStart(initial): void

  • Parameters

    Returns void

onDragEnd

  • onDragEnd(result, provided): void

  • Parameters

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

          • Parameters

            • message: string

            Returns void

    Returns void

OptionalonDragStart

  • onDragStart(initial, provided): void

  • Parameters

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

          • Parameters

            • message: string

            Returns void

    Returns void

OptionalonDragUpdate

  • onDragUpdate(initial, provided): void

  • Parameters

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

          • Parameters

            • message: string

            Returns void

    Returns void

On This Page

Properties
Methods