A sortable list component built with React
Clone or download
Latest commit 7d2ffcf Dec 4, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ fix: Sortable uppercase S compatibility fix Oct 25, 2016
css fix for dev Dec 3, 2017
examples fix for dev Dec 3, 2017
lib update build Dec 3, 2017
src simplify code Dec 3, 2017
webdriver webdriver fix Jul 19, 2016
.babelrc webpack and babel config Apr 11, 2016
.editorconfig indentation & code style Apr 28, 2016
.gitignore Generate transpiled sources before publishing to npm Jun 11, 2016
.jshintrc indentation & code style Apr 28, 2016
LICENSE Added MIT License, closes #5 Jul 10, 2014
README.md release 2.0.0 Dec 3, 2017
bundle.js update Dec 3, 2017
index.html update Dec 3, 2017
package.json release 2.0.0 Dec 3, 2017
webpack.config.js update Dec 3, 2017
webpack.devConfig.js fix for dev Dec 3, 2017
webpack.standalone.js push compiled source Oct 14, 2017

README.md

React Sortable

David npm npm

Higher-order component for creating sortable lists with minimalistic implementation and without polyfills. Using just React.js and HTML5 DragEvent interface.

Mainly tested in latest stable Webkit, Firefox and IE.

Check out demo and source.

Installation

To install a stable release use:

npm i react-sortable --save

Example

First import the necessary dependencies.

import React from 'react';
import ReactDOM from 'react-dom';
import { sortable } from 'react-sortable';

Then create a component for the single item of the list.

class Item extends React.Component {
  render() {
    return (
      <li {...this.props}>
        {this.props.children}
      </li>
    )
  }
}


var SortableItem = sortable(Item);

And create component for the whole list, which will be the main component.

class SortableList extends React.Component {

  state = {
    items: this.props.items
  };

  onSortItems = (items) => {
    this.setState({
      items: items
    });
  }

  render() {
    const { items } = this.state;
    var listItems = items.map((item, i) => {
      return (
        <SortableItem
          key={i}
          onSortItems={this.onSortItems}
          items={items}
          sortId={i}>{item}</SortableItem>
      );
    });

    return (
      <ul className='sortable-list'>
        {listItems}
      </ul>
    )
  }
};

Now you can pass a list of items to the main component and render the whole result.

var items = [
  "Gold",
  "Crimson",
  "Hotpink",
  "Blueviolet",
  "Cornflowerblue",
  "Skyblue",
  "Lightblue",
  "Aquamarine",
  "Burlywood"
]

ReactDOM.render(
  <SortableList items={items} />,
  document.body
);

You can see this simple working demo in the ./example folder. For visual styling, you can add className of your choice.

How it works

Component will automatically attach the necessary drag event handlers.

It expects the following properties to be defined:

  • key (position of item in virtaul dom recommendation)
  • onSortItems (function called when an item is moved - dispatching if Redux action)
  • items (array of items to be sorted)
  • sortId (index of item in array)

Differences from react-dnd

  • fewer lines of code, easier to understand and modify
  • can handle both horizontal and vertical dragging
  • code is documented and covered with unit tests

Touch support

Unfortunately, at the moment there is no support of this interface in mobile browsers.

Purpose of this repo

This repository was published back in 2014 and was pretty much the very first implementation of drag and drop sortable list for React.js. Nowadays since there are other repositories which are well maintained (react-beautiful-dnd, react-sortable-hoc), I can recommend to use some of them in your project. This repository is now rather a showcase of what can be done just with simple React.js component and bare HTML5 API, having as few lines of code as possible. It can serve as inspiration for somebody who would like to reimplement this functionality from scratch.

Mainteners