drag-drop-context.md

<DragDropContext />

In order to use drag and drop, you need to have the part of your React tree that you want to be able to use drag and drop in wrapped in a <DragDropContext />. It is advised to just wrap your entire application in a <DragDropContext />. Having nested <DragDropContext />'s is not supported. You will be able to achieve your desired conditional dragging and dropping using the props of <Droppable /> and <Draggable />. You can think of <DragDropContext /> as having a similar purpose to the react-redux Provider component. A content-security-protection nonce attribute is added to the injected style tags if provided.

Props

interface Responders {
  // optional
  onBeforeCapture?: OnBeforeCaptureResponder;
  onBeforeDragStart?: OnBeforeDragStartResponder;
  onDragStart?: OnDragStartResponder;
  onDragUpdate?: OnDragUpdateResponder;

  // required
  onDragEnd: OnDragEndResponder;
}

import type { ReactNode } from 'react';
import { PartialAutoScrollConfig } from '../../state/auto-scroller/fluid-scroller/config/autoscroll-config-types';

interface Props extends Responders {
  // We do not technically need any children for this component
  children: ReactNode | null;
  // Read out by screen readers when focusing on a drag handle
  dragHandleUsageInstructions?: string;
  // Used for strict content security policies
  nonce?: string;
  // Used for custom sensors
  sensors?: Sensor[];
  enableDefaultSensors?: boolean | null;
  // autoScrollConfig options
  autoScrollerOptions?: PartialAutoScrollerOptions;
}

• dragHandleUsageInstructions: What is read out to screen reader users when a drag handle is given browser focus. See our screen reader guide
• nonce: Used for strict content security policy setups. See our content security policy guide
• sensors: Used to pass in your own sensors for a <DragDropContext />. See our sensor api documentation
• enableDefaultSensors: Whether or not the default sensors (mouse, keyboard, and touch) are enabled. You can also import them separately as useMouseSensor, useKeyboardSensor, or useTouchSensor and reuse just some of them via sensors prop. See our sensor api documentation
• autoScrollerOptions: An object whose several (optional) properties allow the user to configure the auto-scroll behavior. A simple example is { disabled: true }, which turns off auto scrolling entirely for that <DragDropContext />. See our Auto scrolling documentation

See our type guide for more details

Basic usage

Using a class component

import React from 'react';
import { DragDropContext } from '@hello-pangea/dnd';

class App extends React.Component {
  onBeforeCapture = () => {
    /*...*/
  };

  onBeforeDragStart = () => {
    /*...*/
  };

  onDragStart = () => {
    /*...*/
  };
  onDragUpdate = () => {
    /*...*/
  };
  onDragEnd = () => {
    // the only one that is required
  };

  render() {
    return (
      <DragDropContext
        onBeforeCapture={this.onBeforeCapture}
        onBeforeDragStart={this.onBeforeDragStart}
        onDragStart={this.onDragStart}
        onDragUpdate={this.onDragUpdate}
        onDragEnd={this.onDragEnd}
      >
        <div>Hello world</div>
      </DragDropContext>
    );
  }
}

Using a function component

import React from 'react';
import { DragDropContext } from '@hello-pangea/dnd';

function App() {
  // using useCallback is optional
  const onBeforeCapture = useCallback(() => {
    /*...*/
  }, []);
  const onBeforeDragStart = useCallback(() => {
    /*...*/
  }, []);
  const onDragStart = useCallback(() => {
    /*...*/
  }, []);
  const onDragUpdate = useCallback(() => {
    /*...*/
  }, []);
  const onDragEnd = useCallback(() => {
    // the only one that is required
  }, []);

  return (
    <DragDropContext
      onBeforeCapture={onBeforeCapture}
      onBeforeDragStart={onBeforeDragStart}
      onDragStart={onDragStart}
      onDragUpdate={onDragUpdate}
      onDragEnd={onDragEnd}
    >
      <div>Hello world</div>
    </DragDropContext>
  );
}

Responders

Responders were previously known as Hooks

Responders are top level application events that you can use to perform your own state updates, style updates, as well as to make screen reader announcements.

Please see our Responders guide for detailed information about responders ❤️

← Back to documentation