David Sanders
3d2a754531
chore: extend linting of code blocks in the docs ( #40245 )
...
* chore: extend linting of code blocks in the docs
* chore: combine lint:markdownlint and lint:markdown scripts
2023-11-21 16:50:08 +09:00
Samuel Attard
1a6085e20e
docs: improve globalShortcut and hookWindowMessage types ( #37115 )
2023-02-02 12:31:28 -08:00
Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive ( #31752 )
2021-11-15 22:13:18 -06:00
Jeremy Rose
833baa4c54
fix: throw when using globalShortcut before ready ( #27002 )
2020-12-15 11:13:56 -08:00
Charles Kerr
c83f836faf
refactor: prefer using app.whenReady() ( #21972 )
...
* docs: add references to app.whenReady() in isReady
* refactor: prefer app.whenReady()
In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.
It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
Shelley Vohr
319c2853df
chore: move ts-smoke tests to core ( #16930 )
...
* chore: move ts smoke tests to core
* fix: fix paths for tsconfig / ts-smoke runner
* update ts-defs version
* do not lintr
2019-02-13 15:24:28 -08:00
Shelley Vohr
876064036d
fix: don't register some shortcuts without accessibility ( #16125 )
...
Fixed crash on macOS when using globalShortcut for media keys when accessibility access is not granted.
2019-01-03 20:40:17 -08:00
Shelley Vohr
e9ba26f50e
feat: allow registering multiple shortcuts ( #15542 )
...
This PR allows for multiple global shortcuts to be registered such that triggering any of them calls the same callback.
2018-11-07 09:40:38 -08:00
Samuel Attard
558fff69e7
chore: update to standard 12
2018-09-14 14:57:01 +10:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -08:00
Zeke Sikelianos
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
Samuel Attard
d2a701a465
Document the return values of all methods in the docs
2016-09-25 12:59:30 +13:00
Zeke Sikelianos
06a354a2eb
standardize all javascript blocks in English docs
2016-07-26 09:48:19 -07: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
4d7296e1db
📝 Match destructuring style
...
[ci skip]
2016-05-11 01:26:38 +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
Zeke Sikelianos
b92e86301a
use cross-platform accelerator in globalShorcut documentation
2016-04-01 14:54:25 -07:00
Cheng Zhao
9e254821bb
docs: Mention the limitation of globalShortcut
...
Close #3816 .
2016-01-07 21:28:14 +08:00
Stephen Niedzielski
0b245b96e4
Update docs for globalShortcut.register
...
Document return value for globalShortcut.register and common failure scenario.
Fix : #3600
2015-11-26 22:38:47 -07:00
Cheng Zhao
eac2e7cc61
docs: Update codes in docs to use require('electron')
2015-11-12 21:20:09 +08:00
Steve Kinney
2978beaeb7
💄 Add preposition to globalShortcut.unregisterAll()
2015-10-07 09:03:46 -07:00
Steve Kinney
6f61832a34
💄 Add semicolon to global-shortcut code example
...
This keeps this line consistent with the rest of the documentation.
2015-10-07 09:03:11 -07:00
Jessica Lord
279fd0a461
Standardize **Note:**
2015-09-09 14:09:14 -07:00
Jessica Lord
dbc1855b42
Small edits
2015-08-28 14:21:37 -07:00
Jessica Lord
a34a16653e
Standardize global-shortcut
2015-08-26 17:32:47 -07:00
Jeffrey Morgan
ce24226128
Update global-shortcut.md
...
Improved the grammar and code formatting of global-shortcut.md.
2015-07-14 16:58:15 +01:00
Hank Bao
fc9612a5ed
Fix sample code indention
2015-07-09 22:49:16 +08:00
Hank Bao
fb99bfac52
Update sample code in global-shortcut.md
2015-07-09 17:03:58 +08:00
Hank Bao
7b19b6b4f2
Update global-shortcut.md
...
Make it clear that the `global-shortcut` module should not be used until the ready event of app module gets emitted.
2015-07-09 12:30:37 +08:00
Thomas Tuts
e829a28947
Clean up code in global shortcut code example
2015-06-09 18:01:09 +02:00
Thomas Tuts
13b6ed6dc5
Fix several typos and grammar errors
2015-06-09 16:49:21 +02:00
Sam Saccone
161dc45ec8
📝 Fix english errors and clarify docs
2015-06-06 21:46:51 -04:00
Cheng Zhao
6dc01945af
Make Accelerator a standalone JS type.
...
This makes menu and global-shortcut share the same code on accelerator.
2014-08-05 00:03:58 +08:00
Haojian Wu
681de1b048
📝 Update global-shortcut API document.
2014-08-04 10:11:00 +08:00