Skip to content

on

The on function adds an event listener to a target DOM element.

Syntax

typescript
on<K extends keyof HTMLElementEventMap>(
  target: HTMLElement | Document | Window,
  type: K,
  listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
  options?: boolean | AddEventListenerOptions
): void;

Parameters

NameTypeDescription
targetHTMLElement | Document | WindowTarget element for the event
typestringEvent type (e.g., "click")
listener(this: HTMLElement, ev: HTMLElementEventMap[K]) => anyFunction called when the event occurs
optionsboolean | AddEventListenerOptions (optional)Additional options for the listener

Returns

NameTypeDescription
voidDoes not return a value

Examples

typescript
on(window, "resize", () => {
  console.log("Window resized");
});

on(document, "visibilitychange", () => {
  // ...
});

Notes

  • Useful for abstracting typed event addition.

References

Released under the MIT License.