Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atellmer/react-cool-draggable
Drag-n-drop react library (component) for horizontal and vertical lists.
https://github.com/atellmer/react-cool-draggable
animation drag drag-and-drop react
Last synced: 20 days ago
JSON representation
Drag-n-drop react library (component) for horizontal and vertical lists.
- Host: GitHub
- URL: https://github.com/atellmer/react-cool-draggable
- Owner: atellmer
- License: mit
- Created: 2022-10-28T11:12:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-18T09:16:54.000Z (over 1 year ago)
- Last Synced: 2024-10-04T18:49:54.415Z (about 1 month ago)
- Topics: animation, drag, drag-and-drop, react
- Language: TypeScript
- Homepage:
- Size: 9.88 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-cool-draggable
Drag-n-drop react library (component) for horizontal and vertical lists.
- π¨βπ Easy to use
- πͺ Small size (6 kb gzipped)
- π 60 FPS performance
- π’ Animated transitions
- π
Π‘ustomizable appearance
- π Touch devices support
- π Any element sizes
- βοΈ No dependencies
One common frontend task is to create draggable cards in various lists. To simplify this task, I wrote a library that can work with horizontal and vertical lists, as well as their combinations (for example, as done in Trello).
## Demo
- [Trello app](https://atellmer.github.io/react-cool-draggable/examples/trello/)
- [Large board](https://atellmer.github.io/react-cool-draggable/examples/large-board/)
## Installation
npm:
```
npm install react-cool-draggable
```
yarn:
```
yarn add react-cool-draggable
```
## Usage
```tsx
import {
DragDropContext,
Droppable,
Draggable,
reorder,
} from 'react-cool-draggable';
const handleDragEnd = options => {
const newItems = reorder({
...options,
items,
getDraggableID: x => x.ID,
getDroppableID: () => 'row',
});
setItems(newItems);
};
{({ snapshot, ...rest }) => (
{items.map(x => (
{({ snapshot, rootProps, draggableProps }) => (
{x.text}
)}
))}
)}
```
You can also combine and nest droppable and draggable elements to create more complex components if you need to.
## API
Some universal types here
```tsx
type ID = string | number;
type Direction = 'vertical' | 'horizontal';
type DraggableElement = HTMLElement | SVGElement;
```
### DragDropContext
This library uses the react context as a way to communicate between children in the tree, so the context must be explicitly invoked at the root of the component.
```tsx
import { DragDropContext } from 'react-cool-draggable';
```
```tsx
Some children here...
```
```tsx
type DragDropContextProps = {
onDragStart?: (options: OnDragStartOptions) => void;
onDragOver?: (options: OnDragOverOptions) => void;
onDragEnd: (options: OnDragEndOptions) => void;
children: React.ReactElement;
};
```
All of these callback accept a number of options that may be useful to you later.
```tsx
type OnDragStartOptions = {
draggableID: ID;
droppableID: ID;
droppableGroupID: ID;
targetNode: DraggableElement;
};
type OnDragOverOptions = {
draggableID: ID;
droppableID: ID;
droppableGroupID: ID;
targetNode: DraggableElement;
nearestNode: DraggableElement | null;
};
type OnDragEndOptions = {
draggableID: ID;
droppableID: ID;
droppableGroupID: ID;
sourceIdx: number;
destinationIdx: number;
isMoving: boolean;
targetNode: DraggableElement;
};
```
### Droppable
Think of this component as a surface on which elements move. It is simple logic where all the logic is hidden. At the same time, it is based on the concept of RenderProps and expects to receive a render function as children.
```tsx
import { Droppable } from 'react-cool-draggable';
```
```tsx
{({ snapshot, ...rest }) =>
Some children here...}
```
```tsx
type DroppableProps = {
direction: Direction;
droppableID: ID;
droppableGroupID: ID;
transitionTimeout?: number;
transitionTimingFn?: string;
disabled?: boolean;
debounceTimeout?: number;
children: (options: DroppableChildrenOptions) => React.ReactElement;
};
```
The direction - the main property that specifies how the component should deal with the drag direction. You will also need to provide some identifiers so that you can distinguish one surface from another.
```tsx
type DroppableChildrenOptions = {
snapshot: {
isDragging: boolean;
};
...some service options
};
```
The snapshot can be useful for you to understand and react to real-time dragging, such as changing the surface color to let the user know that the dragging mode has been activated.
### Draggable
You can think of this component as an element that is draggable by the user. And it is also just a component that implements logic without any external appearance. So he also needs a render function to tell it what it should look like.
```tsx
import { Draggable } from 'react-cool-draggable';
```
```tsx
{({ snapshot, rootProps, draggableProps }) =>
Some children here...}
```
```tsx
type DraggableProps = {
draggableID: ID;
children: (options: DraggableChildrenOptions) => React.ReactElement;
};
```
```tsx
type DraggableChildrenOptions = {
snapshot: {
isDragging: boolean;
};
rootProps: SomeServiceOptions;
draggableProps: SomeServiceOptions;
};
```
In the render function declaration, you must pass rootProps and draggableProps to the element. At the same time, if you want to make the draggable activation not be carried out on the entire element, but only on its part (for example, a button that needs to be captured in order to drag), then you must pass draggableProps to this button and pass only rootProps to the element itself.
### reorder and move
```tsx
import { reorder, move } from 'react-cool-draggable';
```
These are the functions you need to apply inside the onDragEnd callback to sort the list of items in the component's state correctly. In this case, reorder does the usual sorting, and move - moving an element from one group to another, if you implement an exchange of elements between two or more droppable surfaces. This may sound complicated, but it isn't, so please see examples/trello for examples of how to use these functions.
```tsx
const newItems = reorder({
...options,
items,
getDraggableID: x => x.ID,
getDroppableID: () => 'row',
});
```
```tsx
const newItems = move({
...options,
items,
getDraggableID: x => x.ID,
getDroppableID: x => x.groupID,
setDroppableID: (x, droppableID) => {
x.groupID = droppableID;
},
});
```
# LICENSE
MIT Β© [Alex Plex](https://github.com/atellmer)