https://github.com/kisstar/electron-events
A module that provides cross process event communication for Electron. Inspired by Sugar-Electron
https://github.com/kisstar/electron-events
electron events nodejs
Last synced: 5 months ago
JSON representation
A module that provides cross process event communication for Electron. Inspired by Sugar-Electron
- Host: GitHub
- URL: https://github.com/kisstar/electron-events
- Owner: kisstar
- License: mit
- Created: 2023-02-18T08:50:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T11:46:12.000Z (over 1 year ago)
- Last Synced: 2025-10-18T19:47:13.768Z (8 months ago)
- Topics: electron, events, nodejs
- Language: TypeScript
- Homepage:
- Size: 134 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# electron-events
为 Electron 提供跨进程的事件通信系统。
[English](./README.md) . 中文
## 安装
```bash
# use npm
npm install electron-events
# or use yarn
yarn add electron-events
```
## 使用
在主进程中，以窗口名称为标识将其添加到事件系统的窗口池中：
```js
// main.js
import { useEvents } from 'electron-events/main';
const events = useEvents();
const mainWindow = new BrowserWindow();
events.addWindow(
/* The name here will be used later to specify the target or recipient of the event triggered. */
'app',
mainWindow
);
```
然后，通过预加载脚本将依赖传递给渲染进程：：
```js
// preload.js
import { contextBridge } from 'electron';
import { PRELOAD_DEPENDENCIES as EVENTS_PRELOAD_DEPENDENCIES } from 'electron-events/preload';
contextBridge.exposeInMainWorld('electronAPI', {
EVENTS_PRELOAD_DEPENDENCIES
});
```
之后，您不必关心所处的进程，只需根据窗口的名称来传播事件：
```js
// renderer.js
import { useEvents as useRendererEvents } from 'electron-events/renderer';
const useEvents = () =>
useRendererEvents(window.electronAPI.EVENTS_PRELOAD_DEPENDENCIES); // 记得注入依赖
const events = useEvents();
events.on('main' /* Name of the main process */, 'say_hi', text => {
console.log(text);
});
// main.js
import { useEvents } from 'electron-events/main';
const events = useEvents();
events.emitTo('app', 'say_hi', 'Hello World!');
```
正如您所看到的，事件可以在主进程或渲染器进程中发送和接收。
[查看更多](https://github.com/kisstar/electron-events/blob/main/packages/docs/zh/index.md).
## License
MIT