API.md

API

Table of contents

Functions

• VList
• VGrid

Interfaces

• VListProps
• VListHandle
• CustomItemComponentProps
• VGridProps
• VGridHandle
• CustomCellComponentProps
• CustomWindowComponentProps

Type Aliases

• CustomItemComponent
• ScrollMode
• CustomCellComponent
• WindowComponentAttributes
• CustomWindowComponent

Functions

VList

▸ VList(props): ReactNode

Virtualized list component. See VListProps and VListHandle.

Parameters

Name	Type
props	VListProps & RefAttributes<VListHandle>

Returns

ReactNode

Defined in

node_modules/@types/react/index.d.ts:386

---

VGrid

▸ VGrid(props): ReactNode

Virtualized grid component. See VGridProps and VGridHandle.

Parameters

Name	Type
props	VGridProps & RefAttributes<VGridHandle>

Returns

ReactNode

Defined in

node_modules/@types/react/index.d.ts:386

Type Aliases

CustomItemComponent

Ƭ CustomItemComponent: React.ForwardRefExoticComponent<React.PropsWithoutRef<CustomItemComponentProps> & React.RefAttributes<any>>

Defined in

src/react/VList.tsx:151

---

ScrollMode

Ƭ ScrollMode: "reverse" | "rtl"

Defined in

src/react/VList.tsx:32

---

CustomCellComponent

Ƭ CustomCellComponent: React.ForwardRefExoticComponent<React.PropsWithoutRef<CustomCellComponentProps> & React.RefAttributes<any>>

Defined in

src/react/VGrid.tsx:38

---

WindowComponentAttributes

Ƭ WindowComponentAttributes: Pick<React.HTMLAttributes<HTMLElement>, "className" | "style" | "id" | "role" | "tabIndex"> & React.AriaAttributes

Defined in

src/react/DefaultWindow.tsx:9

---

CustomWindowComponent

Ƭ CustomWindowComponent: typeof DefaultWindow

Defined in

src/react/DefaultWindow.tsx:63