@types/react-list
Version:
TypeScript definitions for react-list
53 lines (44 loc) • 1.94 kB
Markdown
# Installation
> `npm install --save @types/react-list`
# Summary
This package contains type definitions for react-list (https://github.com/coderiety/react-list).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-list.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-list/index.d.ts)
````ts
import { Component, JSX } from "react";
type ItemRenderer = (index: number, key: number | string) => JSX.Element;
type ItemsRenderer = (items: JSX.Element[], ref: string) => JSX.Element;
type ItemSizeEstimator = (index: number, cache: {}) => number;
type ItemSizeGetter = (index: number) => number;
type ScrollParentGetter = () => JSX.Element;
interface ReactListProps extends React.RefAttributes<ReactList> {
children?: React.ReactNode;
axis?: "x" | "y" | undefined;
initialIndex?: number | undefined;
itemRenderer?: ItemRenderer | undefined;
itemSizeEstimator?: ItemSizeEstimator | undefined;
itemSizeGetter?: ItemSizeGetter | undefined;
itemsRenderer?: ItemsRenderer | undefined;
length?: number | undefined;
minSize?: number | undefined;
pageSize?: number | undefined;
scrollParentGetter?: ScrollParentGetter | undefined;
threshold?: number | undefined;
type?: string | undefined;
useStaticSize?: boolean | undefined;
useTranslate3d?: boolean | undefined;
}
declare class ReactList extends Component<ReactListProps> {
scrollTo(index: number): void;
scrollAround(index: number): void;
getVisibleRange(): number[];
}
declare namespace ReactList {}
export = ReactList;
````
### Additional Details
* Last updated: Fri, 01 Mar 2024 01:31:11 GMT
* Dependencies: [@types/react](https://npmjs.com/package/@types/react)
# Credits
These definitions were written by [Yifei Yan](https://github.com/buptyyf), and [Tom Shen](https://github.com/tomshen).