listenDocument()

function listenDocument(name: keyof DocumentEventMap, options?: AddEventListenerOptions): MethodDecorator;

Decorator to listen to document events within a lit component. Adds the listener when the component connects and removes it when it disconnects.

Parameters

name

keyof DocumentEventMap

the document event to listen for, e.g. click or keydown

options?

AddEventListenerOptions

optional event listener options, e.g. { passive: true }

Returns

MethodDecorator

Example

class MyComponent extends LitElement {
  ⁠@listenDocument('keydown')
  handleKeydown(event: KeyboardEvent) {}
}