Function: useEventBus()

useEventBus(eventTarget?, eventName?, listener?): useEventBusType

Defined in: packages/react-page-renderer/src/hooks/eventBus.ts:27

Hook to register listeners for dispatcher events. Returns decorated dispatcher fire function. Omitting hook params doesn't register any events to the dispatcher but provides access to the dispatcher's fire method.

Parameters

eventTarget?

null | EventTarget

eventName?

string

listener?

EventBusListener

Returns

useEventBusType

Dispatcher fire method.

Example

const { fire } = useEventBus(
	componentRef.current,
	'event',
 () => {}
);