Installation

npm install --save @types/element-resize-detector

Summary

This package contains type definitions for element-resize-detector (https://github.com/wnr/element-resize-detector).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/element-resize-detector.

index.d.ts

1declare function elementResizeDetectorMaker(
2    options?: elementResizeDetectorMaker.ErdmOptions,
3): elementResizeDetectorMaker.Erd;
4
5declare namespace elementResizeDetectorMaker {
6    interface ErdmOptions {
7        strategy?: "scroll" | "object" | undefined;
8        /**
9         * A custom reporter that handles reporting logs, warnings and errors.
10         * If not provided, a default id handler will be used.
11         * If set to false, then nothing will be reported.
12         */
13        reporter?: ReporterProps | undefined;
14
15        /**
16         * Determines if listeners should be called when they are getting added.
17         * If true, the listener is guaranteed to be called when it has been added.
18         * If false, the listener will not be guarenteed to be called when
19         * it has been added (does not prevent it from being called).
20         *
21         * @default true
22         */
23        callOnAdd?: boolean | undefined;
24
25        /**
26         * A custom id handler that is responsible for generating,
27         * setting and retrieving id's for elements.
28         * If not provided, a default id handler will be used.
29         */
30        idHandler?: IdHandlerProps | undefined;
31
32        /**
33         * If set to true, the the system will report debug messages as default
34         * for the listenTo method.
35         */
36        debug?: boolean | undefined;
37    }
38
39    interface IdHandlerProps {
40        get(element: HTMLElement, readonly: boolean): string;
41        set(element: HTMLElement): string;
42    }
43
44    interface ReporterProps {
45        log(idOrText: string, textOrId: string, element?: HTMLElement): void;
46        warn(text: string, element?: HTMLElement): void;
47        error(text: string): void;
48    }
49
50    interface Erd {
51        listenTo(element: HTMLElement, callback: (elem: HTMLElement) => void): void;
52        removeListener(element: HTMLElement, callback: (elem: HTMLElement) => void): void;
53        removeAllListeners(element: HTMLElement): void;
54        uninstall(element: HTMLElement): void;
55    }
56}
57
58export = elementResizeDetectorMaker;
59

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: none

Credits

These definitions were written by Saransh Kataria, and Frank Li.