vue-simple-context-menu
Simple context-menu component built for Vue. Works well with both left and right clicks. Nothing too fancy, just works and is simple to use.
Install
# npm
npm i vue-simple-context-menu
#yarn
yarn add vue-simple-context-menu
Or you can include it through the browser at the bottom of your page:
<script src="https://unpkg.com/vue-simple-context-menu"></script>
About
Just a simple little menu to be shown where a click happens - closes after use automatically by clicking an option or outside of the menu.
Usage Example
Note - you must pass the click event-info variable to the showMenu()
function because that's how we know where to show the menu.
Note - make sure to use @click.prevent.stop
or @contextmenu.prevent.stop
for right click) when setting up the click handler.
Props
prop | type | description |
---|---|---|
options | Array | Array of menu options to show. Component will use the name parameter as the label. |
Methods
method | parameters | description |
---|---|---|
showMenu | event (MouseEvent), item (Object) | Used to show the menu. Make sure to pass a MouseEvent and an Object. |
Events
event | value | description |
---|---|---|
optionClicked | Object | When a menu item is clicked the component will emit an event with a value containing the clicked item and the menu option that was clicked. Register for this event to capture the selection result. |
SASS Structure
Development
Other
Go ahead and fork the project! Submit an issue if needed. Have fun!