GTKX

API Reference / @gtkx/navigation / EventConsumer

Type Alias: EventConsumer<EventMap> ​

EventConsumer<EventMap> = object

Type Parameters ​

EventMap ​

EventMap extends EventMapBase

Methods ​

addListener() ​

addListener<EventName>(type, callback): () => void

Subscribe to events from the parent navigator.

Type Parameters ​

EventName ​

EventName extends string

Parameters ​

type ​

EventName

Type of the event (e.g. focus, blur)

callback ​

EventListenerCallback<EventMap, EventName>

Callback listener which is executed upon receiving the event.

Returns ​

() => void

removeListener() ​

removeListener<EventName>(type, callback): void

Type Parameters ​

EventName ​

EventName extends string

Parameters ​

type ​

EventName

callback ​

EventListenerCallback<EventMap, EventName>

Returns ​

void