Function: onEvent()

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

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

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

Type Parameters

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

Parameters

Parameter	Type	Description
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, unregistered when it disconnects, and re-subscribed when the nearest container context changes. Omit types to receive every event from the active event bus.

Examples

class MyElement extends LitElement {
  @onEvent()
  private onMyEvent(event: WireEvent) {
    console.log("Event received:", event);
  }
}

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

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