Git Product home page Git Product logo

react-dnd's Introduction

react-dnd

Join the chat at https://gitter.im/gaearon/react-dnd

Drag and drop for React with full DOM control.

Currently works on top of HTML5 drag-and-drop API, but is moving towards a swappable implementation. Support for touch events is on the roadmap but not currently implemented.

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

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.

Production Usage

See Also

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.

react-dnd's People

Contributors

gaearon avatar jgable avatar hakanderyal avatar alexkuz avatar moretti avatar gitter-badger avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.