mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update menu-item with new position props (#14465)

Browse source 
* docs: Update menu-item with new position props

* 📦 Update electron-typescript-definitions
This commit is contained in:
Felix Rieseberg 2018-09-09 20:03:58 -07:00 committed by Shelley Vohr
parent 72526927d9
commit f012ed8357
3 changed files with 1875 additions and 1865 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api/menu-item.md
View file

@ -27,14 +27,24 @@ See [`Menu`](menu.md) for examples.
* `visible` Boolean (optional) - If false, the menu item will be entirely hidden. * `visible` Boolean (optional) - If false, the menu item will be entirely hidden.
* `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type * `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type
menu items. menu items.
* `submenu` (MenuItemConstructorOptions[] | [Menu](menu.md)) (optional) - Should be specified for `submenu` type menu items. If * `submenu` (MenuItemConstructorOptions[] | [Menu](menu.md)) (optional) - Should be specified
`submenu` is specified, the `type: 'submenu'` can be omitted. If the value for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
is not a [`Menu`](menu.md) then it will be automatically converted to one using If the value is not a [`Menu`](menu.md) then it will be automatically converted to one using
`Menu.buildFromTemplate`. `Menu.buildFromTemplate`.
* `id` String (optional) - Unique within a single menu. If defined then it can be used * `id` String (optional) - Unique within a single menu. If defined then it can be used
as a reference to this item by the position attribute. as a reference to this item by the position attribute.
* `position` String (optional) - This field allows fine-grained definition of the * `before` String[] (optional) - Inserts this item before the item with the specified label. If
specific location within a given menu. the referenced item doesn't exist the item will be inserted at the end of the menu. Also implies
that the menu item in question should be placed in the same “group” as the item.
* `after` String[] (optional) - Inserts this item after the item with the specified label. If the
referenced item doesn't exist the item will be inserted at the end of
the menu.
* `beforeGroupContaining` String[] (optional) - Provides a means for a single context menu to declare
the placement of their containing group before the containing group of the item
with the specified label.
* `afterGroupContaining` String[] (optional) - Provides a means for a single context menu to declare
the placement of their containing group after the containing group of the item
with the specified label.
### Roles ### Roles

3716
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

4
package.json
View file

@ -13,7 +13,7 @@
"dugite": "^1.45.0", "dugite": "^1.45.0",
"electabul": "~0.0.4", "electabul": "~0.0.4",
"electron-docs-linter": "^2.3.4", "electron-docs-linter": "^2.3.4",
"electron-typescript-definitions": "^1.3.6", "electron-typescript-definitions": "^2.0.0",
"github": "^9.2.0", "github": "^9.2.0",
"html-entities": "^1.2.1", "html-entities": "^1.2.1",
"husky": "^0.14.3", "husky": "^0.14.3",
@ -60,7 +60,7 @@
"lint:docs": "remark docs -qf && npm run lint:js-in-markdown && npm run create-typescript-definitions && npm run lint:docs-relative-links", "lint:docs": "remark docs -qf && npm run lint:js-in-markdown && npm run create-typescript-definitions && npm run lint:docs-relative-links",
"lint:docs-relative-links": "python ./script/check-relative-doc-links.py", "lint:docs-relative-links": "python ./script/check-relative-doc-links.py",
"lint:js-in-markdown": "standard-markdown docs", "lint:js-in-markdown": "standard-markdown docs",
"create-api-json": "electron-docs-linter docs --outfile=out/electron-api.json --version=$npm_package_version", "create-api-json": "electron-docs-linter docs --outfile=out/electron-api.json --version=4.0.0-nightly.20180823",
"create-typescript-definitions": "npm run create-api-json && electron-typescript-definitions --in=out/electron-api.json --out=out/electron.d.ts", "create-typescript-definitions": "npm run create-api-json && electron-typescript-definitions --in=out/electron-api.json --out=out/electron.d.ts",
"mock-release": "node ./script/ci-release-build.js", "mock-release": "node ./script/ci-release-build.js",
"preinstall": "node -e 'process.exit(0)'", "preinstall": "node -e 'process.exit(0)'",