Skip to content

Latest commit

 

History

History
162 lines (93 loc) · 4.03 KB

API.md

File metadata and controls

162 lines (93 loc) · 4.03 KB

API

Table of contents

Functions

Interfaces

Type Aliases

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:392


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:392


WVList

WVList(props): ReactNode

Virtualized list component controlled by the window scrolling. See WVListProps and WVListHandle.

Parameters

Name Type
props WVListProps & RefAttributes<WVListHandle>

Returns

ReactNode

Defined in

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

Type Aliases

ScrollToIndexAlign

Ƭ ScrollToIndexAlign: "start" | "end"

Alignment of item when calling scrollToIndex method.

  • start(default): Align the item to the start of the list.
  • end: Align the item to the end of the list.

Defined in

src/core/types.ts:25


ScrollMode

Ƭ ScrollMode: "reverse" | "rtl"

Defined in

src/react/VList.tsx:35


CustomCellComponent

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

Defined in

src/react/VGrid.tsx:43


ViewportComponentAttributes

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

Defined in

src/react/Viewport.tsx:9


CustomViewportComponent

Ƭ CustomViewportComponent: typeof Viewport

Defined in

src/react/Viewport.tsx:63


CustomItemComponent

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

Defined in

src/react/ListItem.tsx:23