Commit graph

148 commits

Author SHA1 Message Date
Shelley Vohr
05c50b0a2e
fix docs typo 2017-09-26 21:30:27 -04:00
Shelley Vohr
31bf873c20
add docs update for new api call 2017-09-26 21:14:44 -04:00
Zeke Sikelianos
1811b0cbda fix heading levels for class docs 2017-07-26 13:02:40 -07:00
Fabian Zeindl
5db02ffaa9 updates to the docs 2017-07-24 10:29:45 +02:00
Kevin Sawicki
fb47dc9e48 🎨 2017-06-05 08:55:42 -07:00
Samuel Attard
af09d85125 Update menu.md 2017-06-03 14:50:10 +10:00
Kevin Wojniak
342a8fd577 Add missing word 2017-05-02 09:05:07 -07:00
Kevin Sawicki
e9880e9c97 Merge pull request #8996 from swashcap/master
Add documentation note on dynamic Menu items
2017-04-21 13:44:01 -07:00
Philip Jackson
6169ccd1e2 📝 Document that setApplicationMenu(null) has no effect on macOS 2017-04-04 18:00:20 +12:00
Philip Jackson
1c80102218 📝 Document passing null to Menu.setApplicationMenu
[ci skip]
2017-03-31 16:42:03 +13:00
Zeke Sikelianos
d5bc8990fc link to roles list from Menu doc 2017-03-30 11:08:12 -07:00
Zeke Sikelianos
b24be19fac tighten up formatting of menu example 2017-03-30 11:07:59 -07:00
Cory Reed
a92f639b64 📝 Add note regarding dynamic addition/removal of menu items.
Closes #8928.

[ci skip]
2017-03-23 11:57:44 -07:00
Zeke Sikelianos
69f0cb26e7 use https for all Electron website URLs 2017-02-28 21:19:55 -08:00
Kevin Sawicki
6c6506e5aa Document menu.closePopup 2017-02-22 10:30:28 -08:00
Kevin Sawicki
d686cf77e9 Update menu.popup docs to take options object 2017-02-22 10:30:28 -08:00
Kevin Sawicki
fb08f56fc8 Add forcereload menu item role 2017-02-03 09:39:41 -08:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
88809b0e0b Document reload and toggledevtools roles 2016-11-17 10:57:20 -08:00
Zeke Sikelianos
a7fdd04751 move menu constructor docs to top of file 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
5979dab13c fix some class headings 2016-11-16 09:02:49 -08:00
Samuel Attard
174e51507d Update menu.md 2016-11-11 09:22:55 -08:00
Samuel Attard
11f8923c43 Fix tray and menu docs 2016-11-11 09:22:55 -08:00
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Zeke Sikelianos
619f74fa12 fix Menu example 2016-10-10 23:01:35 -07:00
Samuel Attard
e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Zeke Sikelianos
cc2b95fac3 js → javascript 2016-08-16 14:50:21 -07:00
Zeke Sikelianos
e71280f31c restore js label to orphan code blocks 2016-08-16 14:49:42 -07:00
Kevin Sawicki
11b14f7621 Add zoom items to menu template 2016-08-08 11:09:30 -07:00
Milan Burda
edc1a9614c Add macOS specific speaking roles for MenuItem 2016-08-08 00:02:32 +02:00
Cheng Zhao
b9bcba7abe docs: Do not repeat processes for multiple times in menu.md 2016-08-03 16:08:54 +09:00
Eric
5ae112677b Update menu.md
1. add difference notice
2.  changed `render process` to `main process`
2016-08-03 10:10:56 +08:00
Milan Burda
87c9926fe8 Move Toggle Fullscreen to the bottom of the View menu 2016-08-02 18:08:41 +02:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Luke Page
c365aa85c2 Clarify the default arguments for popup
The null / -1 defaults weren't very helpful, so changed to follow other documentation and write the behaviour if that param is missing.
2016-07-25 13:57:38 +02:00
Zeke Sikelianos
5ab4fd261c 🎨 2016-07-12 21:50:43 -07:00
Zeke Sikelianos
b20606c718 fix heading levels in Menu doc 2016-07-12 21:47:28 -07:00
Kevin Sawicki
4dbdcad05e Remove label/accelerators with role defaults 2016-06-22 14:37:16 -07:00
Leonard Lamprecht
511bf83fe7 Improved wording 2016-06-18 15:28:22 +02:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Machisté N. Quintana
296d49dc56 Make Menu.getApplicationMenu() public
Closes https://github.com/electron/electron/issues/6085
2016-06-16 12:43:01 -07:00
Cheng Zhao
04479b40a7 Merge pull request #6012 from miniak/menu-item-roles
Document 'zoom' role + add missing menu items (Delete / Paste and Match Style / Zoom)
2016-06-13 06:21:53 +00:00
Cheng Zhao
4f1f0add27 docs: Reword the requirement of setApplication Menu 2016-06-13 10:52:12 +09:00
Milan Burda
f5699ad3a6 Document 'zoom' role + add missing menu items (Delete / Paste and Match Style / Zoom) 2016-06-12 19:21:52 +02:00
Greggman
19c9170d6c Document Menu.setApplicationMenu from main process
You can't call Menu.setApplicationMenu until the app is ready.


