Skip to content

Function: useOnEvents()

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

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

Subscribes to events for the host element's lifetime.

Type Parameters

Type ParameterDefault type
E extends Event<unknown, EventType, unknown>Event<unknown, EventType, unknown>

Parameters

ParameterTypeDescription
hostReactiveElementHost element.
optionsUseOnEventsOptionsEvent handling options.

Returns

OnEventController<E>

Event controller.

Examples

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