Skip to main content

Function: useDispatcher()

Call Signature​

useDispatcher<E>(event?, listener?): useDispatcherType

Defined in: packages/react-page-renderer/src/hooks/dispatcher.ts:38

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.

Type Parameters​

E​

E extends keyof DispatcherEventsMap

Parameters​

event?​

E

Event name.

listener?​

DispatcherListener<DispatcherEventsMap[E]>

Callback to register to dispatcher.

Returns​

useDispatcherType

Dispatcher fire method.

Example​

const { fire } = useDispatcher(
	'dispatcher-event',
	() => {}
);

// Access $Dispatcher's.fire method without registering listener
const { fire } = useDispatcher();

// Firing custom event
useEffect(() => {
	fire('another-event', { data: {} })
});

Call Signature​

useDispatcher(event?, listener?): useDispatcherType

Defined in: packages/react-page-renderer/src/hooks/dispatcher.ts:42

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​

event?​

string

Event name.

listener?​

DispatcherListener<any>

Callback to register to dispatcher.

Returns​

useDispatcherType

Dispatcher fire method.

Example​

const { fire } = useDispatcher(
	'dispatcher-event',
	() => {}
);

// Access $Dispatcher's.fire method without registering listener
const { fire } = useDispatcher();

// Firing custom event
useEffect(() => {
	fire('another-event', { data: {} })
});