Module lib/hooks/useEventListener

Index

Functions

Functions

useElementListener

useElementListener<K, T>(eventName: K, handler: ((event: HTMLElementEventMap[K]) => void), targetRef: RefObject<T>): void

- Defined in src/lib/hooks/useEventListener/index.ts:9
Handles automatically adding/removing event listeners from DOM elements.

Type Parameters
- K extends keyof HTMLElementEventMap
- T extends HTMLElement = HTMLDivElement
Parameters
- eventName: K
  
  The event to listen on
- handler: ((event: HTMLElementEventMap[K]) => void)
  
  The listener function, receives the event that was triggered
  - - (event: HTMLElementEventMap[K]): void
    - Parameters
      - event: HTMLElementEventMap[K]
      Returns void
- targetRef: RefObject<T>
  
  Ref to the DOM element
Returns void

useWindowListener

useWindowListener<K>(eventName: K, handler: ((event: WindowEventMap[K]) => void)): void

- Defined in src/lib/hooks/useEventListener/index.ts:42
Handles automatically adding/removing event listeners on the window

Type Parameters
- K extends keyof WindowEventMap
Parameters
- eventName: K
  
  The event to listen on
- handler: ((event: WindowEventMap[K]) => void)
  
  The listener function, receives the event that was triggered
  - - (event: WindowEventMap[K]): void
    - Parameters
      - event: WindowEventMap[K]
      Returns void
Returns void

useDocumentListener

useDocumentListener<K>(eventName: K, handler: ((event: DocumentEventMap[K]) => void)): void

- Defined in src/lib/hooks/useEventListener/index.ts:74
Handles automatically adding/removing event listeners on the window

Type Parameters
- K extends keyof DocumentEventMap
Parameters
- eventName: K
  
  The event to listen on
- handler: ((event: DocumentEventMap[K]) => void)
  
  The listener function, receives the event that was triggered
  - - (event: DocumentEventMap[K]): void
    - Parameters
      - event: DocumentEventMap[K]
      Returns void
Returns void

Generated using TypeDoc