@ equinor/ 组合框架- 模块- 事件

Async事件为Fusion框架发送模块. 通过以本地 DOM 为模式的事件系统,实现框架模块(兄弟姐妹)之间以及父母/子女之间的类型安全通信 EventTarget不过 同步发送 因此可以正确等待可取消的事件.

重要内容: 发送时a cancelable 事件 必须 await 页:1 dispatchEvent 电话 发射而无 await 表示 preventDefault() 听众的电话不会被尊重.

谁应该用这个

• 模块作者 其他模块可以作出反应.
• 应用程序开发者 想要截取、记录或取消流经框架的事件.
• 图书馆消费者 用于分析、调试或交叉关切.

文档

快开始

安装

pnpm add @equinor/fusion-framework-module-event

事件模块在初始化Fusion框架时默认包含在内,因此只有在独立使用时才需要明确安装.

听一个事件

const teardown = modules.event.addEventListener('onModulesLoaded', (event) => {
  console.log('All modules loaded:', event.detail);
});

// remove the listener when no longer needed
teardown();

发送活动

const event = await modules.event.dispatchEvent('myEvent', {
  detail: { id: 42 },
  cancelable: true,
});

if (!event.canceled) {
  performAction();
}

API 概览

子路径