Skip to content

Function: onEvent()

ts
function onEvent<E>(types?: 
  | EventType
| readonly EventType[]): OnEventDecorator<E>;

Defined in: src/wirestate-lit/events/on-event.ts:67

Decorator for Lit element methods that handle events from the event bus.

Type Parameters

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

Parameters

ParameterTypeDescription
types?| EventType | readonly EventType[]Event types to listen for. If omitted, all events will be handled.

Returns

OnEventDecorator<E>

A method decorator function.

Remarks

The handler is registered when the host connects and unregistered when it disconnects.

Examples

typescript
class MyElement extends LitElement {
  @onEvent()
  private onMyEvent(event: Event) {
    console.log("Event received:", event);
  }
}
typescript
class MyElement extends LitElement {
  @onEvent("MY_EVENT_TYPE")
  private onMyEvent(event: MyEvent) {
    console.log("Event received:", event);
  }
}
typescript
class MyElement extends LitElement {
  @onEvent(["MY_EVENT_TYPE_1", "MY_EVENT_TYPE_2"])
  private onMyEvent(event: Event) {
    console.log("Event received:", event);
  }
}