Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
vanilla-context-menu
Advanced tools
Readme
vanilla-context-menu
- easily create context-menus using Vanilla JavaScript and integrate them in any web application
<script src="https://unpkg.com/vanilla-context-menu@1.4.1/dist/vanilla-context-menu.js"></script>
Where @1.4.1
is the version that you want to use.
Then anywhere in your JavaScript code you can access the library with window.VanillaContextMenu
or simply VanillaContextMenu
.
npm i vanilla-context-menu
Then anywhere in your code.
import VanillaContextMenu from 'vanilla-context-menu';
new VanillaContextMenu({
scope: document.querySelector('main'),
menuItems: [
{
label: 'Copy',
callback: () => {
// your code here
},
},
'hr',
{
label: 'Paste',
callback: pasteFunction,
},
{
label: 'Cut',
callback: pasteFunction,
iconClass: 'fa fa-scissors', // this only works if you have FontAwesome icons
},
{ label: 'Face', iconHTML: `<span class="material-icons">face</span>` // this only works if you have Google Material Icons icons },
],
});
VanillaContextMenu(configurableOptions: ConfigurableOptions):VanillaContextMenu
ConfigurableOptions
Option | Required | Type | Default | Description |
---|---|---|---|---|
scope | yes | HTMLElement | undefined | The HTML element on which you want to bind the contextmenu event listener. |
menuItems | yes | MenuItem[] | undefined | Menu items to be built. |
customClass | no | string | undefined | A custom CSS class that can be added to the context menu |
customThemeClass | no | string | undefined | A custom CSS class that can be added to the context menu theme. A value for this property will exclude the theme option. |
preventCloseOnClick | no | boolean | false | If this variable is true , then the context menu will not close when its elements are clicked. |
transitionDuration | no | number | 200 | Duration of the context menu transition. Set this value to 0 if you want to disable the animation. |
theme | no | 'black' | 'white' | black | By default, the library provides two themes for the context menu: black and white . You can use this option to choose the one you want to use. |
normalizePosition | no | boolean | true | If true, the position of the contextmenu is bound to the scope. Otherwise the left top corner of the contextmenu is bound to the mouse position. |
MenuItem
type MenuItem = MenuOption | 'hr';
MenuOption
Option | Required | Type | Default | Description |
---|---|---|---|---|
label | yes | string | undefined | Menu option label. |
iconClass | no | string | undefined | This property can be used to display an optional icon. It presents the CSS classes that will be added for the <i></i> tag. |
iconHTML | no | string | undefined | This property can be used to display an optional icon. It presents an HTML string that will be sanitized internally using DOMPurify. |
callback | no | (ev:MouseEvent) => any | undefined | Callback to be executed. The parameter ev is the MouseEvent that occurred when the contextmenu event was triggered |
preventCloseOnClick | no | boolean | false | If this variable is true , then the context menu will not close when this menu option is clicked. A value set for this option, either true or false will override the global one. |
nestedMenu | no | NestedMenuItem[] | undefined | Nested menu to be built. |
NestedMenuItem
export type NestedMenuItem = BaseMenuOption | 'hr';
export interface BaseMenuOption {
label: string;
callback?: (ev: MouseEvent) => unknown;
iconClass?: string;
iconHTML?: string;
preventCloseOnClick?: boolean;
}
The following methods and properties are available through the class instance.
const myContextMenu = new VanillaContextMenu(...)
(1)
off(): void
This method will remove all event listeners that have been registered for the context-menu.
! It should be called when you want to deactivate the context menu or when the container item has been removed from the DOM.
(2)
updateOptions(configurableOptions: Partial<ConfigurableOptions>): void
(3)
close(): void
This method closes the context-menu.
.context-menu-orange-theme {
background: #d35400;
hr {
background-color: #eee;
}
// text color for each item
& > *:not(hr) {
color: #eee;
&:hover {
background: #e67e22;
}
}
}
.custom-context-menu-cls {
width: 100px !important;
font-family: 'Roboto', sans-serif; /* DEFAULT -- font-family: 'Open Sans', sans-serif; */
}
const myContextMenu = new window.VanillaContextMenu({
scope: ...,
menuItems: [...],
customThemeClass: 'context-menu-orange-theme',
customClass: 'custom-context-menu-cls',
});
Firstly you need to add an icon library inside your application and then you can use the iconClass
property to specify the CSS classes that will be added for the <i></i>
tag.
The following example will add a FontAwesome scissors icon near the menu option Cut.
new VanillaContextMenu({
scope: document.querySelector('main'),
menuItems: [
{
label: 'Cut',
callback: pasteFunction,
iconClass: 'fa fa-scissors', // this only works if you have FontAwesome icons
},
],
});
You can check the demo
file for more examples from demo/index.html.
Pull requests and stars are always welcome. Please check the guidelines.
For project updates you can also reference the changelog.
This project is licensed under the MIT License
FAQs
Easily create context menus using vanilla JavaScript and integrate them in any web application
The npm package vanilla-context-menu receives a total of 402 weekly downloads. As such, vanilla-context-menu popularity was classified as not popular.
We found that vanilla-context-menu demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.