Skip to content

Commit db08727

Browse files
committed
Update missing events on Droppable documentation
1 parent 8f8d607 commit db08727

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

index.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,14 @@ declare module '@shopify/draggable' {
5656
? MirrorMoveEvent
5757
: eventName extends 'mirror:destroy'
5858
? MirrorDestroyEvent
59+
: eventName extends 'droppable:start'
60+
? DroppableStartEvent
5961
: eventName extends 'droppable:dropped'
6062
? DroppableDroppedEvent
6163
: eventName extends 'droppable:returned'
6264
? DroppableReturnedEvent
65+
: eventName extends 'droppable:stop'
66+
? DroppableStopEvent
6367
: eventName extends 'sortable:start'
6468
? SortableStartEvent
6569
: eventName extends 'sortable:sort'
@@ -350,8 +354,10 @@ declare module '@shopify/draggable' {
350354
* Droppable
351355
*/
352356
export type DroppableEventNames =
357+
'droppable:start' |
353358
'droppable:dropped' |
354359
'droppable:returned' |
360+
'droppable:stop' |
355361
DraggableEventNames;
356362

357363
export class DroppableEvent extends AbstractEvent {

src/Droppable/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Droppable
22

33
Droppable is built on top of Draggable and allows you to declare draggable and droppable elements via options.
4-
Droppable fires two events on top of the draggable events: `droppable:dropped` and `droppable:returned`.
4+
Droppable fires four events on top of the draggable events: `droppable:start`, `droppable:dropped`, `droppable:returned` and `droppable:stop`.
55
Droppable elements must begin in an occupied dropzone (see below, [Classes](#classes) and example),
66
so they may returned if the drag is canceled or returned.
77

@@ -57,13 +57,17 @@ elements within the `containers`.
5757

5858
Check out [Draggable events](../Draggable#events) for the base events
5959

60-
| Name | Description | Cancelable | Cancelable action |
61-
| ----------------------------------------- | --------------------------------------------------------------- | ---------- | ----------------- |
62-
| [`droppable:dropped`][droppabledropped] | Gets fired when dropping draggable element into a dropzone | true | Prevents drop |
63-
| [`droppable:returned`][droppablereturned] | Gets fired when draggable elements returns to original dropzone | true | Prevents return |
60+
| Name | Description | Cancelable | Cancelable action |
61+
| ----------------------------------------- | ------------------------------------------------------------------------- | ---------- | ----------------- |
62+
| [`droppable:start`][droppablestart] | Gets fired before dropping the draggable element into a dropzone | true | Prevents drag |
63+
| [`droppable:dropped`][droppabledropped] | Gets fired when dropping draggable element into a dropzone | true | Prevents drop |
64+
| [`droppable:returned`][droppablereturned] | Gets fired when draggable elements returns to original dropzone | true | Prevents return |
65+
| [`droppable:stop`][droppablestop] | Gets fired before dropping the draggable element into a dropzone element | false | - |
6466

67+
[droppablestart]: DroppableEvent#droppablestartevent
6568
[droppabledropped]: DroppableEvent#droppabledroppedevent
6669
[droppablereturned]: DroppableEvent#droppablereturnedevent
70+
[droppablestop]: DroppableEvent#droppablestopevent
6771

6872
### Classes
6973

src/Sortable/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Sortable
22

33
Sortable is built on top of Draggable and allows you to reorder elements. It maintains the order internally and fires
4-
three events on top of the draggable events: `sortable:start`, `sortable:sort`, `sortable:sorted` and `sortable:stop`.
4+
four events on top of the draggable events: `sortable:start`, `sortable:sort`, `sortable:sorted` and `sortable:stop`.
55

66
Make sure to nest draggable elements as immediate children elements to their corresponding containers, this is a requirement for `Sortable`.
77

0 commit comments

Comments
 (0)