通知
每个操作系统都有自己的机制来向用户显示通知。Electron 的通知 API 是跨平台的,但对于每个进程类型来说是不同的。
如果你想在主进程中使用渲染器进程的 API,反之亦然,请考虑使用 进程间通信。
使用
以下是两个显示每个进程类型的通知的示例。
在主进程中显示通知
主进程通知使用 Electron 的 Notification 模块 显示。使用此模块创建的 Notification 对象,除非调用它们的 show()
实例方法,否则不会出现。
const { Notification } = require('electron')
const NOTIFICATION_TITLE = 'Basic Notification'
const NOTIFICATION_BODY = 'Notification from the Main process'
new Notification({
title: NOTIFICATION_TITLE,
body: NOTIFICATION_BODY
}).show()
以下是一个你可以用 Electron Fiddle 打开的完整示例
- main.js
- index.html
const { app, BrowserWindow, Notification } = require('electron/main')
function createWindow () {
const win = new BrowserWindow({
width: 800,
height: 600
})
win.loadFile('index.html')
}
const NOTIFICATION_TITLE = 'Basic Notification'
const NOTIFICATION_BODY = 'Notification from the Main process'
function showNotification () {
new Notification({ title: NOTIFICATION_TITLE, body: NOTIFICATION_BODY }).show()
}
app.whenReady().then(createWindow).then(showNotification)
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') {
app.quit()
}
})
app.on('activate', () => {
if (BrowserWindow.getAllWindows().length === 0) {
createWindow()
}
})
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello World!</title>
<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
</head>
<body>
<h1>Hello World!</h1>
<p>After launching this application, you should see the system notification.</p>
</body>
</html>
在渲染器进程中显示通知
可以使用 网络通知 API 直接从渲染器进程显示通知。
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY =
'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked'
new Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY }).onclick =
() => console.log(CLICK_MESSAGE)
以下是一个你可以用 Electron Fiddle 打开的完整示例
- main.js
- index.html
- renderer.js
const { app, BrowserWindow } = require('electron/main')
function createWindow () {
const win = new BrowserWindow({
width: 800,
height: 600
})
win.loadFile('index.html')
}
app.whenReady().then(createWindow)
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') {
app.quit()
}
})
app.on('activate', () => {
if (BrowserWindow.getAllWindows().length === 0) {
createWindow()
}
})
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello World!</title>
<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
</head>
<body>
<h1>Hello World!</h1>
<p>After launching this application, you should see the system notification.</p>
<p id="output">Click it to see the effect in this interface.</p>
<script src="renderer.js"></script>
</body>
</html>
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY = 'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked!'
new window.Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY })
.onclick = () => { document.getElementById('output').innerText = CLICK_MESSAGE }
平台注意事项
虽然跨操作系统的代码和用户体验相似,但仍有一些细微差别。
Windows
对于 Windows 上的通知,你的 Electron 应用程序需要有一个带有 AppUserModelID 和相应 ToastActivatorCLSID 的开始菜单快捷方式。
Electron 尝试自动执行有关 AppUserModelID 和 ToastActivatorCLSID 的工作。当 Electron 与 Squirrel.Windows 一起使用时(例如,如果你正在使用 electron-winstaller),快捷方式将自动设置正确。
在生产环境中,Electron 还会检测到是否使用了 Squirrel,并会自动使用正确的值调用 app.setAppUserModelId()
。在开发过程中,你可能需要自己调用 app.setAppUserModelId()
。
为了在开发过程中快速引导通知,将 node_modules\electron\dist\electron.exe
添加到你的开始菜单也可以。在资源管理器中导航到该文件,右键单击并“固定到开始菜单”。然后,在主进程中调用 app.setAppUserModelId(process.execPath)
即可查看通知。
使用高级通知
Windows 还允许使用自定义模板、图像和其他灵活元素进行高级通知。
要从主进程发送这些通知,可以使用用户级模块 electron-windows-notifications
,它使用原生 Node 附加程序发送 ToastNotification
和 TileNotification
对象。
虽然包含按钮的通知可以使用 electron-windows-notifications
,但处理回复需要使用 electron-windows-interactive-notifications
,它有助于注册所需的 COM 组件并使用输入的用户数据调用你的 Electron 应用程序。
查询通知状态
要检测是否允许你发送通知,可以使用用户级模块 windows-notification-state
。
此模块允许你在提前确定 Windows 是否会静默地丢弃通知。
macOS
macOS 上的通知很简单,但你应该注意 Apple 关于通知的人机界面指南。
请注意,通知的大小限制为 256 字节,如果你超过此限制,通知将被截断。
查询通知状态
要检测是否允许你发送通知,可以使用用户级模块 macos-notification-state
。
此模块允许你提前检测通知是否会显示。
Linux
使用 libnotify
发送通知,它可以在任何遵循 桌面通知规范 的桌面环境中显示通知,包括 Cinnamon、Enlightenment、Unity、GNOME 和 KDE。