Интеграция нативных функций Electron
Electron силён тем, что позволяет не только писать фронтенд-код, но и получать доступ к нативным системным функциям, таким как меню, диалоги, трей, уведомления и глобальные горячие клавиши.
В этом разделе мы рассмотрим, как вызывать эти функции через модули главного процесса.
Система меню
Electron предоставляетMenuМодуль используется для создания строк меню, контекстных меню и меню системного трея.
Меню приложения (Menu)
Меню приложения — это строка меню, отображаемая в верхней части окна (macOS) или внутри окна приложения.
Пример
const template = [
{
label: 'Файл',
submenu: [
{ label: 'Новый файл', accelerator: 'CmdOrCtrl+N', click: () => console.log('Новый файл') },
{ label: 'Открыть...', accelerator: 'CmdOrCtrl+O' },
{ type: 'separator' },
{ label: 'Выход', role: 'quit' }
]
},
{
label: 'Edit',
submenu: [
{ role: 'undo' },
{ role: 'redo' },
{ type: 'separator' },
{ role: 'cut' },
{ role: 'copy' },
{ role: 'paste' }
]
}
]
const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)
Описание:
label: Заголовок меню.submenu: Массив подменю.acceleratorСочетания клавиш (общепринятая нотация для macOS, WindowsCmdOrCtrl+X)。role: Предопределённые системой поведения, такие какquit、copy、paste。click: Функция обратного вызова события клика.
Контекстное меню
Контекстные меню обычно вызываются в процессе рендеринга:
Пример
const { ipcMain, Menu } = require('electron')
ipcMain.on('show-context-menu', (event) => {
const menu = Menu.buildFromTemplate([
{ label: 'Refresh', click: () => event.sender.reload() },
{ label: 'Copy', role: 'copy' },
{ label: 'Paste', role: 'paste' }
])
menu.popup()
})
Пример
window.addEventListener('contextmenu', (e) => {
e.preventDefault()
window.electronAPI.showContextMenu()
})
Меню системного трея
Отображает значок и меню в области уведомлений системы.
Пример
let tray = null
function createTray() {
const icon = nativeImage.createFromPath('icon.png')
tray = new Tray(icon)
const contextMenu = Menu.buildFromTemplate([
{ label: 'Открыть главное окно', click: () => mainWindow.show() },
{ label: 'Выход', click: () => app.Выход() }
])
tray.setToolTip('Моё приложение Electron')
tray.setContextMenu(contextMenu)
}
Сочетания клавиш меню
ЧерезacceleratorОпределение. Например:
{ label: '保存', accelerator: 'CmdOrCtrl+S', click: saveFile }
CmdOrCtrl: Автоматически адаптируется к macOS/Windows.Alt+F4: Windows закрывает окно.Cmd+Q: macOS завершает приложение.
Системные диалоги
dialogМодуль предоставляет нативные системные диалоги для файлов, сообщений, ошибок и т.д.
Выбор файла/папкиconst { dialog } = require('electron')
async function openFileDialog() {
const result = await dialog.showOpenDialog({
title: '选择文件',
properties: ['openFile', 'multiSelections'],
filters: [{ name: '文本文件', extensions: ['txt', 'md'] }]
})
console.log(result.filePaths)
}
Диалог сохранения
async function saveFileDialog() {
const result = await dialog.showSaveDialog({
title: '保存文件',
defaultPath: '新建文档.txt'
})
console.log(result.filePath)
}
Диалоговое окно сообщения/ошибки
dialog.showMessageBox({
type: 'info',
title: '提示',
message: '操作已完成!'
})
dialog.showErrorBox('错误', '文件保存失败,请重试。')
Системный трей
Трей (Tray) позволяет приложению взаимодействовать через системный значок, работая в фоновом режиме.
Создание значка трея
const { Tray } = require('electron')
const path = require('path')
let tray = new Tray(path.join(__dirname, 'trayIcon.png'))
Меню трея и всплывающая подсказка
const contextMenu = Menu.buildFromTemplate([
{ label: '显示窗口', click: () => mainWindow.show() },
{ label: '退出', click: () => app.quit() }
])
tray.setToolTip('Electron 应用运行中')
tray.setContextMenu(contextMenu)
Уведомление трея
tray.displayBalloon({
icon: path.join(__dirname, 'icon.png'),
title: '新消息',
content: '您有一条新通知'
})
Свернуть в трей
Прослушивание событий закрытия для скрытия окна:
mainWindow.on('close', (event) => {
event.preventDefault()
mainWindow.hide()
})
Уведомления
ElectronNotificationКласс может отображать системные уведомления на разных платформах.
Отправка системных уведомлений
new Notification({
title: '任务完成',
body: '您的文件已下载完成'
}).show()
Обработка взаимодействия с уведомлениями
const notif = new Notification({ title: '点击通知', body: '点击我触发事件' })
notif.on('click', () => {
console.log('用户点击了通知')
})
notif.show()
Кроссплатформенная совместимость
- Поддерживаются macOS, Windows и Linux;
- В macOS требуется включить "Notification Permission";
- В Linux обычно требуется поддержка системы
libnotify。
Глобальные горячие клавиши
ЧерезglobalShortcutЗарегистрировать системную горячую клавишу.
Зарегистрировать глобальное сочетание клавиш
const { globalShortcut } = require('electron')
app.whenReady().then(() => {
globalShortcut.register('CmdOrCtrl+Shift+I', () => {
console.log('快捷键触发:打开调试工具')
mainWindow.webContents.openDevTools()
})
})
Обработка конфликтов сочетаний клавиш
Можно обнаружить до регистрации:
if (globalShortcut.isRegistered('CmdOrCtrl+Shift+I')) {
console.log('快捷键已被占用')
}
Обработка различий платформ
Проверка условий доступности:
const shortcut = process.platform === 'darwin' ? 'Cmd+Shift+T' : 'Ctrl+Shift+T'
globalShortcut.register(shortcut, () => console.log('快捷键触发'))
Итог
| Особенности | Модуль | Типичное использование |
|---|---|---|
| Меню | Menu |
Меню приложения, контекстное меню, меню трея |
| Диалоговое окно | dialog |
Открытие файлов, сохранение файлов, отображение предупреждений или ошибок |
| Трей | Tray |
Работа в фоновом режиме, отображение состояния системы |
| Уведомление | Notification |
Уведомление пользователей о ходе события, системные напоминания |
| Глобальные горячие клавиши | globalShortcut |
Регистрация системных сочетаний клавиш |
Демонстрационный проект нативных функций Electron
Структура проекта
my-electron-native-demo/ ├── package.json ├── main.js # 主进程逻辑 ├── preload.js # 预加载脚本(安全通信) └── index.html # 主界面
package.json
Примечание: не пишите комментарии в JSON-файлах (иначе будет выдана ошибка EJSONPARSE).
{
"name": "my-electron-native-demo",
"version": "1.0.0",
"description": "Electron 原生功能演示项目",
"main": "main.js",
"scripts": {
"start": "electron ."
},
"devDependencies": {
"electron": "latest"
}
}
Установите зависимости:
npm install
Запустите приложение:
npm start
main.js (главный процесс)
Пример
const path = require('path')
let mainWindow, tray
function createWindow() {
mainWindow = new BrowserWindow({
width: 900,
height: 600,
webPreferences: {
preload: path.join(__dirname, 'preload.js')
}
})
mainWindow.loadFile('index.html')
// Показать после завершения загрузки страницы
mainWindow.once('ready-to-show', () => mainWindow.show())
// Слушать закрытие окна: свернуть в трей
mainWindow.on('close', (event) => {
event.preventDefault()
mainWindow.hide()
})
}
function createMenu() {
const template = [
{
label: 'Файл',
submenu: [
{ label: 'Открыть файл', click: openFile },
{ label: Сохранить файл, click: saveFile },
{ type: 'separator' },
{ label: 'Выход', click: () => app.Выход() }
]
},
{
label: 'Инструменты',
submenu: [
{ label: Показать уведомление, click: showNotification },
{ label: 'О программе', click: showAbout }
]
}
]
const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)
}
function createTray() {
const icon = path.join(__dirname, 'icon.png') // Пожалуйста, подготовьте иконку 16x16 или 32x32
tray = new Tray(icon)
const contextMenu = Menu.buildFromTemplate([
{ label: Показать окно, click: () => mainWindow.show() },
{ label: 'Выход', click: () => app.Выход() }
])
tray.setToolTip('Демонстрация нативных возможностей Electron')
tray.setContextMenu(contextMenu)
}
function registerShortcuts() {
globalShortcut.register('CmdOrCtrl+Shift+I', () => {
mainWindow.webContents.openDevTools()
})
}
async function openFile() {
const result = await dialog.showOpenDialog({
properties: ['openFile'],
filters: [{ name: 'Текстовый файл', extensions: ['txt', 'md'] }]
})
if (!result.canceled && result.filePaths.length > 0) {
mainWindow.webContents.send('file-opened', result.filePaths[0])
}
}
async function saveFile() {
const result⟦⟧await dialog. = showSaveDialogshowSaveDialog({
title: Сохранить файл,
defaultPath: 'New Document.txt'
})
if (!result.canceled) {
dialog.showMessageBox({ type: 'info', message:`Файл будет сохранён в: ${result.filePath}` })
}
}
function showNotification() {
const notif = new Notification({
title: 'Уведомление Electron',
body: 'Это системное уведомление!'
})
notif.on('click', () => {
dialog.showMessageBox({ message: 'Вы щёлкнули по уведомлению!' })
})
notif.show()
}
function showAbout() {
dialog.showMessageBox({
type: 'info',
title: 'О программе',
message: 'Демонстрационный проект нативных функций Electron\n'Версия: 1.0.0'
})
}
// Вызов процесса рендерера
ipcMain.handle('show-dialog', async () => {
const result = await dialog.showMessageBox({
type: 'info',
title: 'Из главного процесса',
message: 'Это диалоговое окно, отображаемое главным процессом!'
})
return result.response
})
// Жизненный цикл
app.whenReady().then(() => {
createWindow()
createMenu()
createTray()
registerShortcuts()
})
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit()
})
preload.js (безопасный мост)
Пример
contextBridge.exposeInMainWorld('electronAPI', {
showDialog: () => ipcRenderer.invoke('show-dialog')
})
index.html (интерфейс фронтенда)
Пример
<html lang="zh">
<head>
<meta charset="UTF-8">
<title>Демонстрация нативных возможностей Electron</title>
<style>
body { font-family: sans-serif; text-align: center; margin-top: 80px; }
button { padding: 10px 20px; margin: 10px; font-size: 16px; cursor: pointer; }
#filePath { color: #666; font-size: 14px; }
</style>
</head>
<body>
<h1>Демонстрация нативной функциональности Electron</h1>
<p><button id="dialogBtn">Показать диалог</button></p>
<p id="filePath"></p>
<script>
document.getElementById('dialogBtn').addEventListener('click', async () => {
await window.electronAPI.showDialog()
})
const filePathEl = document.getElementById('filePath')
window.electronAPI && window.electronAPI.fileOpened && window.electronAPI.fileOpened((filePath) => {
filePathEl.textContent = 'Opened file path: ' + path
})
</script>
</body>
</html>
Запуститеnpm startПосле этого функции выглядят следующим образом:
- Верхняя строка меню содержит меню "Файл" и "Файл".
- "Файл" → Open File / Open File вызывает системный диалог.
- "Инструменты" → Показать системное уведомление, отобразить окно "О программе".
- В области трея появляется значок приложения, и вы можете щёлкнуть правой кнопкой мыши, чтобы показать меню.
- Свернуть в трей после закрытия окна.
- Зарегистрировать глобальное сочетание клавиш
CmdOrCtrl+Shift+IОткройте инструменты разработчика.