electron-notifications-win
v0.8.0
Published
A node module for sending notifications in electron applications
Downloads
52
Readme
Electron Notifications Win
electron 原生Notifications 在window10下,具备一些优点,如在通知展示内容上原生的 Notifications toastXml 提供了完全自定义的设计。但限制也比较明显,比如强制展示至少5秒才会继续展示下一条通知,通知队列由操作系统控制,开发者无法修改队列逻辑。
这个库直接用 browserWindow 模拟的 Notifications,相比原生Notifications自定义UI的能力弱很多,但通知展示时长、展示个数等可以由开发者决定,在通知的使用场景下提供了更好的即时展示能力。这个项目在原fork基础上做了较大修改工作,旨在开发一个仿windows风格但能够突破这些限制的通知库。
安装
npm install --save electron-notifications-win
和原fork的功能区别
- 不再支持vertical、flat 模式,不再支持按钮 buttons。
- 不支持swipedRight、buttonClicked事件,clicked事件改为click
- 新增关闭按钮,支持close事件
- 新增通知展示个数上限,可支持修改,通知展示个数达到上限后,销毁最早的一条通知
- 新增通知样式width、height、marginRight、spaceHeight,可支持修改
版本更新
0.7.0
- 见和原fork的功能区别
0.7.1
- 通知位置相对任务栏(程序坞)位置动态调整
0.7.2
- 支持 autoClose 选项,autoClose 为 false 时,通知不会自动关闭
0.7.3
- 点击通知后关闭通知窗体
- 显示通知时发出通知提示音,支持 silent 选项,控制通知是否静音
0.7.4
- 支持 packagedLibRendererDirectory 选项
0.7.5
- 支持 packagedLibRendererDirectory 选项
0.7.6
- 支持 beep 只带声音的通知
快速使用
在主进程中使用
const notifier = require('electron-notifications-win');
// (可选)设置全局配置
notifier.config({
spaceHeight: 20,
icon: 'icon.png',
autoClose: true,
duration: 5000,
});
notifier.notify({
title: 'from main process',
body: '你好1',
})
// 监听close事件
.on('close', (id) => {
console.log('close', id);
});
notifier.notify({
title: 'from main process',
body: '你好2',
})
// 监听click事件
.on('click', (id) => {
console.log('click', id);
});
// 单纯声音提醒,无消息体
notifier.beep();
在渲染进程中使用
// 使用自己定义的ipcRenderer向主进程发送 notifier.notify 消息
const ipcRenderer = window.electron.ipcRenderer;
const random = Math.round(Math.random() * 100);
ipcRenderer.send('notifier.notify', {
title: '[A.F.C]提醒您',
body: '持续工作了230分钟' + random,
icon: 'https://nos.netease.com/ysf/b05c70fca471eabbdccfed6f73e424e7.png',
autoClose: false
});
ipcRenderer.send('notifier.beep');
Demo
快速查看Demo示例
git clone [email protected]:NSFI/electron-notifications-win.git
npm run playbook
全局配置
limit
: 可选,至多展示的通知个数,默认 4width
: 可选,通知本体的宽度,默认 345 DIPheight
: 可选,通知本体的高度,默认 65 DIPmarginRight
: 可选,通知外框的右边外边距,默认 20 DIPspaceHeight
: 可选,通知之间的上下间距,默认 10 DIPicon
: 可选,左边展示的iconautoClose
: 可选,通知是否达到 duration 展示时长后自动关闭,默认 true。autoClose 为 false 时 忽略duration。duration
: 可选,通知展示时长,单位:毫秒,默认 4000mssilent
: 可选,在显示通知时是否发出通知提示音,默认 truepackagedLibRendererDirectory
: 可选,打包后的electron通知页面目录,默认 electron-notifications-win/lib/renderer。注意,electron打包后,生产环境需要加载库文件的notification.html,因此需要在构建时将 node_modules/electron-notifications-win/lib/renderer/**/* 复制到应用程序资源目录下(Contents/Resources for MacOS, resources for Linux and Windows),这里需要指定相对应用程序资源目录的位置。
// (可选)设置全局配置
notifier.config({
spaceHeight: 20,
icon: 'icon.png',
autoClose: true,
duration: 5000,
});
静态方法
notify
展示一个带消息体的飘窗通知 notifier.notify(options)
options.title
: 必选,通知的标题options.body
: 可选,通知的内容options.icon
: 可选,左边展示的icon,未设置时使用全局配置options.autoClose
: 可选,通知是否达到 duration 展示时长后自动关闭,未设置时使用全局配置,默认 true。autoClose 为 false 时忽略 duration。options.duration
: 可选,通知展示时长,单位:毫秒,未设置时使用全局配置,默认 4000msoptions.silent
: 可选,在显示通知时是否发出通知提示音,默认 true
beep
只带声音通知,不带消息体 notifier.beep();
飘窗通知事件
click
通知被点击事件
const notification = notifier.notify({
title: 'Calendar',
});
notification.on('click', (id) => {
// do something
});
close
通知被关闭事件
const notification = notifier.notify({
title: 'Calendar',
});
notification.on('close', (id) => {
// do something
});