Skip to content

Commit 53fd28c

Browse files
committed
[CHORE] Fix readme
1 parent 61dcc26 commit 53fd28c

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ I you have ideas on how to approach this better. Please open an issue 😄
6767

6868
Caveats
6969
------------------------------------------------------------------------------
70-
- Not SortableJS plugins work.
70+
- Not all SortableJS plugins work... yet.
7171
- While you could bypass `@items` I highly discourage since the library manipulates the DOM directly.
7272

7373
Options
@@ -78,22 +78,23 @@ Component API
7878
------------------------------------------------------------------------------
7979
|arg|type|description|
8080
|:---|:---:|:---|
81-
| `@items`| Array | A list of the items to be managed by the addon|
82-
| `@onChoose` | Function | (SortablejsEvent) => {...}
83-
| `@onUnchoose` | Function | (SortablejsEvent) => {...}
84-
| `@onStart` | Function | (SortablejsEvent) => {...}
85-
| `@onEnd` | Function | (SortablejsEvent, cancelDnD) => {...}
86-
| `@onAdd` | Function | (SortablejsEvent) => {...}
87-
| `@onUpdate` | Function | (SortablejsEvent) => {...}
88-
| `@onSort` | Function | (SortablejsEvent) => {...}
89-
| `@onRemove` | Function | (SortablejsEvent) => {...}
90-
| `@onMove` | Function | (SortablejsMoveEvent) => {...}
91-
| `@onClone` | Function | (SortablejsEvent) => {...}
92-
| `@onChange` | Function | (SortablejsEvent) => {...}
93-
| `@scrollFn` | Function | (SortablejsEvent) => {...}
94-
| `@setData` | Function | (SortablejsEvent) => {...}
95-
| `@onFilter` | Function | (SortablejsEvent) => {...}
96-
| `@onSpill` | Function | (SortablejsEvent) => {...}
81+
| `@items` | Array | A list of the items to be managed by the addon |
82+
| `@options` | Object | A hash options supported by SortableJs|
83+
| `@onChoose` | Function | (SortablejsEvent) => {...} |
84+
| `@onUnchoose` | Function | (SortablejsEvent) => {...} |
85+
| `@onStart` | Function | (SortablejsEvent) => {...} |
86+
| `@onEnd` | Function | (SortablejsEvent, cancelDnD) => {...} |
87+
| `@onAdd` | Function | (SortablejsEvent) => {...} |
88+
| `@onUpdate` | Function | (SortablejsEvent) => {...} |
89+
| `@onSort` | Function | (SortablejsEvent) => {...} |
90+
| `@onRemove` | Function | (SortablejsEvent) => {...} |
91+
| `@onMove` | Function | (SortablejsMoveEvent) => {...} |
92+
| `@onClone` | Function | (SortablejsEvent) => {...} |
93+
| `@onChange` | Function | (SortablejsEvent) => {...} |
94+
| `@scrollFn` | Function | (SortablejsEvent) => {...} |
95+
| `@setData` | Function | (SortablejsEvent) => {...} |
96+
| `@onFilter` | Function | (SortablejsEvent) => {...} |
97+
| `@onSpill` | Function | (SortablejsEvent) => {...} |
9798

9899
`SortablejsEvent` - A [`CustomEvent`](https://github.com/SortableJS/Sortable#event-object-demo) provided by SortableJS
99100

0 commit comments

Comments
 (0)