Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.65 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.65 KB

react-sortable-dnd

A React component to sort elements of any type. It also supports dropping external elements in any position.

Demo

Install

npm i react-sortable-dnd --save 

Usage

<Sortable onSort={components => console.log(components)}>
    <div>Apple</div>
    <div>Mango</div>
    <div>Pineapple</div>
</Sortable>

Props

Prop Type/Options Default Description
className string Sortable Optional The class name of the component
classPlaceholder string Placeholder Optional The class name of the placeholder component when dragging external elements.
enabled boolean true Optional Enable/disable the sorting
type string `` Optional Type of the elements to sort, in case you want to restrict elements of other Sortable lists.

Event Props

Prop Parameters Description
onSort (components) The sorting callback function.
onSortStart (components) Triggered when an element starts being dragged.
onDrop (e, data, index) Optional Called when an external element is dropped.

Changelog

  • 1.0.0
    • Initial release 🎉

License

ISC License