16. Tray

原文:https://github.com/electron/electron/blob/master/docs/api/tray.md
译者:Lin

添加图标和右键菜单到系统的通知区域

进程:主进程

Tray是一个EventEmitter

const {app, Menu, Tray} = require('electron')

let tray = null
app.on('ready', () => {
tray = new Tray('/path/to/my/icon')
const contextMenu = Menu.buildFromTemplate([
    {label: 'Item1', type: 'radio'},
    {label: 'Item2', type: 'radio'},
    {label: 'Item3', type: 'radio', checked: true},
    {label: 'Item4', type: 'radio'}
])
tray.setToolTip('This is my application.')
tray.setContextMenu(contextMenu)
})

平台的局限性:

  • Linux中如果支持应用指示器那么应用指示器将被使用,否则将使用GtkStatusIcon代替。
  • Linux发行版中支持应用指示器,你需要安装libappindicator1来使tray图标工作。
  • 当有右键菜单时才会展示应用指示器。
  • 当Linux中的应用指示器被使用,click事件将被忽略。
  • Linux中为了使个别的MenuItems的改变生效,你需要再次调用setContextMenu。例如:
const {app, Menu, Tray} = require('electron')

let appIcon = null
app.on('ready', () => {
   appIcon = new Tray('/path/to/my/icon')
   const contextMenu = Menu.buildFromTemplate([
       {label: 'Item1', type: 'radio'},
       {label: 'Item2', type: 'radio'}
   ])

   // Make a change to the context menu
   contextMenu.items[1].checked = false

   // Call this again for Linux because we modified the context menu
   appIcon.setContextMenu(contextMenu)
})
  • Windows中建议使用ICO格式的图标来获得最好的视觉效果。

如果你想在所有平台上保持完全相同的行为,你需要不依赖点击事件并且将右键菜单依附在托盘图标上。

new Tray(image)

通过image创建一个托盘图标。

实例的事件

Tray模块分发以下事件:

事件: 'click'

  • event Event类型
    • altKey Boolean类型
    • shiftKey Boolean类型
    • ctrlKey Boolean类型
    • metaKey Boolean类型
  • bounds Rectangle类型 - 托盘图标的边界。

当托盘图片被点击的时候被分发。

事件: 'right-click' MacOS Windows

  • event Event
    • altKey Boolean
    • shiftKey Boolean
    • ctrlKey Boolean
    • metaKey Boolean
  • bounds Rectangle类型 - 托盘图标的边界。

当托盘图片被右键点击的时候被分发。

事件: 'double-click' MacOS Windows

  • event Event
    • altKey Boolean
    • shiftKey Boolean
    • ctrlKey Boolean
    • metaKey Boolean
  • bounds Rectangle类型 - 托盘图标的边界。

当托盘图片被双击的时候被分发。

事件: 'balloon-show' Windows

当托盘气球展示的时候被分发。

事件: 'balloon-click' Windows

当托盘气球被点击的时候被分发。

事件: 'balloon-closed' Windows

当托盘气球因为超时关闭或者用户手动点击关闭时被分发。

事件: 'drop' MacOS

任何被拖动的项目被拖动到托盘图标上的时候被分发。

事件: 'drop-files' MacOS

  • event Event类型
  • files String[]类型 - 被拖动的文件的路径。

被拖动的文件拖动到托盘图标里面的时候被分发。

事件: 'drop-text' MacOS

  • event Event类型
  • text String类型 - 被拖动的文本字符串。

被拖动的文本拖动到托盘图标里面的时候被分发。

事件: 'drag-enter' MacOS

当一个拖动操作进入到托盘图标的时候被分发。

事件: 'drag-leave' MacOS

当一个拖动操作离开托盘图标的时候被分发。

事件: 'drag-end' MacOS

当拖动操作在托盘图标上释放或在其他的位置释放时被分发。

实例的方法

Tray类有以下方法:

tray.destroy()

立刻销毁托盘图标。

tray.setImage(image)

设置托盘图标。

tray.setPressedImage(image) MacOS

设置MacOS下按下托盘图标是的托盘图标。

tray.setToolTip(toolTip)

  • toolTip String类型

设置托盘图标的悬停文本。

tray.setTitle(title) MacOS

  • title String类型

设置显示在状态栏中托盘图标旁边的文字。

tray.setHighlightMode(mode) MacOS

  • mode String类型 - 高亮模式有以下值类型:
    • selection - 托盘图标被点击的时候和右键菜单打开的时候高亮。这个是默认值。
    • always - 托盘图标维持高亮状体。
    • never - 托盘图标没有高亮状态。

设置什么时候托盘的图标背景变成高亮状态(蓝色)。

注意:当窗口是否可见状态改变的时候,你可以使用BrowserWindowhighlightMode'never''always'模式指尖切换。

const {BrowserWindow, Tray} = require('electron')

const win = new BrowserWindow({width: 800, height: 600})
const tray = new Tray('/path/to/my/icon')

tray.on('click', () => {
    win.isVisible() ? win.hide() : win.show()
})
win.on('show', () => {
    tray.setHighlightMode('always')
})
win.on('hide', () => {
    tray.setHighlightMode('never')
})

tray.displayBalloon(options) Windows

  • options Object类型
    • icon (NativeImage | String)类型(可选参数)
    • title String类型(可选参数)
    • content String类型(可选参数)

展示一个托盘气球。

tray.popUpContextMenu([menu, position]) MacOS Windows

  • menu Menu类型(可选参数)
  • position Object类型(可选参数)- 弹出的位置。
    • x Integer
    • y Integer

弹出一个托盘图标的右键菜单。当menu参数被设置,menu将被展示代替托盘图标的右键菜单。

position只在Windows中有效,并且默认值是(0, 0)

tray.setContextMenu(menu)

  • menu Menu类型

给这个托盘图标设置右键菜单。

tray.getBounds() MacOS Windows

返回值为Rectangle类型

作为Object的托盘图标的bounds

tray.isDestroyed()

返回值为Boolean类型 - 托盘图标是否被销毁。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容

  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 19,019评论 1 5
  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 2,639评论 0 1
  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 6,126评论 0 1
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,419评论 0 17
  • Objective关于今天的课程/工作, 你记得什么? 心理课: 多年以前有四个学者随着一个驼队穿越卡瓦尔沙漠,晚...
    明睿希灿阅读 423评论 0 0