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

build: move to the new docs parser (#18103)

Browse source 
* 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>
This commit is contained in:
Samuel Attard 2019-05-06 08:29:01 -07:00 • committed by John Kleinschmidt
parent 9ec59cbc6c
commit a96b6e2c96
28 changed files with 461 additions and 1234 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/api/tray.md
View file

@ -70,6 +70,8 @@ The `Tray` module emits the following events:
#### Event: 'click'
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
* `position` [Point](structures/point.md) - The position of the event.
@ -78,6 +80,8 @@ Emitted when the tray icon is clicked.
#### Event: 'right-click' _macOS_ _Windows_
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
@ -85,6 +89,8 @@ Emitted when the tray icon is right clicked.
#### Event: 'double-click' _macOS_ _Windows_
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `bounds` [Rectangle](structures/rectangle.md) - The bounds of tray icon.
@ -109,6 +115,8 @@ Emitted when any dragged items are dropped on the tray icon.
#### Event: 'drop-files' _macOS_
Returns:
* `event` Event
* `files` String[] - The paths of the dropped files.
@ -116,6 +124,8 @@ Emitted when dragged files are dropped in the tray icon.
#### Event: 'drop-text' _macOS_
Returns:
* `event` Event
* `text` String - the dropped text string.
@ -135,6 +145,8 @@ Emitted when a drag operation ends on the tray or ends at another location.
#### Event: 'mouse-enter' _macOS_
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `position` [Point](structures/point.md) - The position of the event.
@ -142,6 +154,8 @@ Emitted when the mouse enters the tray icon.
#### Event: 'mouse-leave' _macOS_
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `position` [Point](structures/point.md) - The position of the event.
@ -149,6 +163,8 @@ Emitted when the mouse exits the tray icon.
#### Event: 'mouse-move' _macOS_
Returns:
* `event` [KeyboardEvent](structures/keyboard-event.md)
* `position` [Point](structures/point.md) - The position of the event.
@ -188,8 +204,6 @@ Sets the title displayed next to the tray icon in the status bar (Support ANSI c
#### `tray.getTitle()` _macOS_
* `title` String
Returns `String` - the title displayed next to the tray icon in the status bar
#### `tray.setHighlightMode(mode)` _macOS_