Integration nativer Funktionen in Electron

Electron ist leistungsstark, weil man damit nicht nur Frontend-Code schreiben, sondern auch auf native Systemfunktionen wie Menüs, Dialoge, Tray, Benachrichtigungen und globale Tastenkürzel zugreifen kann.

In diesem Abschnitt sehen wir uns an, wie diese Funktionen über Module des Hauptprozesses aufgerufen werden.


Menüsystem

Electron bietetMenuDas Modul wird verwendet, um Menüleisten, Kontextmenüs und System-Tray-Menüs zu erstellen.

Anwendungsmenü (Menu)

Das Anwendungsmenü ist eine Menüleiste, die oben im Fenster (macOS) oder innerhalb des Anwendungsfensters angezeigt wird.

Beispiel

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

const template = [
  {
    label: 'Datei',
    submenu: [
      { label: 'Neue Datei', accelerator: 'CmdOrCtrl+N', click: () => console.log('Neue Datei') },
      { label: 'Öffnen...', accelerator: 'CmdOrCtrl+O' },
      { type: 'separator' },
      { label: 'Beenden', role: 'quit' }
    ]
  },
  {
    label: 'Bearbeiten',
    submenu: [
      { role: 'undo' },
      { role: 'redo' },
      { type: 'separator' },
      { role: 'cut' },
      { role: 'copy' },
      { role: 'paste' }
    ]
  }
]

const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)

Beschreibung:

  • label: Menütitel.
  • submenu: Untermenü-Array.
  • acceleratorTastaturkürzel (gängige Notation für macOS, WindowsCmdOrCtrl+X)。
  • role: Vom System vordefinierte Verhaltensweisen, wie z. B.quit、copy、paste。
  • click: Callback-Funktion für das Klickereignis.

Kontextmenü

Kontextmenüs werden normalerweise im Renderer-Prozess ausgelöst:

Beispiel

// main.js
const { ipcMain, Menu } = require('electron')

ipcMain.on('show-context-menu', (event) => {
  const menu = Menu.buildFromTemplate([
    { label: 'Aktualisieren', click: () => event.sender.reload() },
    { label: 'Kopieren', role: 'copy' },
    { label: 'Einfügen', role: 'paste' }
  ])
  menu.popup()
})

Beispiel

// renderer.js
window.addEventListener('contextmenu', (e) => {
  e.preventDefault()
  window.electronAPI.showContextMenu()
})

System-Tray-Menü

Ein Symbol und ein Menü im Benachrichtigungsbereich des Systems anzeigen.

Beispiel

const { Tray, Menu, nativeImage } = require('electron')
let tray = null

function createTray() {
  const icon = nativeImage.createFromPath('icon.png')
  tray = new Tray(icon)
  const contextMenu = Menu.buildFromTemplate([
    { label: 'Hauptfenster öffnen', click: () => mainWindow.show() },
    { label: 'Beenden', click: () => app.Beenden() }
  ])
  tray.setToolTip('Meine Electron-Anwendung')
  tray.setContextMenu(contextMenu)
}

Menü-Tastenkürzel

DurchacceleratorDefinition. Zum Beispiel:

{ label: '保存', accelerator: 'CmdOrCtrl+S', click: saveFile }
  • CmdOrCtrl: Passt sich automatisch an macOS/Windows an.
  • Alt+F4: Windows schließt das Fenster.
  • Cmd+Q: macOS beendet die Anwendung.

Systemdialoge

dialogDas Modul bietet native Systemdialoge für Dateien, Nachrichten, Fehler usw.

Datei-/Ordnerauswahl
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)
}

Speicherdialog

async function saveFileDialog() {
  const result = await dialog.showSaveDialog({
    title: '保存文件',
    defaultPath: '新建文档.txt'
  })
  console.log(result.filePath)
}

Nachrichten-/Fehlerdialog

dialog.showMessageBox({
  type: 'info',
  title: '提示',
  message: '操作已完成!'
})

dialog.showErrorBox('错误', '文件保存失败,请重试。')

