上手指南
Hooks 列表
后期规划
上手指南
Hooks 列表
后期规划
简体中文

useEventBus

Tags:
Utilities

一个提供简单事件总线的 React Hook。

演示

源码
Child Component
I will catch all the event emitted by parent
A:
0
B:
0
C:
0

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

🪝 Hook🎨 Demo📄 Document

API

const { on, once, off, emit, reset } = useEventBus(identifier, options)

标识符 Identifier

export type EventBusIdentifier = symbol | string | number

选项 Options

export type UseEventBusOptions = { /** * 是否在组件卸载时自动清理监听器。 * * @defaultValue true */ autoCleanup?: boolean }

返回值

export type UseEventBusReturns<T, P> = { /** * 订阅一个事件。调用 emit 时，监听器会执行。 * * @param listener 观察监听器。 * @returns 一个停止函数用于移除当前的回调。 */ on: (listener: EventBusListener<T, P>) => AnyFunc /** * 类似于 `on`，但只触发一次 * * @param listener 观察监听器。 * @returns 一个停止函数用于移除当前的回调。 */ once: (listener: EventBusListener<T, P>) => AnyFunc /** * 发出一个事件，对应的事件监听器会执行。 * * @param event 发送的数据。 */ emit: (event?: T, payload?: P) => void /** * 移除对应的监听器。 * * @param listener 观察监听器。 */ off: (listener: EventBusListener<T>) => void /** * 在全局范围内清除所有事件 */ reset(): void /** * 清除当前组件上下文中的所有监听器 */ cleanup(): void }