readme.md

electron-context-menu

Context menu for your Electron app

Electron doesn't have a built-in context menu. You're supposed to handle that yourself. But it's both tedious and hard to get right. This module gives you a nice extensible context menu with items like Cut/Copy/Paste for text, Save Image for images, and Copy Link for links. It also adds an Inspect Element menu item when in development to quickly view items in the inspector like in Chrome.

You can use this module directly in both the main and renderer process.

Install

$ npm install electron-context-menu

Requires Electron 4 or later.

Usage

const {app, BrowserWindow} = require('electron');
const contextMenu = require('electron-context-menu');

contextMenu({
	prepend: (params, browserWindow) => [{
		label: 'Rainbow',
		// Only show it when right-clicking images
		visible: params.mediaType === 'image'
	}]
});

let mainWindow;
(async () => {
	await app.whenReady();
	mainWindow = new BrowserWindow();
})();

API

contextMenu([options])

options

Type: Object

window

Type: BrowserWindow | WebView

Window or WebView to add the context menu to.

When not specified, the context menu will be added to all existing and new windows.

prepend

Type: Function

Should return an array of MenuItem's to be prepended to the context menu. The first argument is an array of default actions that can be used. The second argument is this params object. The third argument is the BrowserWindow the context menu was requested for.

append

Type: Function

Should return an array of MenuItem's to be appended to the context menu. The first argument is an array of default actions that can be used. The second argument is this params object. The third argument is the BrowserWindow the context menu was requested for.

showCopyImageAddress

Type: boolean
Default: false

Show the Copy Image Address menu item when right-clicking on an image.

showSaveImageAs

Type: boolean
Default: false

Show the Save Image As… menu item when right-clicking on an image.

showInspectElement

Type: boolean
Default: Only in development

Force enable or disable the Inspect Element menu item.

labels

Type: Object
Default: {}

Overwrite labels for the default menu items. Useful for i18n.

Format:

labels: {
	cut: 'Configured Cut',
	copy: 'Configured Copy',
	paste: 'Configured Paste',
	save: 'Configured Save Image',
	saveImageAs: 'Configured Save Image As…'
	copyLink: 'Configured Copy Link',
	copyImageAddress: 'Configured Copy Image Address',
	inspect: 'Configured Inspect'
}

shouldShowMenu

Type: Function

Determines whether or not to show the menu. Can be useful if you for example have other code presenting a context menu in some contexts. The second argument is this params object.

Example:

// Doesn't show the menu if the element is editable
shouldShowMenu: (event, params) => !params.isEditable

menu

Type: Function

This option lets you manually pick what menu items to include. It's meant for advanced needs. The default menu with the other options should be enough for most use-cases, and it ensures correct behavior, for example, correct order of menu items. Prefer the append/prepend options instead of menu whenever possible.

The function passed this options is expected to return MenuItem[]. The first argument the function receives is an array of default actions that can be used. These actions are functions that can take an object with a transform property (except for separator and inspect). The transform function will be passed the content of the action and can modify it if needed.

Even though you include an action, it will still only be shown/enabled when appropriate. For example, the saveImage action is only shown when right-clicking an image.

The following options are ignored when menu is used:

• showCopyImageAddress
• showSaveImageAs
• showInspectElement

Default actions:

• separator
• cut
• copy
• paste
• saveImage
• saveImageAs
• copyImageAddress
• copyLink
• inspect

Example:

menu: actions => [
	actions.copyLink({
		transform: content => `modified_link_${content}`
	}),
	actions.separator(),
	{
		label: 'Unicorn'
	},
	actions.separator(),
	actions.copy({
		transform: content => `modified_copy_${content}`
	}),
	{
		label: 'Invisible',
		visible: false
	},
	actions.paste({
		transform: content => `modified_paste_${content}`
	})
]

Related

• electron-util - Useful utilities for developing Electron apps and modules
• electron-debug - Adds useful debug features to your Electron app
• electron-store - Save and load data like user preferences, app state, cache, etc
• electron-reloader - Simple auto-reloading for Electron apps during development
• electron-serve - Static file serving for Electron apps
• electron-unhandled - Catch unhandled errors and promise rejections in your Electron app

License

MIT © Sindre Sorhus