Function: useOnEvents()

function useOnEvents<E>(host: ReactiveElement, options: UseOnEventsOptions<E>): OnEventController<E>;

Defined in: src/wirestate-lit/events/use-on-events.ts:59

Subscribes to events for the host element's lifetime.

Type Parameters

Type Parameter	Default type
E extends WireEvent<unknown, EventType, unknown>	WireEvent<unknown, EventType, unknown>

Parameters

Parameter	Type	Description
host	ReactiveElement	Host element.
options	UseOnEventsOptions<E>	Event handling options.

Returns

OnEventController<E>

Event controller.

Remarks

Registers when the host connects, unregisters when it disconnects, and re-subscribes when the nearest container context changes. Omit types, or pass null, to receive every event.

Examples

class MyElement extends LitElement {
  private eventHandler = useOnEvents(this, {
    handler: (event) => console.log(event),
  });
}

class MyElement extends LitElement {
  private eventHandler = useOnEvents(this, {
    types: ["MY_EVENT"],
    handler: (event) => console.log(event),
  });
}