Tray
Tray
は、オペレーティングシステムの通知エリアでアイコンで表示され、通常コンテキストメニューが付随します。
const electron = require('electron')
const app = electron.app
const Menu = electron.Menu
const Tray = electron.Tray
var appIcon = null
app.on('ready', function () {
appIcon = new Tray('/path/to/my/icon')
var contextMenu = Menu.buildFromTemplate([
{ label: 'Item1', type: 'radio' },
{ label: 'Item2', type: 'radio' },
{ label: 'Item3', type: 'radio', checked: true },
{ label: 'Item4', type: 'radio' }
])
appIcon.setToolTip('This is my application.')
appIcon.setContextMenu(contextMenu)
})
プラットフォームの制限:
- Linuxでは、サポートしている場合アプリインディケーターが使われ、サポートされていなければ代わりに
GtkStatusIcon
が使われます。 - アプリインディケーターを持っているLinuxディストリビューションでは、トレイアイコンを動作させるために
libappindicator1
をインストールする必要があります。 - コンテキストメニューがあるときは、インディケーターのみが表示されます。
- アプリインディケーターがLinuxで使われると、
click
イベントは無視されます。
すべてのプラットフォームで正確に同じ挙動を維持したい場合は、click
イベントに依存せず、常にトレイアイコンにコンテキストメニューを付随させるようにします。
クラス: Tray
Tray
はEventEmitterです。
new Tray(image)
image
NativeImage
image
で新しいトレイアイコンを作成します。
イベント
Tray
モジュールは次のイベントを出力します。
Note: いくつかのイベントは、特定のオペレーティングシステム向けに提供され、そのようにラベルで表示します。
イベント: 'click'
event
EventaltKey
BooleanshiftKey
BooleanctrlKey
BooleanmetaKey
Boolean
bounds
Object - トレイアイコンのバウンドx
Integery
Integerwidth
Integerheight
Integer
トレイアイコンがクリックされたときに出力されます。
Note: バウンド
再生はmacOSとWindoesのみで実装されています。
イベント: 'right-click' macOS Windows
event
EventaltKey
BooleanshiftKey
BooleanctrlKey
BooleanmetaKey
Boolean
bounds
Object - トレイアイコンのバウンドx
Integery
Integerwidth
Integerheight
Integer
トレイアイコンが右クリックされると出力されます。
イベント: 'double-click' macOS Windows
event
EventaltKey
BooleanshiftKey
BooleanctrlKey
BooleanmetaKey
Boolean
bounds
Object - トレイアイコンのバウンドx
Integery
Integerwidth
Integerheight
Integer
トレイアイコンがダブルクリックされたら出力されます。
イベント: 'balloon-show' Windows
トレイバルーンを表示したときに出力されます。
イベント: 'balloon-click' Windows
トレイバルーンがクリックされたときに出力されます。
イベント: 'balloon-closed' Windows
タイムアウトもしくはユーザーの操作で閉じて、トレイバルーンがクロースされたときに出力されます。
イベント: 'drop' macOS
トレイアイコンでアイテムがドラグアンドドロップされたときに出力されます。
イベント: 'drop-files' macOS
event
files
Array - ドロップされたアイテムのフルパス
トレイアイコンでファイルがドロップされたときに出力されます。
イベント: 'drag-enter' macOS
トレイアイコンにドラッグ操作が入ったときに出力されます。
イベント: 'drag-leave' macOS
トレイアイコンででドラッグ操作が行われたときに出力されます。
イベント: 'drag-end' macOS
トレイ上でドラッグ操作が終了したか、ほかの場所で終了したときに出力されます。
Methods
Tray
モジュールは次のメソッドを持ちます。
Note: いくつかのメソッドは、特定のオペレーティングシステム向けに提供され、そのようにラベルで表示します。
Tray.destroy()
ただちにトレイアイコンを終了します。
Tray.setImage(image)
image
NativeImage
トレイアイコンのimage
を設定します。
Tray.setPressedImage(image)
macOS
image
NativeImage
macOSで押されたときにトレイアイコンのimage
を設定します。
Tray.setToolTip(toolTip)
toolTip
String
トレイアイコン用のホバーテキストを設定します。
Tray.setTitle(title)
macOS
title
String
ステータスバーで、トレイアイコンのわきに表示するタイトルを設定します。
Tray.setHighlightMode(highlight)
macOS
highlight
Boolean
トレイアイコンがクリックされた時、トレイアイコンの背景をハイライト(青色)するかどうかを設定します。既定ではTrueです。
Tray.displayBalloon(options)
Windows
options
Objecticon
NativeImagetitle
Stringcontent
String
トレイバルーンを表示します。
Tray.popUpContextMenu([menu, position])
macOS Windows
menu
Menu (optional)position
Object (optional) - ポップアップ位置x
Integery
Integer
トレイアイコンのコンテキストメニューをポップアップします。menu
が渡されたとき、menu
はトレイコンテキストメニューの代わりに表示されます。
position
はWindowsのみで提供され、既定では(0, 0) です。
Tray.setContextMenu(menu)
menu
Menu
アイコン用のコンテキストメニューを設定します。