Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "helpers/subscribeEvent"

Index

Functions

Functions

subscribeEvent

  • subscribeEvent(element: HTMLElement | Document | Window, eventName: string, listener: (event?: Event) => void, useCapture?: boolean): () => void
  • Subscribe to UI event.

    Parameters

    • element: HTMLElement | Document | Window

      Target element.

    • eventName: string

      Event name to subscribe.

    • listener: (event?: Event) => void

      Event listener.

        • (event?: Event): void
        • Parameters

          • Optional event: Event

          Returns void

    • Default value useCapture: boolean = false

      Capture phase or bubble.

    Returns () => void

    Unsubscribe from event.

      • (): void
      • Returns void

Generated using TypeDoc