From c8a8576970749b24de26c8fbc5deac1cef6b2b1f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Sep 2014 19:50:50 +0800 Subject: [PATCH] docs: Document the new Tray APIs. --- docs/api/tray.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/api/tray.md b/docs/api/tray.md index c72963e26c32..7d6ebc96713a 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -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