react-dnd

What is react-dnd?

The react-dnd package is a set of React utilities to help you build complex drag and drop interfaces while keeping your components decoupled. It provides a way to use drag and drop features in React by turning any React component into a draggable or a droppable area.

What are react-dnd's main functionalities?

Draggable Components

This feature allows you to turn any component into a draggable item. The useDrag hook is used to make components draggable and to monitor their state.

{"import { useDrag } from 'react-dnd';\n\nfunction DraggableComponent() {\n  const [{isDragging}, dragRef] = useDrag({\n    type: 'BOX',\n    collect: monitor => ({\n      isDragging: !!monitor.isDragging(),\n    }),\n  });\n\n  return (\n    <div ref={dragRef} style={{ opacity: isDragging ? 0.5 : 1 }}>\n      Drag Me\n    </div>\n  );\n}"}

Droppable Areas

This feature allows you to define areas where draggable items can be dropped. The useDrop hook is used to handle the drop events and to determine the state of the drop targets.

{"import { useDrop } from 'react-dnd';\n\nfunction DroppableComponent() {\n  const [{canDrop, isOver}, dropRef] = useDrop({\n    accept: 'BOX',\n    drop: () => ({ name: 'DroppableComponent' }),\n    collect: monitor => ({\n      isOver: monitor.isOver(),\n      canDrop: monitor.canDrop(),\n    }),\n  });\n\n  return (\n    <div ref={dropRef} style={{ backgroundColor: isOver ? 'green' : 'white' }}>\n      {canDrop ? 'Release to drop' : 'Drag a box here'}\n    </div>\n  );\n}"}

Custom Drag Layer

This feature allows you to create a custom drag layer that can be used to display a custom preview of the draggable item. The useDragLayer hook provides information about the item being dragged and its position.

{"import { useDragLayer } from 'react-dnd';\n\nfunction CustomDragLayer() {\n  const { isDragging, item, currentOffset } = useDragLayer((monitor) => ({\n    item: monitor.getItem(),\n    currentOffset: monitor.getSourceClientOffset(),\n    isDragging: monitor.isDragging(),\n  }));\n\n  if (!isDragging) {\n    return null;\n  }\n\n  return (\n    <div style={{ position: 'fixed', pointerEvents: 'none', left: currentOffset.x, top: currentOffset.y }}>\n      {/* Render custom drag layer here */}\n    </div>\n  );\n}"}

Other packages similar to react-dnd

react-beautiful-dnd

react-beautiful-dnd is a higher-level abstraction built on top of the lower-level primitives provided by react-dnd. It offers a more opinionated but simpler API and focuses on vertical and horizontal lists. It provides beautiful and accessible drag and drop for lists with React.

react-sortable-hoc

react-sortable-hoc is a set of higher-order components to turn any list into an animated, touch-friendly, sortable list. It's more focused on list sorting capabilities and less on general drag and drop scenarios compared to react-dnd.

dnd-kit

dnd-kit is a modern drag and drop toolkit for React that is designed to be more performant and flexible than react-dnd. It provides hooks and utilities to build complex drag and drop interfaces and supports multiple backends, including touch and keyboard.

README

react-dnd

Drag and drop for React with full DOM control.
Currently works on top of HTML5 drag-and-drop API, but moves towards a swappable implementation.

Philosophy

• Keep user in full control over rendering;
• Don't make assumptions about consuming components and their structure;
• Hide underlying implementation and its quirks;
• Make 80% easy, 20% possible.

Live Demo

See it in action!

Demo contains a variety of things you can implement with this library, including:

• Reacting to hover and dropping;
• Dropping files;
• Dragging a box around with snapping;
• Drawing a custom drag layer;
• Making cards sortable.

You can do much more, but these examples will help you get started!

Features

• Emits zero DOM or CSS of its own;
• Like original HTML5 API, emphasizes dragging data and not just “draggable views”;
• Support dropping files using the same API;
• Lets components register as “drag sources” or “drop targets” for different kinds of data;
• Lets a single component contain several drag sources and drop targets;
• Lets you provide a custom drag handle, whether DOM subnode or an image;
• Takes the best from HTML5 API but hides its many quirks:
  • doesn't require you to preventDefault anything to start working;
  • emits enter and leave as you'd expect instead of doing it for every child node;
  • lets you read drag state from render();
  • consistently fires events even if source DOM node was removed;
• Includes a helper to preload images for drag thumbnails;
• Lets you render a custom drag layer if you'd rather draw your own drag preview.

Documentation

API Reference

Complete API reference is available here.

Walkthrough

If you don't feel comfortable diving into examples source code just yet, you can start with the walkthrough.

Examples

Have you played with live demo yet? Here's the source code for it.

To try it locally, clone the project and run:

npm install
npm start
open http://localhost:8080/

Examples use ES6 syntax.

Installation

The library can be used separately (dist/ReactDND.min.js) or with a bundler such as Webpack or Browserify.

npm install --save react-dnd

Future Roadmap

• Touch support;
• Support for mouse events instead of HTML5 drag-and-drop events;
• Dragging multiple items at once.

See Also

• react-draggable by Matt Zabriskie
• react-sortable by Daniel Stocks
• react-dropzone by Param Aggarwal

Thanks

This library is a React port of an API, parts of which were originally written by Andrew Kuznetsov.

A lot of recent progress is due to Nathan Hutchison's contributions and effort.

Changelog

0.8.0 (2015-02-17)

• 0.8.0 (b0ee125)
• Add DragLayerMixin and refactor to prepare for alt backends (2b026a8)
• Add DragLayerMixin#getDragLayerState (830dd40)
• Bump bower version (1f691f9)
• Extract docs (86b9ba7)
• Rebuild dist (f5a3b14)
• Rebuild examples (4625938)
• registerType => register (3435419)
• Tweak style in examples and fix warnings (a62bfe9)
• Update API.md (f09691c)
• Update API.md (95a501f)
• Update API.md (09ea1d4)
• Update API.md (4960ada)
• Update package descriptions (df82b85)
• Update README.md (ef1804a)
• Use context in naive example (ae30f3b)