add-context-menu
v1.9.0
Published
A simple universal context menu for HTML elements.
Downloads
41
Readme
add-context-menu
A simple universal context menu for HTML elements. https://www.npmjs.com/package/add-context-menu https://github.com/Rudeus3Greyrat/vue-context-menu
Installation
# install with npm
npm i add-context-menu
Quick Start
# import add-context-menu
import ContextMenu from 'add-context-menu'
import ContextMenuItem from 'add-context-menu'
Vue.use(ContextMenu)
Vue.use(ContextMenuItem)
How to Use
# Put context-menu including context-menu-items closely next to the element that you want add customed context menu to.
Example
<div id='example'></div>
<context-menu @select="handleSelect">
<context-menu-item :select="download">Download</context-menu-item>
<context-menu-item :select="rename">Rename</context-menu-item>
<context-menu-item :select="moreInfo">More Info</context-menu-item>
</context-menu>
# In this case, HTML element 'example' is the one we want to add customed context menu to.
# <context-menu></context-menu> is the wrapper of the menu.
# <context-menu-item></context-menu-item> is the item in context menu.
context-menu Events
| Event Name | Description | Parameters | | :--------: | :------------------------------------------: | :----------------------------------------------: | | select | triggers when a context menu item is clicked | the select dispatched from the context menu item |
context-menu-item Attributes
| Attribute | Description | Type | Default | | :-------: | :---------------------------------------------------------: | :------------------: | :-----: | | select | a select to be dispatched to context-menu's select callback | string/number/object | '' | | disabled | whether the item is disabled | boolean | false |
context-menu-item Slot
Custom content for context-menu-item.
For detailed explanation on how things work, consult the docs for vue-loader.