Skip to content

Commit 068705b

Browse files
committed
document (some of the ) events
1 parent 575e0b3 commit 068705b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ SwipeList component is just a helper for listing multiple SwipeOuts.
4040
| `disabled` | Boolean | |false | if true items will be disabled, and text selection will be possible (on desktop). adds class ``swipeout--disabled`` |
4141
| `threshold` | Number | |45 | With that property you can fine tune when actions are considered open |
4242

43+
#### Events
44+
45+
| Prop | Payload | Description |
46+
| ----------------------- | --------------- | -|
47+
| `swipeout:click` | { event, item } | Emitted on single click/tap on the item |
48+
| `swipeout:doubleclick` | { event, item } | Emitted on double click/tap on the item |
49+
| `active` | Boolean | Emitted when the user is opening/closing the any of the actions |
50+
51+
4352
### SwipeOut
4453

4554
SwipeOut is the main component, representing a single item with it's actions.
@@ -51,6 +60,14 @@ SwipeOut is the main component, representing a single item with it's actions.
5160
| `disabled` | Boolean | |false | if true items will be disabled, and text selection will be possible (on desktop). adds class ``swipeout--disabled`` |
5261
| `threshold` | Number | |45 | With that property you can fine tune when actions are considered open |
5362

63+
#### Events
64+
65+
| Prop | Payload | Description |
66+
| ----------------------- | --------------- | -|
67+
| `swipeout:click` | event | Emitted on single click/tap on the item |
68+
| `swipeout:doubleclick` | event | Emitted on double click/tap on the item |
69+
| `active` | Boolean | Emitted when the user is opening/closing the any of the actions |
70+
5471
```html
5572
<swipe-list :items="mockSwipeList" transition-key="id" @swipeout:contentclick="contentClick" @swipeout:click="itemClick" @swipeout:doubleclick="itemDblClick">
5673
<template slot-scope="{ item, index, revealLeft, revealRight, close }">

0 commit comments

Comments
 (0)