Skip to content

useEventBus

基本的事件总线。

¥A basic event bus.

示例

News channel:
Television:
--- no signal ---

用法

¥Usage

ts
import { 
useEventBus
} from '@vueuse/core'
const
bus
=
useEventBus
<string>('news')
function
listener
(
event
: string) {
console
.
log
(`news: ${
event
}`)
} // listen to an event const
unsubscribe
=
bus
.
on
(
listener
)
// fire an event
bus
.
emit
('The Tokyo Olympics has begun')
// unregister the listener
unsubscribe
()
// or
bus
.
off
(
listener
)
// clearing all listeners
bus
.
reset
()
js
import { useEventBus } from '@vueuse/core'
const bus = useEventBus('news')
function listener(event) {
  console.log(`news: ${event}`)
}
// listen to an event
const unsubscribe = bus.on(listener)
// fire an event
bus.emit('The Tokyo Olympics has begun')
// unregister the listener
unsubscribe()
// or
bus.off(listener)
// clearing all listeners
bus.reset()

当组件卸载时,在组件 setup 内部注册的监听器将自动取消注册。

¥Listeners registered inside of components setup will be unregistered automatically when the component gets unmounted.

TypeScript

使用 EventBusKey 为 key 将事件类型绑定到 key 上,类似于 Vue 的 InjectionKey util。

¥Using EventBusKey is the key to bind the event type to the key, similar to Vue's InjectionKey util.

ts
// fooKey.ts
import type { 
EventBusKey
} from '@vueuse/core'
export const
fooKey
:
EventBusKey
<{
name
:
foo
}> =
Symbol
('symbol-key')
js
export const fooKey = Symbol('symbol-key')
ts
import { 
useEventBus
} from '@vueuse/core'
import {
fooKey
} from './fooKey'
const
bus
=
useEventBus
(
fooKey
)
bus
.
on
((
e
) => {
// `e` will be `{ name: foo }` })