Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jasonslyvia/react-anything-sortable

A ReactJS component that can sort any children with touch support and IE8 compatibility
https://github.com/jasonslyvia/react-anything-sortable

Last synced: 7 days ago
JSON representation

A ReactJS component that can sort any children with touch support and IE8 compatibility

Awesome Lists containing this project

README 

        
This project is in INACTIVE status, bugfix will be maintained, but no new feature will be added. Feel free to use it if it suits your need, for complicated sorting features I'd recommend [react-dnd](https://github.com/react-dnd/react-dnd) by dan.



-----



# react-anything-sortable [![Build Status](https://travis-ci.org/jasonslyvia/react-anything-sortable.svg)](https://travis-ci.org/jasonslyvia/react-anything-sortable) [![npm version](https://badge.fury.io/js/react-anything-sortable.svg)](http://badge.fury.io/js/react-anything-sortable) [![Coverage Status](https://coveralls.io/repos/github/jasonslyvia/react-anything-sortable/badge.svg?branch=master)](https://coveralls.io/github/jasonslyvia/react-anything-sortable?branch=master)



## Features



 - Sort any React element you like, images, composite components, etc.

 - No external dependencies but `React` itself

 - Touch event support

 - Thoroughly tested



## Quick Demo



[Live Demo](http://jasonslyvia.github.io/react-anything-sortable/demo/)



**Sort custom style children**



![react-anything-sortable](http://ww4.sinaimg.cn/large/831e9385gw1equswkpcfag209p02sgn5.gif)



**Sort images**



![react-anything-sortable](http://ww3.sinaimg.cn/mw690/831e9385gw1equstgvfmzg20a50360va.gif)



**Children with custom event handler**



![react-anything-sortable](http://ww4.sinaimg.cn/large/831e9385gw1eqy459cieqg20au02s0t4.gif)



## Installation



```

$ npm install --save react-anything-sortable



// UMD build is provided as well, but please do consider use modern module bundlers like webpack or browserify.

```



You have to add necessary styles for sortable to work properly, if you're using bundle tools like webpack, just 



```javascript

import 'react-anything-sortable/sortable.css';

```



Or copy this css to your own style base.



## How to use



You can check the straight-forward demo by examining `demo` folder, or here's a brief example.



In `app.js`



````javascript

var ReactDOM = require('react-dom');

var Sortable = require('react-anything-sortable');

var SortableItem = require('./SortableItem');



ReactDOM.render(



  

  



, document.body);

````



and in `SortableItem.js`



A modern usage would be



```javascript

import React from 'react';

import { SortableContainer } from 'react-anything-sortable';



@sortable

class SortableItem extends React.Component {

  render() {

    return (

      

        


          your item

        


      

    );

  }

};

```



Or you want to construct it manually



```javascript

import React from 'react';

import { sortable } from 'react-anything-sortable';



@sortable

class SortableItem extends React.Component {

  render() {

    return (

      


        your item                //     it contains required `className`s and

      
                     //     event handlers

    );

  }

};

```



Or if you favor the old fashion way



````javascript

var React = require('react');

var createReactClass = require('create-react-class');

var SortableItemMixin = require('react-anything-sortable').SortableItemMixin;



var SortableItem = createReactClass({

  mixins: [SortableItemMixin],



  render: function(){

    return this.renderWithSortable(  // <-- this.renderWithSortable call is essential

      
your item


    );

  }

});

````



You can even pass un-sortable children to `` and it just works, checkout this [demo](http://jasonslyvia.github.io/react-anything-sortable/demo/#/fixed) to find out more. If you do so, remember to add according style to your un-sortable items.



## Props



### onSort



Type: Function Default: () => {}



Being called with sorted data when a sort operation is finished.



**Arguments**



 1. sortedArray (*Array*) Sorted array consists of `sortData` plucked from each sortable item

 2. currentDraggingSortData (*Any*) The sortData of dragging element

 3. currentDraggingIndex (*Number*) The index of dragging element



### containment



Type: Bool Default: false



Constrain dragging area within sortable container.



[demo](http://jasonslyvia.github.io/react-anything-sortable/demo/index.html#/containment)



### dynamic



Type: Bool Default: false



Dynamically update the sortable when its children change. If using this option, make sure to use the onSort callback to update the order of the children passed to the Sortable component when the user sorts!



[demo](http://jasonslyvia.github.io/react-anything-sortable/demo/index.html#/dynamic)



### sortHandle



Type: String Default: undefined



A className to allow only matching element of sortable item to trigger sort operation. 



[demo](http://jasonslyvia.github.io/react-anything-sortable/demo/index.html#/handle)



### sortData



**Add this props to `SortableItem` rather than `Sortable` !**



Type: Any Default: undefined



Will be returned by `onSort` callback in the form of array.



### direction



Type: String Default: false 

Options: vertical, horizontal



Will force dragging direction to vertical or horizontal mode.



## Notice



1. Specify your style for `Sortable` and `Sortable Items`, check `sortable.css`, **it is NOT optional!**

2. Don't forget the `this.renderWithSortable` call in `SortableItem`, or spread props to your component if using decorators.

3. In order to dynamically add or remove `SortableItem`s or change their order from outside the `Sortable`, you must use the `dynamic` option. This also requires using the `onSort` callback to update the order of the children when sorting happens.

4. Make sure to add `draggable={false}` to images within sortable components to prevent glitching. See [here](https://github.com/jasonslyvia/react-anything-sortable/blob/master/demo/components/ImageItem.js) for an example.



## Scripts



```

$ npm run test

$ npm run watch

$ npm run build

$ npm run demo

$ npm run demo:watch

```



## Contributors



1. [stayradiated](https://github.com/stayradiated)

2. [vizath](https://github.com/vizath)

3. [zthomas](https://github.com/zthomas)

4. [jakubruffer](https://github.com/jakubruffer)

5. [Fabeline](https://github.com/Fabeline)

6. [antialiasis](https://github.com/antialiasis)

7. [JasonKleban](https://github.com/JasonKleban)