{"id":17736699,"url":"https://github.com/parro-it/electron-contextmenu-middleware","last_synced_at":"2025-09-03T09:32:58.327Z","repository":{"id":57221600,"uuid":"53440023","full_name":"parro-it/electron-contextmenu-middleware","owner":"parro-it","description":"Build electron context menus composing multiple middlewares functions.","archived":false,"fork":false,"pushed_at":"2020-06-03T09:20:52.000Z","size":90,"stargazers_count":49,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-09T08:09:05.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/parro-it.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-08T19:41:52.000Z","updated_at":"2022-03-22T06:42:04.000Z","dependencies_parsed_at":"2022-08-29T04:01:55.752Z","dependency_job_id":null,"html_url":"https://github.com/parro-it/electron-contextmenu-middleware","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parro-it%2Felectron-contextmenu-middleware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parro-it%2Felectron-contextmenu-middleware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parro-it%2Felectron-contextmenu-middleware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parro-it%2Felectron-contextmenu-middleware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parro-it","download_url":"https://codeload.github.com/parro-it/electron-contextmenu-middleware/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251790400,"owners_count":21644214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-26T00:24:07.174Z","updated_at":"2025-04-30T22:23:50.293Z","avatar_url":"https://github.com/parro-it.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-contextmenu-middleware\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/parro-it/electron-contextmenu-middleware.svg)](https://greenkeeper.io/)\n\n\u003e Build `electron` context menus composing multiple middlewares functions.\n\n[![Travis Build Status](https://img.shields.io/travis/parro-it/electron-contextmenu-middleware.svg)](http://travis-ci.org/parro-it/electron-contextmenu-middleware)\n[![NPM module](https://img.shields.io/npm/v/electron-contextmenu-middleware.svg)](https://npmjs.org/package/electron-contextmenu-middleware)\n[![NPM downloads](https://img.shields.io/npm/dt/electron-contextmenu-middleware.svg)](https://npmjs.org/package/electron-contextmenu-middleware)\n\nThis package born because I've published two other\nnpm packages for electron that provide different context menu for DOM element.\n\n`electron-input-menu` provide Copy\u0026Paste stuff for `input` element, while `debug-menu` provide a Chrome-like \"inspect element\" menu for `electron`.\n\nThey both work well on their own, but if you want to use them together you can only shown one menu or the other, because they `preventDefault` the contextmenu event. If you remove the `preventDefault` call, then you get both, in sequence.\n\n`electron-contextmenu-middleware` grab menus provided by various other packages (the `middlewares` ones) merge them in a single menu, and `popup` it.\n\n\n# Installation\n\n```bash\nnpm install --save electron-contextmenu-middleware\n```\n\n# Usage\n\n```js\n  // in a renderer electron process,\n  // you want to activate context menu provided\n  // by `electron-input-menu` and `debug-menu`\n\n  const context = require('electron-contextmenu-middleware');\n\n  const input = require('electron-input-menu');\n  const debug = require('debug-menu').middleware;\n\n  context.use(input);\n  context.use(debug);\n  context.activate();\n```\n\n# Write a middleware\n\nTo write a `middleware` menu, just export a function\nthat receives an option object and a next function.\n\nThe option object is composed by the right-clicked DOM element, the click x and y coord, and an array of `electron` menu item templates.\n\nAppend or insert your menu items to the array in the position you want (or remove existing items inserted by other middlewares) and call `next` when done.\n\n\n```js\nexport default function ({elm, menu, click}, next) {\n  menu.push({\n    label: 'Inspect element',\n    click: () =\u003e {\n      require('electron').remote\n        .getCurrentWindow()\n        .inspectElement(\n          click.x,\n          click.y\n        );\n    }\n  });\n}\n```\n\n\n# Related projects\n\n* [electron-input-menu](https://github.com/parro-it/electron-input-menu) - Context menu for [electron](https://github.com/atom/electron) input elements.\n\n* [debug-menu](https://github.com/parro-it/debug-menu) - Chrome-like \"inspect element\" context-menu.\n\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2016 parro-it\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparro-it%2Felectron-contextmenu-middleware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparro-it%2Felectron-contextmenu-middleware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparro-it%2Felectron-contextmenu-middleware/lists"}