useEventBus

useEventBus(): object

Defined in: useEventBus.ts:131

Hook to create an event bus for plugin communication.

This provides a simple pub/sub mechanism that allows the application to communicate with plugins without tight coupling.

Returns

emit()

emit: <K>(event, payload) => void

Emit an event to all subscribers

Type Parameters

K

K extends keyof SeizenTableEventMap<unknown> | string & object

Parameters

event

K

payload

K extends keyof SeizenTableEventMap<unknown> ? SeizenTableEventMap<unknown>[K<K>] : unknown

Returns

void

subscribe()

subscribe: <K>(event, callback) => () => void

Subscribe to an event

Type Parameters

K

K extends keyof SeizenTableEventMap<unknown> | string & object

Parameters

event

K

callback

(payload) => void

Returns

Unsubscribe function

(): void

Returns

void

Example

// In useSeizenTable:
const eventBus = useEventBus();

// Application emits events:
eventBus.emit("row-click", row);

// Plugins subscribe via usePluginContext:
const { useEvent } = usePluginContext();
useEvent("row-click", (row) => {
  console.log("Row clicked:", row);
});