archive-gh-me/draggable
1
0
Fork 0
mirror of https://github.com/Shopify/draggable.git synced 2026-02-01 16:46:56 +00:00
Code Issues Projects Releases Wiki Activity

Draggable README corrections

Browse Source
This commit is contained in:
Max Hoffmann 2018-01-21 10:54:26 -05:00
parent 3962a09658
commit 3d0237ad5d
No known key found for this signature in database
GPG Key ID: 1DFA4D13DD27A676
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/Draggable/README.md
View File

@ -98,20 +98,21 @@ on elements in certain states.
### Events
| Name | Description | Cancelable | Cancelable action |
| -------------------------------------------- | ---------------------------------------------------------- | ----------- | -------------------- |
| [`drag:start`][dragstart] | Gets fired when drag action begins | true | Prevents drag start |
| [`drag:move`][dragmove] | Gets fired when moving a draggable around | false | - |
| [`drag:over`][dragover] | Gets fired when dragging over other draggable | false | - |
| [`drag:over:container`][dragovercontainer] | Gets fired when dragging over other draggable container | false | - |
| [`drag:out`][dragout] | Gets fired when dragging out of other draggable | false | - |
| [`drag:out:container`][dragoutcontainer] | Gets fired when dragging out of other draggable container | false | - |
| [`drag:stop`][dragstop] | Gets fired when draggable has been released | false | - |
| [`drag:pressure`][dragpressure] | Gets fired when using force touch on draggable element | false | - |
| [`mirror:created`][mirrorcreated] | Gets fired when draggable mirror gets created | false | - |
| [`mirror:attached`][mirrorattached] | Gets fired when draggable mirror gets attached to DOM | false | - |
| [`mirror:move`][mirrormove] | Gets fired when draggable mirror moves | true | Stop mirror movement |
| [`mirror:destroy`][mirrordestroy] | Gets fired when draggable mirror gets removed | true | Stop mirror removal |
| Name | Description | Cancelable | Cancelable action |
| -------------------------------------------- | ---------------------------------------------------------- | ----------- | ------------------------ |
| [`drag:start`][dragstart] | Gets fired when drag action begins | true | Prevents drag start |
| [`drag:move`][dragmove] | Gets fired when moving a draggable around | false | - |
| [`drag:over`][dragover] | Gets fired when dragging over other draggable | false | - |
| [`drag:over:container`][dragovercontainer] | Gets fired when dragging over other draggable container | false | - |
| [`drag:out`][dragout] | Gets fired when dragging out of other draggable | false | - |
| [`drag:out:container`][dragoutcontainer] | Gets fired when dragging out of other draggable container | false | - |
| [`drag:stop`][dragstop] | Gets fired when draggable has been released | false | - |
| [`drag:pressure`][dragpressure] | Gets fired when using force touch on draggable element | false | - |
| [`mirror:create`][mirrorcreate] | Gets fired before draggable mirror gets created | true | Prevents mirror creation |
| [`mirror:created`][mirrorcreated] | Gets fired when draggable mirror gets created | false | - |
| [`mirror:attached`][mirrorattached] | Gets fired when draggable mirror gets attached to DOM | false | - |
| [`mirror:move`][mirrormove] | Gets fired when draggable mirror moves | true | Stop mirror movement |
| [`mirror:destroy`][mirrordestroy] | Gets fired when draggable mirror gets removed | true | Stop mirror removal |
[dragstart]: DragEvent#dragstartevent
[dragmove]: DragEvent#dragmoveevent
@ -122,6 +123,7 @@ on elements in certain states.
[dragstop]: DragEvent#dragstopevent
[dragpressure]: DragEvent#dragpressureevent
[mirrorcreate]: MirrorEvent#mirrorcreateevent
[mirrorcreated]: MirrorEvent#mirrorcreatedevent
[mirrorattached]: MirrorEvent#mirrorattachedevent
[mirrormove]: MirrorEvent#mirrormoveevent