System-Tray

Der Tray (Tray) ermöglicht es der Anwendung, über das System-Symbol zu interagieren, während sie im Hintergrund läuft.

Tray-Symbol erstellen

const { Tray } = require('electron')
const path = require('path')

let tray = new Tray(path.join(__dirname, 'trayIcon.png'))

Tray-Menü und Tooltip

const contextMenu = Menu.buildFromTemplate([
  { label: '显示窗口', click: () => mainWindow.show() },
  { label: '退出', click: () => app.quit() }
])
tray.setToolTip('Electron 应用运行中')
tray.setContextMenu(contextMenu)

Tray-Benachrichtigung

tray.displayBalloon({
  icon: path.join(__dirname, 'icon.png'),
  title: '新消息',
  content: '您有一条新通知'
})

In den Tray minimieren

Auf Schließen-Ereignisse lauschen, um das Fenster auszublenden:

mainWindow.on('close', (event) => {
  event.preventDefault()
  mainWindow.hide()
})

Benachrichtigungen

ElectronsNotificationDie Klasse kann Systembenachrichtigungen plattformübergreifend anzeigen.

Senden von Systembenachrichtigungen

new Notification({
  title: '任务完成',
  body: '您的文件已下载完成'
}).show()

Verarbeitung von Benachrichtigungsinteraktionen

const notif = new Notification({ title: '点击通知', body: '点击我触发事件' })
notif.on('click', () => {
  console.log('用户点击了通知')
})
notif.show()

Plattformübergreifende Kompatibilität

  • macOS, Windows und Linux werden alle unterstützt;
  • macOS erfordert die Aktivierung von "Notification Permission";
  • Linux erfordert normalerweise Systemunterstützunglibnotify。

Globale Tastenkürzel

DurchglobalShortcutSystemweiten Hotkey registrieren.

Globales Tastenkürzel registrieren

const { globalShortcut } = require('electron')

app.whenReady().then(() => {
  globalShortcut.register('CmdOrCtrl+Shift+I', () => {
    console.log('快捷键触发:打开调试工具')
    mainWindow.webContents.openDevTools()
  })
})

Behandlung von Shortcut-Konflikten

Kann vor der Registrierung erkannt werden:

if (globalShortcut.isRegistered('CmdOrCtrl+Shift+I')) {
  console.log('快捷键已被占用')
}

Behandlung von Plattformunterschieden

Überprüfung der Verfügbarkeitsbedingung:

const shortcut = process.platform === 'darwin' ? 'Cmd+Shift+T' : 'Ctrl+Shift+T'
globalShortcut.register(shortcut, () => console.log('快捷键触发'))

Zusammenfassung

Funktionen Modul Typische Verwendung
Menü Menu Anwendungsmenü, Kontextmenü, Tray-Menü
Dialogfeld dialog Dateien öffnen, Dateien speichern, Warnungen oder Fehler anzeigen
Tray Tray Hintergrundausführung, Systemstatusanzeige
Benachrichtigung Notification Benutzer über Ereignisfortschritt benachrichtigen, Systemerinnerungen
Globale Tastenkürzel globalShortcut Systemweite Tastenkombinationen registrieren

Electron-Demoprojekt für native Funktionen

Projektstruktur

my-electron-native-demo/
├── package.json
├── main.js             # 主进程逻辑
├── preload.js          # 预加载脚本(安全通信)
└── index.html          # 主界面

package.json

Hinweis: Schreiben Sie keine Kommentare in JSON-Dateien (andernfalls wird ein EJSONPARSE-Fehler gemeldet).

{
  "name": "my-electron-native-demo",
  "version": "1.0.0",
  "description": "Electron 原生功能演示项目",
  "main": "main.js",
  "scripts": {
    "start": "electron ."
  },
  "devDependencies": {
    "electron": "latest"
  }
}

Abhängigkeiten installieren:

npm install

Anwendung starten:

npm start

main.js (Hauptprozess)

Beispiel

