Skip to content

Commit 7aa68d8

Browse files
committed
Update Sortable & AbstractEvent docs
1 parent d60e3b0 commit 7aa68d8

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

src/Sortable/SortableEvent/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,14 @@ Read-only property for the start container of the current draggable source.
4848

4949
### API
5050

51-
**`sortableEvent.oldIndex: Number`**
52-
Read-only property for the old index of the current draggable source.
51+
**`sortableEvent.currentIndex: Number`**
52+
Read-only property for the index of the current draggable source.
5353

54-
**`sortableEvent.newIndex: Number`**
55-
Read-only property for the new index of the current draggable source.
54+
**`sortableEvent.over: HTMLElement`**
55+
Read-only property for the draggable source you are hovering over.
5656

57-
**`sortableEvent.oldContainer: HTMLElement`**
58-
Read-only property for the old container of the current draggable source.
59-
60-
**`sortableEvent.newContainer: HTMLElement`**
61-
Read-only property for the new container of the current draggable source.
57+
**`sortableEvent.overContainer: HTMLElement`**
58+
Read-only property for the container of the draggable source you are hovering over.
6259

6360
## SortableSortedEvent
6461

src/shared/AbstractEvent/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ your own custom events.
1616
**`new AbstractEvent(data: Object): AbstractEvent`**
1717
Creates an `AbstractEvent` instance.
1818

19-
**`abstractEvent.cancel(data: Object): null`**
19+
**`abstractEvent.cancel(): void`**
2020
Cancels drag start event.
2121

2222
**`abstractEvent.canceled(): Boolean`**
@@ -25,5 +25,9 @@ Checks if event has been canceled.
2525
**`abstractEvent.type: String`**
2626
Read-only property to find out event type
2727

28-
**`abstractEvent.cancelable: String`**
28+
**`abstractEvent.cancelable: Boolean`**
2929
Read-only property to check if event is cancelable
30+
31+
**`abstractEvent.clone(data: Object): AbstractEvent`**
32+
Creates an `AbstractEvent` instance with existing event data. This method allows
33+
for overriding of event data.

0 commit comments

Comments
 (0)