Installation

npm install --save @types/react-infinite-scroller

Summary

This package contains type definitions for react-infinite-scroller (https://github.com/CassetteRocks/react-infinite-scroller).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-infinite-scroller.

index.d.ts

1import * as React from "react";
2
3declare namespace InfiniteScroll {
4    /**
5     * <InfiniteScroll /> properties.
6     */
7    interface InfiniteScrollProps extends React.HTMLProps<InfiniteScroll> {
8        /**
9         * Name of the element that the component should render as.
10         * Defaults to 'div'.
11         */
12        element?: React.ReactNode | string | undefined;
13        /**
14         * Whether there are more items to be loaded. Event listeners are removed if false.
15         * Defaults to false.
16         */
17        hasMore?: boolean | undefined;
18        /**
19         * Whether the component should load the first set of items.
20         * Defaults to true.
21         */
22        initialLoad?: boolean | undefined;
23        /**
24         * Whether new items should be loaded when user scrolls to the top of the scrollable area.
25         * Default to false.
26         */
27        isReverse?: boolean | undefined;
28        /**
29         * A callback for when more items are requested by the user.
30         * Page param is next page index.
31         */
32        loadMore(page: number): void;
33        /**
34         * The number of the first page to load, with the default of 0, the first page is 1.
35         * Defaults to 0.
36         */
37        pageStart?: number | undefined;
38        /**
39         * The distance in pixels before the end of the items that will trigger a call to loadMore.
40         * Defaults to 250.
41         */
42        threshold?: number | undefined;
43        /**
44         * Proxy to the useCapture option of the added event listeners.
45         * Defaults to false.
46         */
47        useCapture?: boolean | undefined;
48        /**
49         * Add scroll listeners to the window, or else, the component's parentNode.
50         * Defaults to true.
51         */
52        useWindow?: boolean | undefined;
53        /**
54         * Loader component for indicating "loading more".
55         */
56        loader?: React.ReactElement | undefined;
57        /**
58         * Override method to return a different scroll listener if it's not the immediate parent of InfiniteScroll.
59         */
60        getScrollParent?(): HTMLElement | null;
61    }
62    class InfiniteScroll extends React.Component<InfiniteScrollProps> {
63        getParentElement(elem?: HTMLElement | null): HTMLElement | undefined | null;
64    }
65    namespace InfiniteScroll {}
66}
67
68export = InfiniteScroll.InfiniteScroll;
69

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/react

Credits

These definitions were written by Lauri Lavanti, Piotr Srebniak, Brett Miller, and Yipeng Zhao.