const { app, BrowserWindow, Menu, Tray, dialog, Notification, globalShortcut, ipcMain } = require('electron')
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')

  // Nach Abschluss des Seitenladens anzeigen
  mainWindow.once('ready-to-show', () => mainWindow.show())

  // Auf Fensterschließen hören: in den Infobereich minimieren
  mainWindow.on('close', (event) => {
    event.preventDefault()
    mainWindow.hide()
  })
}

function createMenu() {
  const template = [
    {
      label: 'Datei',
      submenu: [
        { label: 'Datei öffnen', click: openFile },
        { label: Datei speichern, click: saveFile },
        { type: 'separator' },
        { label: 'Beenden', click: () => app.Beenden() }
      ]
    },
    {
      label: 'Werkzeuge',
      submenu: [
        { label: Benachrichtigung anzeigen, click: showNotification },
        { label: 'Über', click: showAbout }
      ]
    }
  ]

  const menu = Menu.buildFromTemplate(template)
  Menu.setApplicationMenu(menu)
}

function createTray() {
  const icon = path.join(__dirname, 'icon.png')  // Bitte ein 16x16- oder 32x32-Symbol vorbereiten
  tray = new Tray(icon)
  const contextMenu = Menu.buildFromTemplate([
    { label: Fenster anzeigen, click: () => mainWindow.show() },
    { label: 'Beenden', click: () => app.Beenden() }
  ])
  tray.setToolTip('Demo der nativen Electron-Funktionen')
  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: 'Textdatei', 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.showSaveDialog({
    title: Datei speichern,
    defaultPath: 'Neues Dokument.txt'
  })
  if (!result.canceled) {
    dialog.showMessageBox({ type: 'info', message:`Datei wird gespeichert unter: ${result.filePath}` })
  }
}

function showNotification() {
  const notif = new Notification({
    title: 'Electron-Benachrichtigung',
    body: 'Dies ist eine Systembenachrichtigung!'
  })
  notif.on('click', () => {
    dialog.showMessageBox({ message⟧'Sie haben auf die Benachrichtigung geklickt!': 'You clicked the notification!' })
  })
  notif.show()
}

function showAbout() {
  dialog.showMessageBox({
    type: 'info',
    title: 'Über',
    message: 'Electron-Demo-Projekt für native Funktionen\n'Version: 1.0.0'
  })
}

// Aufruf des Renderer-Prozesses
ipcMain.handle('show-dialog', async () => {
  const result = await dialog.showMessageBox({
    type: 'info',
    title: 'Vom Hauptprozess',
    message: 'Dies ist ein Dialog, der vom Hauptprozess angezeigt wird!'
  })
  return result.response
})

// Lebenszyklus
app.whenReady().then(() => {
  createWindow()
  createMenu()
  createTray()
  registerShortcuts()
})

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') app.quit()
})

preload.js (sichere Brücke)

Beispiel

const { contextBridge, ipcRenderer } = require('electron')

contextBridge.exposeInMainWorld('electronAPI', {
  showDialog: () => ipcRenderer.invoke('show-dialog')
})

index.html (Frontend-Schnittstelle)

Beispiel

<!DOCTYPE html>
<html lang="zh">
<head>
  <meta charset="UTF-8">
  <title>Demo der nativen Electron-Funktionalität</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((path) => {
filePathEl.textContent = 'Opened file path: ' + path
   })
 </script>
</body>
</html>

Führen Sienpm start之后,功能如下:

  • 顶部菜单栏包含“文件”和“工具”菜单。
  • “文件” → 打开文件 / 保存文件 会调出系统对话框。
  • "Tools" → Systembenachrichtigung anzeigen, das "Über"-Fenster anzeigen.
  • Ein Anwendungssymbol erscheint im Tray-Bereich; mit einem Rechtsklick können Sie ein Menü anzeigen.
  • Nach dem Schließen des Fensters in den Tray minimieren.
  • Globales Tastenkürzel registrierenCmdOrCtrl+Shift+IEntwicklertools öffnen.
Weitere Erweiterungen