Socket
Socket
Sign inDemoInstall

electron-menus

Package Overview
Dependencies
326
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    electron-menus

Easily add menus to modules running in Electron.


Version published
Maintainers
1
Install size
35.4 MB
Created

Readme

Source

Electron menus

js-standard-style

Add native menu items to renderer-side projects from the browser-side.

Installation

npm install --save electron-menus

Usage


var menus = require('electron-menus')

menus.set(__dirname + '/index.html')
set menus.set(pathToIndexFile[, menuDefinition][, settings])

Takes a pathToIndexFile, an optional menuDefinition to use, if not provided will default to menus/default.js (see that file and Electron menu documentation for more on what that array should look like) and an optional settings argument with the following defaults:

{
  id: 'ELECTRON-menus' // The id of the script tag to inject the menu definition into,
  replace: false // If a script tag of the above id already exists, should it replace its contents or leave it alones
}

Reasoning

Loading a flat file web app into Electron is quite easy, you would either hardcode those files, or, better yet, include that project as a module and point your window.loadUrl method at it.

The problem is that web app knows nothing about the native desktop context it is now in. And because basic elements like menu items, which enable Copy and Paste, must be defined on the Renderer side, your web app will feel powerless in its new environment.

You might not want to hardcode the required menu JavaScript into your web app, though if, for instance, you're using that code in multiple contexts and don't want to disable certain blocks when running in a browser versus Electron.

This module lets you inject the necessary JavaScript into the web app's index.html file.

Keywords

FAQs

Last updated on 28 Jul 2015

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc