New to React DnD? Read the overview before jumping into the docs.
Wrap the root component of your application with DragDropContext
to set up React DnD.
This lets you specify the backend, and sets up the shared DnD state behind the scenes.
var HTML5Backend = require('react-dnd/modules/backends/HTML5');
var DragDropContext = require('react-dnd').DragDropContext;
var YourApp = React.createClass(
/* ... */
);
module.exports = DragDropContext(HTML5Backend)(YourApp);
backend
: Required. A React DnD backend. Unless you're writing a custom one, you probably want to use the HTML5 backend that ships with React DnD.DragDropContext
wraps your component and returns another React component.
For easier testing, it provides an API to reach into the internals:
DecoratedComponent
: Returns the wrapped component type.getDecoratedComponentInstance()
: Returns the wrapped component instance.
getManager()
: Returns the internal manager that provides access to the underlying backend. This part is currently not documented, but you can refer to the testing tutorial for a usage example.