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

docs: Document the new Tray APIs.

Browse source
This commit is contained in:
Cheng Zhao 2014-09-09 19:50:50 +08:00
parent 67cbecaba0
commit c8a8576970
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/api/tray.md
View file

@ -48,6 +48,12 @@ Creates a new tray icon associated with the `image`.
Emitted when the tray icon is clicked.
### Event: 'double-clicked'
Emitted when the tray icon is double clicked.
This is only implmented on OS X.
### Tray.setImage(image)
* `image` [Image](image.md)
@ -64,8 +70,28 @@ Sets the `image` associated with this tray icon when pressed.
* `toolTip` String
Sets the hover text for this tray icon.
### Tray.setTitle(title)
* `title` String
Sets the title displayed aside of the tray icon in the status bar.
This is only implmented on OS X.
### Tray.setHighlightMode(highlight)
* `highlight` String
Sets whether the tray icon is highlighted when it is clicked.
This is only implmented on OS X.
### Tray.setContextMenu(menu)
* `menu` Menu
Set the context menu for this icon.
[event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter