Commit graph

91 commits

Author SHA1 Message Date
Mikhail Leliakin
56b5c00312
feat: add BrowserWindow.showAllTabs() for macOS () 2023-07-10 10:43:37 +02:00
David Sanders
4415b7638a
chore: enforce consistent Markdown style for strong and emphasis () 2023-04-03 13:20:10 +02:00
Milan Burda
fdab0799fe
docs: only macOS 10.13+ is supported now ()
Co-authored-by: Milan Burda <miburda@microsoft.com>
2023-02-15 16:29:02 -08:00
David Sanders
a9c03950c0
docs: cleanup reference links () 2023-01-11 22:16:34 -08:00
flynow10
ad289d120f
docs: fixed MenuItem documentation to use the same formatting for all role options ()
Fixed MenuItem documentation

Some of the items in the list of possible roles were formatted differently, which made it harder to read.
Sorry if this was intended, but I found it easier to read with them all formatted the same.
2022-10-24 14:51:50 -04:00
Harshil jain
d657cd8ed6
docs: Remove the latin words from doc () 2022-01-28 12:40:20 -08:00
Mitchell Cohen
5af6b898d9
feat: add Substitutions menu roles on macOS () 2022-01-06 10:41:28 -08:00
Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive () 2021-11-15 22:13:18 -06:00
Anders Kaseorg
1c95d30c0f
fix: Add missing items to menuItem.role documentation () 2021-07-28 08:45:06 +02:00
Samuel Attard
da9261497e
feat: add MenuItem.userAccelerator property ()
* feat: add MenuItem.userAccelerator property

This allows folks to read the user-assigned accelerator that macOS users can provide in system preferences. Useful for showing in-app shortcut help dialogs, you need to know if the accelerator you provided is not being used in favor of a user assigned one.

* chore: update syntax

* chore: add safety check for command index being -1
2021-06-29 16:28:16 -07:00
Cheng Zhao
bb3fb548d8
feat: add APIs to enable/disable spell checker ()
* feat: add APIs to enable/disable bulitin spell checker

* feat: add togglespellchecker menu item role
2020-11-11 10:29:18 -05:00
David Sanders
43dbd1bdf8
chore: cleanup whitespace in docs () 2020-11-05 14:12:43 -08:00
Cheng Zhao
6b6ffbdd10
feat: add support for share menu on macOS () 2020-10-19 18:33:06 -07:00
Shelley Vohr
a54fcde3f4
docs: fix MenuItem click handler type () 2020-06-17 10:34:25 -07:00
Shelley Vohr
78d74bf8b4
fix: trigger about panel for about role on on win () 2020-05-21 15:38:26 -07:00
szTheory
c68589f212
docs: menu-item.md remove duplicate options () 2020-04-27 12:05:58 -07:00
Charles Kerr
33ef0d23a6
docs: minor grammar & spelling fixes ()
* docs: fix minor grammar error 'punctuations'

* docs: fix minor grammar error pluralizing Chromium

* docs: fix typo 'updateCurrentActiviy'

* docs: use consistent spelling of 'behavior'

* docs: use 'macOS' instead of 'Mac OS' or 'OS X'.

* docs: use 'GTK' instead of 'GTK+'

https://mail.gnome.org/archives/gtk-devel-list/2019-February/msg00000.html

* docs: minor capitalization: use 'TCP' not 'tcp'

* Update docs/development/build-instructions-linux.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

Co-authored-by: Mark Lee <malept@users.noreply.github.com>
Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
2020-03-31 13:06:25 +09:00
Shelley Vohr
38947f43de docs: menu item labels are not dynamic () 2020-01-20 15:44:22 +09:00
liulun
3d2fa09db3 Two 'close' in this line () 2019-12-02 18:30:56 +09:00
Shelley Vohr
a5f87cee6b
doc: add missing MenuItem roles () 2019-07-31 14:13:56 -07:00
Micha Hanselmann
06d48514c6 add toolTip property for MenuItem () 2019-07-11 17:56:22 +09:00
Shelley Vohr
1a6a16e346
docs: fix platform location for params () 2019-06-27 14:51:18 -07:00
Micha Hanselmann
819cebff5d change menu item docs () 2019-06-26 20:20:04 -07:00
evelyn masso
45f5f2ba1a docs: add specific options for MenuItem.role () 2019-06-14 14:13:42 -07:00
Shelley Vohr
554ee92b39
docs: specify use case for the 'services' role ()
* docs: specify use case for the 'services' role

