UNPKG

@react-hook/event

Version:

A React hook for managing event listeners, e.g. removing events when a component unmounts.

github.com/jaredLunde/react-hook/tree/master/packages/event

jaredLunde/react-hook

39 lines (38 loc) • 1.27 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import * as React from 'react' declare function useEvent< T extends Window = Window, K extends keyof WindowEventMap = keyof WindowEventMap >( target: Window | null, type: K, listener: WindowEventListener<K>, cleanup?: (...args: any[]) => void ): void declare function useEvent< T extends Document = Document, K extends keyof DocumentEventMap = keyof DocumentEventMap >( target: Document | null, type: K, listener: DocumentEventListener<K>, cleanup?: (...args: any[]) => void ): void declare function useEvent< T extends HTMLElement = HTMLElement, K extends keyof HTMLElementEventMap = keyof HTMLElementEventMap >( target: React.RefObject<T> | T | null, type: K, listener: ElementEventListener<K>, cleanup?: (...args: any[]) => void ): void export declare type ElementEventListener< K extends keyof HTMLElementEventMap = keyof HTMLElementEventMap > = (this: HTMLElement, ev: HTMLElementEventMap[K]) => any export declare type DocumentEventListener< K extends keyof DocumentEventMap = keyof DocumentEventMap > = (this: Document, ev: DocumentEventMap[K]) => any export declare type WindowEventListener< K extends keyof WindowEventMap = keyof WindowEventMap > = (this: Document, ev: WindowEventMap[K]) => any export default useEvent