Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisjpatty/react-dragtastic
A simple drag and drop library for React which uses the more stable mouseDown/mouseUp event pattern instead of the problematic HTML5 drag and drop API
https://github.com/chrisjpatty/react-dragtastic
dnd drag-and-drop draggable droppable react
Last synced: 9 days ago
JSON representation
A simple drag and drop library for React which uses the more stable mouseDown/mouseUp event pattern instead of the problematic HTML5 drag and drop API
- Host: GitHub
- URL: https://github.com/chrisjpatty/react-dragtastic
- Owner: chrisjpatty
- License: mit
- Created: 2017-06-19T19:18:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T09:50:09.000Z (almost 2 years ago)
- Last Synced: 2024-06-11T17:37:23.473Z (5 months ago)
- Topics: dnd, drag-and-drop, draggable, droppable, react
- Language: JavaScript
- Homepage: https://react-dragtastic.netlify.app/
- Size: 3.59 MB
- Stars: 189
- Watchers: 4
- Forks: 9
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-react-render-props - react-dragtastic - and-drop for React (Components / Interaction)
- awesome-react-render-props - react-dragtastic - and-drop for React (Components / Interaction)
README
# react-dragtastic
[](https://badge.fury.io/js/react-dragtastic)
[](https://badge.fury.io/js/react-dragtastic)
[](https://github.com/prettier/prettier)
A simple drag and drop library for React which uses the more stable mouseDown/mouseUp pattern instead of the problematic HTML5 drag and drop API.
Drag and drop interfaces are complicated and difficult to properly program, this package attempts to alleviate some of the common hangups with drag and drop libraries. It should be noted that there are more mature solutions available such as the excellent [react-dnd](https://github.com/react-dnd/react-dnd) package, however for many simple drag and drop applications, the implementation of such packages can quickly become arduous.
* _Warning, version 2 represents a significant rewrite of version 1 of_ `react-dragtastic`. _The API is completely different, but with the changes come several stability improvements, primitive mobile support, and significantly increased render flexibility. Be sure you're ready to rewrite your drag-and-drop implementation before upgrading from version 1._
## Example
[Demo Site](https://react-dragtastic.netlify.com/)
_More examples coming soon_
[Code Sandbox Example](https://codesandbox.io/s/5z32yqk7l4)
## Installation
```shell
npm install --save react-dragtastic
or
yarn add react-dragtastic
```
## Usage
###### For ES6 and up
```javascript
import {
Draggable,
Droppable,
DragComponent,
DragState
} from "react-dragtastic"
```
###### For ES5
```javascript
var dnd = require("react-dragtastic")
var Draggable = dnd.Draggable
var Droppable = dnd.Droppable
var DragComponent = dnd.DragComponent
```
## Overview
`react-dragtastic` makes use of three different components, a `` component which defines a zone on a page which can then trigger drag events, a `` component, which defines zones which trigger drop events, and a `` component which defines the component that follows the user's pointer around the page while dragging.
`react-dragtastic` uses the "function-as-child" component pattern to give you full control over the rendering details of each component.
### Draggable
This defines a draggable zone. At a minimum, spread the events over the element that should be draggable (usually the root element).
* `id`: An id which will be used in the draggable zone's target ``
* `type`: A string, or array of strings, used to limit which droppable zones will accept ``'s attached to this draggable.
* `data`: Data of any type which will be passed to the `onDrop` function of any `` which accepts this ``'s type.
* `onDragStart`: A function which will be called when the `` zone is activated (The user started dragging).
* `onDragEnd`: A function which will be called when the `` zone is deactivated (The user stopped dragging).
* `onDrag`: A function which will be called every time the user's cursor moves while dragging.
* `delay`: An optional int representing the distance in pixels the user's pointer must travel to activate the draggable. Defaults to `8`
* `subscribeTo`: An optional array of strings. For performance reasons you can limit which keys in the dragState your component subscribes to. For example, you may pass ['type', 'data'] to only rerender if these keys change.
Properties available from `dragState`:
* All the properties listed in the dragState section.
* `isActive`: A boolean representing if the draggable is currently active.
```jsx
class DraggableZone extends React.Component {
render() {
return (
{dragState =>
I'm a draggable zone}
)
}
}
```
### Droppable
This defines a droppable zone. At a minimum, spread the events over the element that should be droppable (usually the root element).
* `accepts`: A string type corresponding to the `type` property of the `` zone for which this `` should accept drop events.
* `onDrop`: A function which will be called when a user drops a `` on this `` with an accepted type.
* `onDragEnter`: A function which will be called when the user's cursor enters the `` while dragging. This function will be called regardless of whether the droppable accepts the draggable currently being dragged.
* `onDragLeave`: A function which will be called when the user's cursor leaves the `` while dragging. This function will be called regardless of whether the droppable accepts the draggable currently being dragged.
* `subscribeTo`: An optional array of strings. For performance reasons you can limit which keys in the dragState your component subscribes to. For example, you may pass ['type', 'data'] to only rerender if these keys change.
Properties available from `dragState`:
* All the properties listed in the dragState section.
* `isOver`: A boolean representing if the user is currently hovering the ``.
* `willAccept`: A boolean representing if this droppable will accept the currently dragging ``.
```jsx
class DroppableZone extends React.Component {
render() {
return (
{dragState =>
I'm a droppable zone}
)
}
}
```
### DragComponent
By default, children passed to this component will only render if the user is currently dragging, but this can be overridden.
* `for`: A string corresponding to the `id` property of the `` zone that should trigger this component to start rendering.
* `onDrag`: A function which will be called every time a user drags.
* `alwaysRender`: A boolean determining whether or not the DragComponent should always render. Defaults to `false`.
* `subscribeTo`: An optional array of strings. For performance reasons you can limit which keys in the dragState your component subscribes to. For example, you may pass ['type', 'data'] to only rerender if these keys change.
Properties available from `dragState`:
* All the properties listed in the dragState section.
* `isOverAccepted`: a boolean representing whether the user is currently hovering a `` that accepts the `type` of the currently active ``
```jsx
class DragComponentWrapper extends React.Component {
render() {
return (
{dragState => (
I will render when my Draggable zone is activated
)}
)
}
}
```
### DragState
All components imported from `react-dragtastic` have access the global dragState with the following properties:
* `x`: The user's current horizontal position on the page.
* `y`: The user's current vertical position on the page.
* `startingX`: The user's initial horizontal position on the page when they started dragging.
* `startingy`: The user's initial vertical position on the page when they started dragging.
* `isDragging`: A boolean representing whether the user is currently dragging.
* `currentlyDraggingId`: The id of the currently dragging element.
* `currentlyHoveredDroppableId`: The id of the `` currently being hovered.
* `currentlyHoveredDroppableAccepts`: The `accepts` property of the `` currently being hovered.
* `data`: Data from the `data` property of the `` which is currently active. `null` if not dragging.
* `type`: The type of the component being currently dragged. `null` if not dragging.
* `subscribeTo`: An optional array of strings. For performance reasons you can limit which keys in the dragState your component subscribes to. For example, you may pass ['type', 'data'] to only rerender if these keys change.
Occasionally you may need to notify a component about changes in the dragState without making that component a draggable or droppable zone. For these cases there is a fourth component available called ``. This component is used just like a draggable or droppable, but does not accept or trigger any drag events.
```jsx
class CompWithDragState extends React.Component {
render() {
return (
{dragState => (
I always render, and have access to the global dragState.
)}
)
}
}
```
## Troubleshooting
#### My Droppables aren't working!
* You most likely need to set `pointer-events: none` in the css of your `DragComponent`. This allows droppables to receive drop events when the user's pointer is directly on top of the DragComponent as it is being dragged. This property is [well supported](https://caniuse.com/#feat=pointer-events).
#### My app is slow when I have a lot of Draggables or Droppables
* In this case the easiest fix is to use the `subscribeTo` prop to pass an array of dragState keys you want to subscribe to.
## Coming Soon
* A project website with live examples.
* Screencast showing basic implementation examples.
* Improved mobile support.
* Additional event hooks
## Contributing
Contributions of any kind are welcome. Please feel free to file issues, submit pull-requests, or drop us a line with feature requests.