Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive ( #31752 )
2021-11-15 22:13:18 -06:00
Erick Zhao
18a76c6b9d
docs: uniformize module API doc format ( #28920 )
...
This PR ensures that all API modules are present in the README doc,
as there were a couple missing. It also formats all modules to contain
a level-1 heading and a blockquote description.
2021-04-29 09:56:31 +02:00
David Sanders
43dbd1bdf8
chore: cleanup whitespace in docs ( #26356 )
2020-11-05 14:12:43 -08:00
Alfred Xing
a23c66e4e1
feat: allow monospaced font styles to be specified for macOS tray titles ( #25059 )
...
* feat: add optional font type to macOS tray title
* test: add tests for tray font type
* docs: update API reference for Tray setTitle
* review: change API to use an options object
* review: fix string enum in docs
Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>
* review: return after throwing errors
* review: don't need thrower anymore now that we have args
Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>
2020-08-23 14:39:29 -07: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
bitdisaster
89eb309d0b
feat: allow GUID parameter to avoid systray demotion on Windows ( #21891 )
...
* fix: systray icon demotion
Adding support for GUID parameter in Tray API.
In combination with signed binaries this allows to maintain
the position in the systray on Windows.
* unit tests
* make mac and linux compile
2020-01-31 14:37:03 +09:00
Shelley Vohr
b90537a629
feat: add tray.closeContextMenu() ( #21807 )
2020-01-22 15:25:17 -08:00
Shelley Vohr
5c6f9a6947
feat: add mouse-down & mouse-up to Tray ( #21795 )
2020-01-17 16:28:34 +00:00
Milan Burda
03debb4ef9
feat: add tray.focus() ( #19548 )
2019-08-09 07:43:48 -07:00
Milan Burda
0fb3c8cb7c
feat: add new options to tray.displayBalloon() ( #19544 )
2019-08-08 14:43:33 -07:00
Milan Burda
ee674acca4
feat: add tray.removeBalloon() ( #19547 )
2019-08-05 08:52:47 -07:00
Micha Hanselmann
47a38daee2
feat: migrate custom macOS tray view to native one ( #18981 )
...
* restore stash
revert
some things work others dont
tracking area for rescue
manual popup
restore drag n drop
cleanup
* fix: make tray not block main process (#18880 )
* fix: make tray not block main process
* make AtomMenuModel refcounted
* add support for ansi codes in title
add remove TODOs
* chore: use ScopedPumpMessagesInPrivateModes in tray (#18977 )
* chore: use ScopedPumpMessagesInPrivateModes in tray
* revert refcounting of AtomMenuModel
* Prefer WeakPtr for posting tasks to handle unexpected destruction
* cleanup .h
* cleanup .mm
* add imports
add missing include
* fix: crash when tray popup called twice (#18999 )
* remove highlightMode and TODOs
* remove unnecessary copy
2019-07-31 10:52:50 -07:00
Micha Hanselmann
2467350180
feat: support mouse-move
event of Tray API on Windows ( #19265 )
...
* add Tray.mouse-move on win
* change docs
2019-07-18 10:52:15 -07:00
Micha Hanselmann
1f70dfbffd
chore: deprecate setHighlightMode ( #19202 )
2019-07-11 10:11:46 -05:00
Samuel Attard
a96b6e2c96
build: move to the new docs parser ( #18103 )
...
* 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
Shelley Vohr
2fb9085e5b
feat: add tray.getTitle() ( #17385 )
...
* feat: add tray.getTitle
* fix spec
2019-03-18 12:40:34 -07:00
Samuel Attard
3b74837020
refactor: Split 'Event' docs/types into more specific Event types ( #17038 )
...
* 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
558fff69e7
chore: update to standard 12
2018-09-14 14:57:01 +10:00
Milan Burda
a08ca9defb
fix: don't crash on tray.setContextMenu(null) ( #14322 )
2018-08-27 11:58:47 -05:00
Milan Burda
aacbd76baa
docs: fix electron.d.ts typings ( #13841 )
2018-07-30 11:11:23 +10:00
Shelley Vohr
f068ed9ee7
fix docs formatting for ts defs ( #12968 )
2018-05-16 14:59:44 -07:00
mikeykhalil
3aba515bbc
update docs for getIgnoreDoubleClickEvents method
2018-05-03 13:49:33 -07:00
mikeykhalil
664e14b91f
fixed typo found in code review
2018-05-03 13:49:32 -07:00
mikeykhalil
e1dcd79e48
updated Tray API docs to include new setIgnoreDoubleClickEvents method
2018-05-03 13:49:32 -07:00
Charles Kerr
6beaafc7e5
Merge pull request #11282 from Toinane/fix-documentation
...
typographical revision in Documentation
2017-12-03 09:01:24 -06: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
Sebastien Bramille
7a8431086c
Update doc
2017-11-28 15:34:13 +09:00
Robin Andersson
08845c9903
Removed incorrect optional labels from tray.displayBalloon(options) docs
2017-10-26 20:21:09 +02:00
Sean Bannigan
0b205019b6
add mouse-move event and click event position for tray
2017-10-05 11:41:08 +09:00
Kevin Sawicki
70544440f9
Add location and keyboard modifiers to tray mouse events
2017-06-28 12:10:24 -07:00
Kevin Sawicki
2406d6c279
Rename to mouse-leave for consistency with drag-leave
2017-06-28 11:40:21 -07:00
Shubham
8dbb8ccbab
add mouse-enter and mouse-exit events for tray
2017-06-14 18:00:29 -04:00
Milan Burda
568454525d
Use point / size / rectangle structures consistently in API docs
2017-04-04 08:31:09 +02:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -08:00
Samuel Attard
06960704c4
Update docs for dts again
2016-11-25 23:17:31 +11:00
Zeke Sikelianos
5979dab13c
fix some class headings
2016-11-16 09:02:49 -08:00
Alexandre
6f8eb282b7
[ci skip] Correct Linux limitation example
2016-11-15 21:53:54 +01: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
Long Nhat Nguyen
c017a7a1c7
Update url ( #7598 )
...
* Update EventEmitter URL
* Update EventEmitter URL
* Enable click
* Update EventEmitter URL
* Update EventEmitter URL
* Update URL
* Update URL
* Update EventEmitter URL
* Tweak sentence and add perios
2016-10-13 14:09:14 -07:00
Samuel Attard
4d49156dac
Rename bounds -> rectangle
2016-10-08 13:09:31 +11:00
Samuel Attard
b859afc118
Update docs to follow the 'link first instance' standard
2016-10-06 12:19:38 -07:00
Samuel Attard
03979936f3
Move reused object structures to a standard structures folder
2016-10-06 11:59:42 -07:00
Milan Burda
9f342ebbd1
Add missing documentation
2016-10-06 11:30:34 +02: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
e91dc83b2c
capitalize
2016-08-25 17:26:57 -07:00
Zeke Sikelianos
5619558689
document some missing parameters
2016-08-25 14:43:06 -07:00
Zeke Sikelianos
cc2b95fac3
js → javascript
2016-08-16 14:50:21 -07:00