- Notifications
You must be signed in to change notification settings - Fork58
A simple vue context menu component.
License
rawilk/vue-context
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
I no longer have the ability or interest in maintaining this package since I am not using Vue in any of my projectsanymore, so I am abandoningvue-context
. If your project depends on vue-context, please feel free to fork and maintainthe package yourself, or use analternative context menu package.
vue-context
provides a simple yet flexible context menu for Vue. It is styled for the standard<ul>
tag, but any menu template can be used.The menu is lightweight with its only dependency beingvue-clickaway
. The menu has some basic styles applied to it, but they can be easilyoverridden by your own styles.
The menu disappears when you expect by utilizingvue-clickaway
and it also optionally disappears when clicked on.
The following instructions will help you get the vue-context menu up and running onyour project.
Using npm:
npm i vue-context
Import the component and use it in your app.
importVuefrom'vue';importVueContextfrom'vue-context';newVue({components:{ VueContext},methods:{onClick(text){alert(`You clicked${text}!`);}}}).$mount('#app');
Next add an element to the page that will trigger the context menu to appear, and also add the context menu to the page.
<divid="app"><div><p@contextmenu.prevent="$refs.menu.open"> Right click on me</p></div><vue-contextref="menu"><li><ahref="#"@click.prevent="onClick($event.target.innerText)">Option 1</a></li><li><ahref="#"@click.prevent="onClick($event.target.innerText)">Option 2</a></li></vue-context></div>
Notice: As of version4.1.0, the menu styles are not automatically included by default anymore.You will need to manually import them now in your own stylesheets.
@import'~vue-context/dist/css/vue-context.css';// Or@import'~vue-context/src/sass/vue-context';
For full documentation, go here:https://randallwilk.dev/docs/vue-context.
If you would like to contribute to the documentation, you can edit the docs found here:https://github.com/rawilk/vue-context/tree/master/docs
This project exists thanks to all the people who contribute.[Contribute].
Seeawesome-vue for other alternatives.
vue-context
uses the MIT License (MIT). Please see thelicense file for more information.
About
A simple vue context menu component.