c if sortable html,react-sortablejs
undefined
react-sortablejs
React component wrapping SortableJS!
We're now on version 2.0! A major API overhaul with typescript types.
Consider trying it out if you had any troubles earlier.
Things still to do.
We've released version 2.0 but there are still some things to do. We needed public feedback and a major release was the easiest way to get it.
Create examples from SortableJS Examples
Examples with code underneath.
List Props in readme.
Allow React to manage class names. Halfway there.
Write docs for plugins
Create all tests for examples (for 'ron). Started
Test the following UI component libraries:Styled Components
AntD
MaterialUI
React Bootstrap
React Grommet
React Toolbox
Your suggestion? :)
Table of Contents
Features
SortableJS
Everything you love about SortableJS, including to but not limited to:
Drag and Drop between lists
Multidrag and Swap plugin support.
Component Specific
Calculates items in list automatically
Updated API via props. Feels more like react than ever before.
Compatible with third part UI libraries
SortableJS Plugin Support
If you find any features lacking, create an issue and/or pull request.
Installation
npm install --save react-sortablejs
# OR
yarn add react-sortablejs
Please note that sortablejs is not required, as it's bundled in this component.
Learn
Here is the TLDR of what sortable is:
- Shopping List: # list of items / sortable. This represents `react-sortablejs`
- eggs # list item. These are all the items in the list and is what you move around.
- bread # list item
- milk # list item
Usage/Examples
Function Component
import React, { FC, useState } from "react";
import { ReactSortable } from "react-sortablejs-typescript";
interface ItemType {
id: number;
name: string;
}
export const BasicFunction: FC = props => {
const [state, setState] = useState([
{ id: 1, name: "shrek" },
{ id: 2, name: "fiona" }
]);
return (
{state.map(item => (
))}
);
};
Class Component
import React, { Component } from "react";
import { ReactSortable } from "react-sortablejs-typescript";
interface BasicClassState {
list: { id: string; name: string }[];
}
export class BasicClass extends Component {
state: BasicClassState = {
list: [{ id: "1", name: "shrek" }]
};
render() {
return (
list={this.state.list}
setList={newState => this.setState({ list: newState })}
>
{this.state.list.map(item => (
))}
);
}
}
Plugins
Sortable has some pretty cool pplugins such as MultiDrag and Swap.
By Default:
AutoScroll is premounted and enabled.
OnSpill is premounted and NOT enabled.
MultiDrag and Swap and NOT premounted and NOT enabled
You must mount mount the plugin with sortable ONCE ONLY.
import React from "react";
import { ReactSortable, Sortable, MultiDrag, Swap } from "react-sortablejs";
// mount whatever plugins you'd like to. These are the only current options.
Sortable.mount(new MultiDrag(), new Swap());
const App = () => {
const [state, setState] = useState([
{ id: 1, name: "shrek" },
{ id: 2, name: "fiona" }
]);
return (
multiDrag // enables mutidrag
// OR
swap // enables swap
>
{state.map(item => (
))}
);
};
Sortable API
For a comprehensive list of options, please visit https://github.com/SortableJS/Sortable#options.
Those options are applied as follows.
Sortable.create(element, {
group: " groupName",
animation: 200,
delayOnTouchStart: true,
delay: 2
});
// --------------------------
// Will now be..
// --------------------------
import React from "react";
import { ReactSortable } from "react-sortablejs";
const App = () => {
const [state, setState] = useState([
{ id: 1, name: "shrek" },
{ id: 2, name: "fiona" }
]);
return (
// here they are!
group="groupName"
animation={200}
delayOnTouchStart={true}
delay={2}
>
{state.map(item => (
))}
);
};
React API
id, className, style
Thes are all defaults DOM attributes. Nothing special here.
list
The same as state in const [ state, setState] = useState([{ id: 1}, {id: 2}])
state must be an array of items, with each item being an object that has the following shape:
/** The unique id associated with your item. It's recommended this is the same as the key prop for your list item. */
id: string | number;
/** When true, the item is selected using MultiDrag */
selected?: boolean;
/** When true, the item is deemed "chosen", which basically just a mousedown event. */
chosen?: boolean;
/** When true, it will not be possible to pick this item up in the list. */
filtered?: boolean;
[property: string]: any;
setList
The same as setState in const [ state, setState] = useState([{ id: 1}, {id: 2}])
clone
If you're using {group: { name: 'groupName', pull: 'clone'}}, this means your in 'clone' mode. You should provide a function for this.
Check out the source code of the clone example for more information. I'll write it here soon.
tag
ReactSortable is a div element by default. This can be changed to be any HTML element (for example ul, ol)
or can be a React component.
This value, be the component or the HTML element should be passed down under props.tag.
Let's explore both here.
HTML Element
Here we will use a ul. You can use any HTML.
Just add the string and ReactSortable will use a li instead of a div.
import React, { FC, useState, forwardRef } from "react";
import { ReactSortable } from "react-sortablejs-typescript";
export const BasicFunction: FC = props => {
const [state, setState] = useState([{ id: "1", name: "shrek" }]);
return (
{state.map(item => (
{item.name}))}
);
};
Custom Component
When using a custom component in the tag prop, the only component it allows is a forwardRef component.
Currently we only support components who use the React.forwardRef API.
If it doesn't have one, you can add one using React.forwardRef().
todo: Some third party UI components may have nested elements to create the look they're after.
This could be an issue and not sure how to fix.
import React, { FC, useState, forwardRef } from "react";
import { ReactSortable } from "react-sortablejs-typescript";
// This is just like a normal component, but now has a ref.
const CustomComponent = forwardRef((props, ref) => {
return
});
export const BasicFunction: FC = props => {
const [state, setState] = useState([
{ id: 1, name: "shrek" },
{ id: 2, name: "fiona" }
]);
return (
{state.map(item => (
))}
);
};
How does it work?
Sortable affects the DOM, adding, and removing nodes/css when it needs to in order to achieve the smooth transitions we all know an love.
This component reverses many of it's actions of the DOM so React can handle this when the state changes.
Caveats / Gotchas
key !== index
DO NOT use the index as a key for your list items. Sorting will not work.
In all the examples above, I used an object with an ID. You should do the same!
I may even enforce this into the design to eliminate errors.
Nesting
Problem
Basically the child updates the state twice. I'm working on this.
What does work?
Our usage indicates that as long as we only move items between lists that don't use the same setState function.
I hope to provide an example soon.
Solutions
We don't have anything that works 100%, but here I'd like to spit ball some potential avenues to look down.
Use onMove to handle state changes instead of onAdd,onRemove, etc.
Create a Sortable plugin specifically for react-sortbalejs