[ci skip]
2016-06-11 14:09:53 +09:00
Cheng Zhao
1d6f05c9bb Merge branch 'document-fixes-4' of https://github.com/preco21/electron into preco21-document-fixes-4 2016-05-11 09:23:52 +09:00
Nick Taylor
b54af73782 fixed code snippet in menu api documentation. 2016-05-10 22:32:45 +02:00
Plusb Preco
f1b184ef78 📝 Fix code style issue
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco
6e0112bf9f 📝 Cleanup codes
[ci skip]
2016-05-11 01:34:51 +09:00
Plusb Preco
4d7296e1db 📝 Match destructuring style
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco
5787bb0226 📝 Fix code style issue
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.

[ci skip]
2016-05-10 18:42:21 +09:00
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Zeke Sikelianos
0527b17e42 blockquote summaries 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Daniel Pereira
7b56085a0a Update menu.md
There was a missing reference to webContents.
2016-04-14 10:50:08 -05:00
Kevin Sawicki
102f7e8e33 Update docs for new org 2016-04-04 12:05:53 -07:00
Kevin Sawicki
8feb0f0440 Put link on same line as name 2016-03-24 15:57:42 -07:00
Milan Burda
f84c41f684 Fix Menu documentation 2016-03-20 19:05:18 +01:00
Machisté N. Quintana
f47851f1e7 📝 🎨 Hard wrap 2016-03-07 16:19:00 -08:00
Machisté N. Quintana
eb064240f8 📝 Link to OS X Cocoa Event Handling guide on actions 2016-03-07 16:11:58 -08:00
Robert Lyall
6f45678e9c Fix Menu template API example 2016-02-25 18:28:03 +00:00
Belleve Invis
1d629640bf Add link to BrowserWindow::setMenu 2016-02-01 00:28:44 +08:00
Takahito Yamatoya
42493a7ed3 Add Japanes translated docs, improve a doc style. 2016-01-24 19:47:12 +09:00
Cheng Zhao
d1051b55cc docs: Default value of positioningItem 2016-01-22 11:32:14 -07:00
Cheng Zhao
2d8e5e3a16 docs: Default parameter for Menu.popup 2016-01-22 11:29:26 -07:00
Cheng Zhao
ea9b0cfed0 Merge pull request #4192 from evgenyzinoviev/menu-pr
Menu.popup: specify positioning item (OS X)
2016-01-22 10:49:17 -07:00
evgenyzinoviev
072ab0ddea specify positioning item for popup menus 2016-01-22 03:18:27 +01:00
Rose Robertson
859d9763e9 📝 Use correct shortcut for 'Hide Others' menu item example
As per https://support.apple.com/en-gb/HT201236, the correct keyboard shortcut
for hiding all but the current window is Command-Option(Alt)-H.
2016-01-21 14:31:18 -08:00
Wei Wang
7333e403b7 missing "var" in line 201 menu.md
in line 201 at menu.md, 
should be ```var menu = Menu.buildFromTemplate(template);```
2016-01-11 10:47:32 -08:00
Sunny
6d46c3a75e docs: Fix deprecated usage tips 2015-11-23 13:40:23 +08:00
Cheng Zhao
5cacf79bc5 docs: Document the new style of remote module 2015-11-13 22:34:00 +08:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Cheng Zhao
0fb68e8130 Make Menu.popup accept no parameter 2015-09-30 23:41:23 +08:00
Tomáš Hanáček
af5262630a docs: Fix role hideothers, unhide typo 2015-09-11 14:26:48 +02:00
Cheng Zhao
6bce5b560b docs: The "role" attribute of MenuItem 2015-09-02 09:44:01 +08:00
Jessica Lord
95133af0ee y required if x exists 2015-09-01 14:08:42 -07:00
Jessica Lord
e8461b6f90 Capital Ms 2015-08-28 16:35:22 -07:00
Jessica Lord
33a19f9071 Edits and standardization 2015-08-28 16:19:28 -07:00
Craig Shoemaker
d485cfbca3 Fixed typo 2015-07-24 06:53:55 -07:00
Craig Shoemaker
959f5d61b7 Windows/Linux compatibility changes
- Updated accelerator to cross platform values
- Added a warning to non-Mac users regarding the selector option
2015-07-23 15:04:43 -07:00
Cheng Zhao
0819176cb1 Merge branch 'master' of https://github.com/alexwarren/electron into alexwarren-master 2015-06-10 12:39:59 +08:00
Alex Warren
78eff673ec Make consistent with other example 2015-06-09 22:09:23 +01:00
Alex Warren
51dc8ad70a Corrections to menu.md 2015-06-09 22:08:34 +01:00
Thomas Tuts
bd1fd9680f Add missing commas in menu docs 2015-06-09 18:08:27 +02:00
Thomas Tuts
cf79f439ce Remove trailing commas in menu docs 2015-06-09 18:08:02 +02:00
Cheng Zhao
cd0aa4a956 Merge pull request #1389 from atom/rename-to-electron
Rename to electron
2015-04-17 15:22:07 +08:00
Cheng Zhao
d2682233fd docs: Atom Shell => Electron 2015-04-16 11:31:12 +08:00
Cheng Zhao
6137c2317d Improves #1373
* Don't pollute Menu API.
* Add examples in docs.
* Moves the docs from menu-item.md to menu.md.
2015-04-13 11:22:33 +08:00
Kevin Sawicki
6615ef1054 Atom Shell -> Electron 2015-04-08 10:16:10 -07:00
ffdd
31d606220e Add that Menu.setApplication only works after 'ready' event.
I got caught on this while trying to add a menu in my application in OSX.
2014-12-16 21:50:40 -05:00
Joao Moreno
c6a16161d9 Update documentation for Menu.popup() 2014-11-26 15:15:55 +01:00
Kevin Sawicki
9f8ad36f30 📝 Minor grammar tweaks 2014-10-25 16:03:27 -07:00
Cheng Zhao
4509056d5e docs: Add notes on OS X application menu. 2014-09-05 13:39:29 +08:00
Cheng Zhao
444fe8bf1f 📝 Fix the outdated menu example, closed #389. 2014-06-10 13:29:09 +08:00
Cheng Zhao
dd804b090a 📝 Menu.setApplicationMenu is not OS X only. 2014-05-30 09:03:29 +08:00
Cheng Zhao
3d2464c30e 📝 Fix typos regarding to #349. 2014-05-24 10:41:54 +08:00
Cheng Zhao
5933947000 📝 Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00
Renamed from docs/api/browser/menu.md (Browse further)