Skip to content

Commit 5bdf2c9

Browse files
committed
docs: removes toc and features
1 parent 9eb1e5e commit 5bdf2c9

File tree

1 file changed

+1
-54
lines changed

1 file changed

+1
-54
lines changed

README.md

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,9 @@
11
# `react-sortablejs`
22

3-
React component wrapping [SortableJS](https://github.com/SortableJS/Sortable)!
4-
5-
We're now on version 2.0! A major API overhaul with typescript types.
6-
7-
Consider trying it out if you had any troubles earlier.
8-
9-
## Table of Contents
10-
11-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
12-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
13-
14-
- [Features](#features)
15-
- [SortableJS](#sortablejs)
16-
- [Component Specific](#component-specific)
17-
- [Installation](#installation)
18-
- [Learn](#learn)
19-
- [Usage/Examples](#usageexamples)
20-
- [Function Component](#function-component)
21-
- [Class Component](#class-component)
22-
- [Plugins](#plugins)
23-
- [Sortable API](#sortable-api)
24-
- [React API](#react-api)
25-
- [id, className, style](#id-classname-style)
26-
- [list](#list)
27-
- [setList](#setlist)
28-
- [clone](#clone)
29-
- [tag](#tag)
30-
- [HTML Element](#html-element)
31-
- [Custom Component](#custom-component)
32-
- [How does it work?](#how-does-it-work)
33-
- [Caveats / Gotchas](#caveats--gotchas)
34-
- [`key !== index`](#key--index)
35-
- [Nesting](#nesting)
36-
- [Problem](#problem)
37-
- [What does work?](#what-does-work)
38-
- [Solutions](#solutions)
39-
40-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3+
React bindings to [SortableJS](https://github.com/SortableJS/Sortable)
414

425
## Features
436

44-
### SortableJS
45-
46-
Everything you love about SortableJS, including to but not limited to:
47-
48-
- [x] Drag and Drop between lists
49-
- [x] Multidrag and Swap plugin support.
50-
51-
### Component Specific
52-
53-
- [x] Calculates items in list automatically
54-
- [x] Updated API via `props`. Feels more like react than ever before.
55-
- [x] Compatible with third part UI libraries
56-
- [x] SortableJS Plugin Support
57-
58-
If you find any features lacking, create an issue and/or pull request.
59-
607
## Installation
618

629
```shell

0 commit comments

Comments
 (0)