webext-menus
A library helping you create dynamic menus in webextensions. Used by Image Picka.
Installation
Via npm
npm install webext-menus
const webextMenus = ;const menus = ;
Pre-built dist
You can find it under the dist
folder, or download from unpkg.
Compatibility
If the browser supports the visible
property when creating the menu item, the library update the item when oncontext
is changed.
Otherwise, the library destroy/recreate the item to hide/show the menu.
API reference
This module exports a single function to initialize a dynamic menu.
webextMenus
void
options
is an array of property object for menus.create. The property object may contain following properties:
- Any property used by
browser.menus.create
. checked
- function, which should return a boolean indicating whether the menu item should be checked. Ifchecked
is not a function, it is considered static.oncontext
- function, optional.oncontext
should return a boolean indicating whether the menu item should be shown.
useVisible
decides whether to hide menu items by updating the visible
property. If false
, it will remove/recreate the menu item to mimic hide/show effect. If undefined
or null
, it will use the visible
property if supported.
Note: There is an empty menu bug in Chrome so I suggest setting this argument to
false
.
The function returns an object with an update
method. When called, it invokes each item's oncontext
/checked
and show/hide/toggle the menu item.
update
is usually hooked to a change
event. For example:
// assume there is a preference libraryconst menus = ;pref;
Todos
- What will happen to sub-items if the parent is removed?
Changelog
-
0.3.2 (Feb 17, 2020)
- Fix: assign a unique ID to the menu item.
-
0.3.1 (Feb 17, 2020)
- Fix: the package doesn't include dist folder.
-
0.3.0 (Feb 17, 2020)
- Breaking: rewrite.
- Breaking: don't throw load time error. Now calling the API may throw if the enviroment doesn't support menus (e.g. Firefox Android).
- Add:
useVisible
argument.
-
0.2.0 (Dec 23, 2019)
- Add: use
visible
property if possible. - Fix: support Chrome without polyfill.
- Add: use
-
0.1.3 (May 13, 2018)
- Add: Chrome compatibility.
-
0.1.2 (Jan 18, 2018)
- Fix: dynamic checked.
-
0.1.1 (Jan 17, 2018)
- Add: dynamic checked.
-
0.1.0 (Jan 17, 2018)
- First release.