Class OverlaysPlugin

Readonlyconfig

addEventListener

• addEventListener<
      T extends "overlay-click",
      E extends OverlayClickEvent & { type: T },
  >(
      type: T,
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | AddEventListenerOptions,
  ): void

  Type Parameters

  • T extends "overlay-click"

    the name of event
  • E extends OverlayClickEvent & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(e: OverlayClickEvent): boolean

  Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

  MDN Reference

  Parameters

  • e: OverlayClickEvent

  Returns boolean

removeEventListener

• removeEventListener<
      T extends "overlay-click",
      E extends OverlayClickEvent & { type: T },
  >(
      type: "overlay-click",
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | EventListenerOptions,
  ): void

  Type Parameters

  • T extends "overlay-click"

    the name of event
  • E extends OverlayClickEvent & { type: T }

    the class of the event

  Parameters

  • type: "overlay-click"
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

setOption

• setOption<T extends "autoclear">(
      option: T,
      value: UpdatableOverlaysPluginConfig[T],
  ): void

  Update options

  Type Parameters

  • T extends "autoclear"

  Parameters

  • option: T
  • value: UpdatableOverlaysPluginConfig[T]

  Returns void

setOptions

• setOptions(options: Partial<UpdatableOverlaysPluginConfig>): void

  Update options

  Parameters

  • options: Partial<UpdatableOverlaysPluginConfig>

  Returns void