Skip to content

Commit 500c337

Browse files
committed
Better plugin docs
1 parent 7994135 commit 500c337

File tree

5 files changed

+60
-2
lines changed

5 files changed

+60
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Supported by [<img width="100px" src="https://user-images.githubusercontent.com/
1515
* Smart auto-scrolling
1616
* Advanced swap detection
1717
* Smooth animations
18-
* [Multi-drag](https://github.com/SortableJS/Sortable/wiki/Dragging-Multiple-Items-in-Sortable) support
18+
* [Multi-drag](https://github.com/SortableJS/Sortable/tree/master/plugins/MultiDrag) support
1919
* Built using native HTML5 drag and drop API
2020
* Supports
2121
* [Meteor](https://github.com/SortableJS/meteor-sortablejs)
2222
* Angular
2323
* [2.0+](https://github.com/SortableJS/angular-sortablejs)
24-
* [1.*](https://github.com/SortableJS/angular-legacy-sortablejs)
24+
* [1.&ast;](https://github.com/SortableJS/angular-legacy-sortablejs)
2525
* React
2626
* [ES2015+](https://github.com/SortableJS/react-sortablejs)
2727
* [Mixin](https://github.com/SortableJS/react-mixin-sortablejs)
@@ -31,6 +31,7 @@ Supported by [<img width="100px" src="https://user-images.githubusercontent.com/
3131
* [Ember](https://github.com/SortableJS/ember-sortablejs)
3232
* Supports any CSS library, e.g. [Bootstrap](#bs)
3333
* Simple API
34+
* Support for [plugins](#plugins)
3435
* [CDN](#cdn)
3536
* No jQuery required (but there is [support](https://github.com/SortableJS/jquery-sortablejs))
3637

@@ -719,6 +720,19 @@ Mounts a plugin to Sortable.
719720
---
720721

721722

723+
### Plugins
724+
#### Extra Plugins (included in complete versions)
725+
- [MultiDrag](https://github.com/SortableJS/Sortable/tree/master/plugins/MultiDrag)
726+
- [Swap](https://github.com/SortableJS/Sortable/tree/master/plugins/Swap)
727+
728+
#### Default Plugins (included in default versions)
729+
- [AutoScroll](https://github.com/SortableJS/Sortable/tree/master/plugins/AutoScroll)
730+
- [OnSpill](https://github.com/SortableJS/Sortable/tree/master/plugins/OnSpill)
731+
732+
733+
---
734+
735+
722736
<a name="cdn"></a>
723737
### CDN
724738

plugins/AutoScroll/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ Demo:
1010
---
1111

1212

13+
### Mounting
14+
```js
15+
import { Sortable, AutoScroll } from 'sortablejs';
16+
17+
Sortable.mount(new AutoScroll());
18+
```
19+
20+
21+
---
22+
23+
1324
### Options
1425

1526
```js

plugins/MultiDrag/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Demo: https://jsbin.com/wopavom/edit?js,output
99
---
1010

1111

12+
### Mounting
13+
```js
14+
import { Sortable, MultiDrag } from 'sortablejs';
15+
16+
Sortable.mount(new MultiDrag());
17+
```
18+
19+
20+
---
21+
22+
1223
### Options
1324

1425
```js

plugins/OnSpill/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ This file contains two seperate plugins, RemoveOnSpill and RevertOnSpill. They c
66
---
77

88

9+
### Mounting
10+
```js
11+
import { Sortable, OnSpill } from 'sortablejs';
12+
13+
Sortable.mount(OnSpill);
14+
```
15+
16+
17+
---
18+
19+
920
## RevertOnSpill Plugin
1021
This plugin, when enabled, will cause the dragged item to be reverted to it's original position if it is spilled (ie. it is dropped outside of a valid Sortable drop target)
1122

plugins/Swap/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ Demo: https://jsbin.com/yejehog/edit?html,js,output
77
---
88

99

10+
### Mounting
11+
```js
12+
import { Sortable, Swap } from 'sortablejs';
13+
14+
Sortable.mount(new Swap());
15+
```
16+
17+
18+
---
19+
20+
1021
### Options
1122

1223
```js

0 commit comments

Comments
 (0)