Warning
This library is no longer actively maintained. It will continue to receive critical security updates, but there are no new features planned.
In future versions of React, the findDOMNode method will be deprecated. This method is a critical piece of the architecture of react-sortable-hoc, and the library will stop working in the future when that method is removed from react-dom.
All development efforts have been redirected towards @dnd-kit. It provides feature parity, built with a modern and extensible architecture, supports complex use-cases and has accessibility features built-in. New consumers are strongly encouraged to adopt @dnd-kit instead of adopting react-sortable-hoc.
A set of higher-order components to turn any list into an animated, accessible and touch-friendly sortable list
Features
- Higher Order Components – Integrates with your existing components
- Drag handle, auto-scrolling, locked axis, events, and more!
- Suuuper smooth animations – Chasing the 60FPS dream 🌈
- Works with virtualization libraries: react-virtualized, react-tiny-virtual-list, react-infinite, etc.
- Horizontal lists, vertical lists, or a grid ↔ ↕ ⤡
- Touch support 👌
- Accessible: supports keyboard sorting
Installation
Using npm:
$ npm install react-sortable-hoc --save
Then, using a module bundler that supports either CommonJS or ES2015 modules, such as webpack:
// Using an ES6 transpiler like Babel
import {SortableContainer, SortableElement} from 'react-sortable-hoc';
// Not using an ES6 transpiler
var Sortable = require('react-sortable-hoc');
var SortableContainer = Sortable.SortableContainer;
var SortableElement = Sortable.SortableElement;
Alternatively, an UMD build is also available:
<script src="react-sortable-hoc/dist/react-sortable-hoc.umd.js"></script>
Usage
Basic Example
import React, {Component} from 'react';
import {render} from 'react-dom';
import {SortableContainer, SortableElement} from 'react-sortable-hoc';
import arrayMove from 'array-move';
const SortableItem = SortableElement(({value}) => <li>{value}</li>);
const SortableList = SortableContainer(({items}) => {
return (
<ul>
{items.map((value, index) => (
<SortableItem key={`item-${value}`} index={index} value={value} />
))}
</ul>
);
});
class SortableComponent extends Component {
state = {
items: ['Item 1', 'Item 2', 'Item 3', 'Item 4', 'Item 5', 'Item 6'],
};
onSortEnd = ({oldIndex, newIndex}) => {
this.setState(({items}) => ({
items: arrayMove(items, oldIndex, newIndex),
}));
};
render() {
return <SortableList items={this.state.items} onSortEnd={this.onSortEnd} />;
}
}
render(<SortableComponent />, document.getElementById('root'));
That's it! React Sortable does not come with any styles by default, since it's meant to enhance your existing components.
More code examples are available here.
Why should I use this?
There are already a number of great Drag & Drop libraries out there (for instance, react-dnd is fantastic). If those libraries fit your needs, you should definitely give them a try first. However, most of those libraries rely on the HTML5 Drag & Drop API, which has some severe limitations. For instance, things rapidly become tricky if you need to support touch devices, if you need to lock dragging to an axis, or want to animate the nodes as they're being sorted. React Sortable HOC aims to provide a simple set of higher-order components to fill those gaps. If you're looking for a dead-simple, mobile-friendly way to add sortable functionality to your lists, then you're in the right place.
Prop Types
SortableContainer HOC
| Property |
Type |
Default |
Description |
| axis |
String |
y |
Items can be sorted horizontally, vertically or in a grid. Possible values: x, y or xy |
| lockAxis |
String |
|
If you'd like, you can lock movement to an axis while sorting. This is not something that is possible with HTML5 Drag & Drop. Possible values: x or y. |
| helperClass |
String |
|
You can provide a class you'd like to add to the sortable helper to add some styles to it |
| transitionDuration |
Number |
300 |
The duration of the transition when elements shift positions. Set this to 0 if you'd like to disable transitions |
| keyboardSortingTransitionDuration |
Number |
transitionDuration |
The duration of the transition when the helper is shifted during keyboard sorting. Set this to 0 if you'd like to disable transitions for the keyboard sorting helper. Defaults to the value set for transitionDuration if undefined |
| keyCodes |
Array |
{
lift: [32],
drop: [32],
cancel: [27],
up: [38, 37],
down: [40, 39]
} |
An object containing an array of keycodes for each keyboard-accessible action. |
| pressDelay |
Number |
0 |
If you'd like elements to only become sortable after being pressed for a certain time, change this property. A good sensible default value for mobile is 200. Cannot be used in conjunction with the distance prop. |
| pressThreshold |
Number |
5 |
Number of pixels of movement to tolerate before ignoring a press event. |
| distance |
Number |
0 |
If you'd like elements to only become sortable after being dragged a certain number of pixels. Cannot be used in conjunction with the pressDelay prop. |
| shouldCancelStart |
Function |
Function |
This function is invoked before sorting begins, and can be used to programatically cancel sorting before it begins. By default, it will cancel sorting if the event target is either an input, textarea, select, option, or button. |
| updateBeforeSortStart |
Function |
|
This function is invoked before sorting begins. It can return a promise, allowing you to run asynchronous updates (such as setState) before sorting begins. function({node, index, collection, isKeySorting}, event) |
| onSortStart |
Function |
|
Callback that is invoked when sorting begins. function({node, index, collection, isKeySorting}, event) |
| onSortMove |
Function |
|
Callback that is invoked during sorting as the cursor moves. function(event) |
| onSortOver |
Function |
|
Callback that is invoked when moving over an item. function({index, oldIndex, newIndex, collection, isKeySorting}, e) |
| onSortEnd |
Function |
|
Callback that is invoked when sorting ends. function({oldIndex, newIndex, collection, isKeySorting}, e) |
| useDragHandle |
Boolean |
false |
If you're using the SortableHandle HOC, set this to true |
| useWindowAsScrollContainer |
Boolean |
false |
If you want, you can set the window as the scrolling container |
| hideSortableGhost |
Boolean |
true |
Whether to auto-hide the ghost element. By default, as a convenience, React Sortable List will automatically hide the element that is currently being sorted. Set this to false if you would like to apply your own styling. |
| lockToContainerEdges |
Boolean |
false |
You can lock |
一套 React 高阶组件(HOC),可以把任意列表变成带动画、无障碍、支持触屏的可排序列表——横排、竖排或网格布局都可以。