2
0
mirror of https://github.com/tenrok/vue-context.git synced 2026-05-20 12:49:36 +03:00

Document event emitters

This commit is contained in:
Randall Wilk
2018-10-15 09:02:33 -05:00
parent 604aaa9c1d
commit 6dfbf4200c
+12 -5
View File
@@ -146,10 +146,17 @@ new Vue({
## Props
| Property | Type | Default | Description
| -------- | ---- | ------- | -----------
| `closeOnClick` | Boolean | `true` | If set to false, context menu will not automatically close when clicked on.
| `closeOnScroll` | Boolean | `true` | If set to true, context menu will automatically close on window scroll.
| Property | Type | Default | Description |
| --- | --- | --- | --- |
| `closeOnClick` | Boolean | `true` | If set to false, context menu will not automatically close when clicked on. |
| `closeOnScroll` | Boolean | `true` | If set to true, context menu will automatically close on window scroll. |
## Events
| Event | Params | Description |
| --- | --- | --- |
| close | none | Emits when the context menu is closed |
| open | `event`, `data`, `top`, `left` | Emits when the menu is opened. The event, context menu data, top and left position are all sent through as parameters as well. |
## Credits
@@ -159,4 +166,4 @@ vue-context is intended to provide a simple and lightweight context menu for Vue
## License
The MIT License (MIT). Please see the [License file](https://github.com/rawilk/vue-context/blob/master/LICENSE) for more information.
The MIT License (MIT). Please see the [License file](https://github.com/rawilk/vue-context/blob/master/LICENSE) for more information.