* update based on @caesar's recommendation

Co-Authored-By: Caesar Schinas <caesar@caesarschinas.com>
2019-05-30 14:33:48 -07:00
Samuel Attard
a96b6e2c96 build: move to the new docs parser ()
* build: move to the new docs parser

* chore: remove the bad getTitle param doc

* build: update parser/ts gen deps + fix some docs issues highlighted by GH desktop

* chore: apply suggestions from code review

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>

* chore: update docs for accidentally removed things

* chore: update docs/api/command-line.md

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
2019-05-06 08:29:01 -07:00
nixxquality
4556433f3b docs: fully document MenuItem instance properties ()
* document menuItem instance properties

* correct some types

* add correct click documentation
2019-04-24 09:53:15 -07:00
Shelley Vohr
544d8a423c
feat: allow MenuItems to work optionally when hidden ()
* feat: allow MenuItems to work optionally when hidden

* fix: actually include forward_declaration
2019-02-28 17:00:54 +00:00
Sindre Sorhus
df5305d6a7 docs: fix MenuItem windowMenu role description ()
It was changed in https://github.com/electron/electron/pull/15930
2019-02-25 13:34:32 +00:00
Samuel Attard
3b74837020 refactor: Split 'Event' docs/types into more specific Event types ()
* Event = Base event type (with preventDefault)
* IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.)
* IpcRendererEvent = Event that ipcRenderer emits (with sender,
senderId, etc.)
* KeyboardEvent = Event that we emit with keyboard flags (ctrlKey,
altKey, etc.)

This will dramatically improve peoples TS experience with IPC events
2019-02-19 09:24:19 +00:00
Samuel Attard
01c442de64 refactor: convert more files to typescript () 2019-02-12 04:22:33 -10:00
Milan Burda
eb02a422de feat: add fileMenu / viewMenu / appMenu roles () 2019-01-10 14:32:03 +01:00
Mosh Feu
ddc38eda26 docs: specify "role" types for "menu-item" () 2018-12-19 09:39:35 -05:00
Heilig Benedek
0242818f39 feat: add registerAccelerator flag to allow menu items to optionally skip accelerator registration ()
* feat: add registerAccelerator flag to allow menu items to skip registration

* docs: add docs for registerAccelerator

* docs: re-add accidentally removed line
2018-11-26 10:43:55 -08:00
Shelley Vohr
2bd94293e0 doc: clarify menu item properties not available top-level () 2018-10-29 15:04:25 -05:00
Felix Rieseberg
f012ed8357 docs: Update menu-item with new position props ()
* docs: Update menu-item with new position props

* 📦 Update electron-typescript-definitions
2018-09-09 20:03:58 -07:00
Troy
5ea05ddee7 fix: Stricter Testing For Menu Items ()
This PR includes stricter testing for empty objects so that false context menus are not created along with the tests to ensure future compatibility.
2018-08-17 13:10:14 -07:00
Tiago Danin
1fd6d38a0a docs: Improved documentation () 2018-07-20 10:58:19 -07:00
Zhuo Lu
d45914c3f7 MenuItem roles camelCase-compatible 2017-12-28 13:28:20 +08:00
Toinane
323ea2b27b
fix(docs): fix all missing dots and add some links 2017-11-29 11:38:35 +01:00
Toinane
59607c9a17
feat(docs): fix 'optional' wording 2017-11-28 18:15:15 +01:00
Zhuo Lu
2f73f4f77e Fix typo 2017-11-27 17:26:22 +09:00
Zhuo Lu
2de7b338ad Update API docs 2017-11-27 17:26:22 +09:00
Zhuo Lu
970babbfd7 Document openrecent menu item 2017-11-27 17:26:22 +09:00
Michael Kaylan
7741a0e6ad 🍎 Add roles for macOS native tab menu items
Fixes , .
2017-08-15 11:30:39 -04:00
Fabian Zeindl
5db02ffaa9 updates to the docs 2017-07-24 10:29:45 +02:00
Kevin Sawicki
f6bbcc6efa Fix typos 2017-04-26 13:03:15 -07:00
Zeke Sikelianos
d779ecf674 create a linkable heading for MenuItem roles 2017-03-30 11:07:25 -07:00
mst128256
9e471d8f1c Added specs 2017-03-24 12:14:08 +01:00
mst128256
8aba640250 added default menu items for 'Edit' and 'Window' 2017-03-09 16:01:33 +01:00