@wpkernel/ui v0.12.1-beta.3

---

@wpkernel/ui / subscribeToDataViewsEvent

Function: subscribeToDataViewsEvent()

function subscribeToDataViewsEvent<TName>(
   runtime, 
   eventName, 
   listener, 
   options?): () => void;

Subscribes to a specific DataViews event and optionally bridges it to WordPress hooks.

Type Parameters

TName

TName extends keyof DataViewsEventPayloadMap

Parameters

runtime

ObservableRuntime

A DataViews controller or runtime context.

eventName

TName

The event name to subscribe to.

listener

Listener<TName>

Callback invoked when the event fires.

options?

SubscribeToDataViewsEventOptions = {}

Optional configuration.

Returns

Cleanup function that unsubscribes the listener.

(): void;

Returns

void

Example

const unsubscribe = subscribeToDataViewsEvent(
  runtime.dataviews,
  DATA_VIEWS_EVENT_VIEW_CHANGED,
  (payload) => console.log('View changed', payload)
);