Skip to main content

react-virtuoso

Enumerations​

Interfaces​

Type Aliases​

CalculateViewLocation​

Ƭ CalculateViewLocation: (params: CalculateViewLocationParams) => IndexLocationWithAlign | number | null

Type declaration​

▸ (params): IndexLocationWithAlign | number | null

Parameters​
NameType
paramsCalculateViewLocationParams
Returns​

IndexLocationWithAlign | number | null

Defined in​

dist/index.d.ts:3

FixedFooterContent​

Ƭ FixedFooterContent: () => React_2.ReactNode | null

Defined in​

dist/index.d.ts:95

FixedHeaderContent​

Ƭ FixedHeaderContent: () => React_2.ReactNode | null

Defined in​

dist/index.d.ts:97

FollowOutput​

Ƭ FollowOutput: FollowOutputCallback | FollowOutputScalarType

Defined in​

dist/index.d.ts:110

FollowOutputCallback​

Ƭ FollowOutputCallback: (isAtBottom: boolean) => FollowOutputScalarType

Type declaration​

▸ (isAtBottom): FollowOutputScalarType

Parameters​
NameType
isAtBottomboolean
Returns​

FollowOutputScalarType

Defined in​

dist/index.d.ts:112

FollowOutputScalarType​

Ƭ FollowOutputScalarType: boolean | "smooth" | "auto"

Defined in​

dist/index.d.ts:114

GridListProps​

Ƭ GridListProps: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children" | "ref" | "className"> & { data-test-id: string }

Passed to the Components.List custom component

Defined in​

dist/index.d.ts:180

GridRootProps​

Ƭ GridRootProps: Omit<React_2.HTMLProps<HTMLDivElement>, "ref" | "data">

Defined in​

dist/index.d.ts:184

GroupProps​

Ƭ GroupProps: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children"> & { data-index: number ; data-item-index: number ; data-known-size: number }

Defined in​

dist/index.d.ts:265

IndexLocationWithAlign​

Ƭ IndexLocationWithAlign: FlatIndexLocationWithAlign | GroupIndexLocationWithAlign

Defined in​

dist/index.d.ts:271

ItemProps​

Ƭ ItemProps<D>: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children"> & { data-index: number ; data-item-group-index?: number ; data-item-index: number ; data-known-size: number ; item: D }

Type parameters​

Name
D

Defined in​

dist/index.d.ts:284

ListItem​

Ƭ ListItem<D>: RecordItem<D> | GroupItem<D>

Type parameters​

Name
D

Defined in​

dist/index.d.ts:292

ListProps​

Ƭ ListProps: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children" | "ref"> & { data-test-id: string }

Passed to the Components.List custom component

Defined in​

dist/index.d.ts:297

ListRootProps​

Ƭ ListRootProps: Omit<React_2.HTMLProps<HTMLDivElement>, "ref" | "data">

Defined in​

dist/index.d.ts:306

ScrollIntoViewLocation​

Ƭ ScrollIntoViewLocation: FlatScrollIntoViewLocation | GroupedScrollIntoViewLocation

Defined in​

dist/index.d.ts:351

ScrollerProps​

Ƭ ScrollerProps: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children" | "tabIndex" | "ref"> & { data-test-id?: string ; data-virtuoso-scroller?: boolean }

Passed to the Components.Scroller custom component

Defined in​

dist/index.d.ts:346

SizeFunction​

Ƭ SizeFunction: (el: HTMLElement, field: "offsetHeight" | "offsetWidth") => number

Type declaration​

▸ (el, field): number

Calculates the height of el, which will be the Item element in the DOM.

Parameters​
NameType
elHTMLElement
field"offsetHeight" | "offsetWidth"
Returns​

number

Defined in​

dist/index.d.ts:416

StateCallback​

Ƭ StateCallback: (state: StateSnapshot) => void

Type declaration​

▸ (state): void

Parameters​
NameType
stateStateSnapshot
Returns​

void

Defined in​

dist/index.d.ts:424

TableBodyProps​

Ƭ TableBodyProps: Pick<React_2.ComponentPropsWithRef<"tbody">, "style" | "children" | "ref" | "className"> & { data-test-id: string }

Passed to the Components.TableBody custom component

Defined in​

dist/index.d.ts:434

TableProps​

Ƭ TableProps: Pick<React_2.ComponentPropsWithRef<"table">, "style" | "children">

Defined in​

dist/index.d.ts:501

TableRootProps​

Ƭ TableRootProps: Omit<React_2.HTMLProps<HTMLTableElement>, "ref" | "data">

Defined in​

dist/index.d.ts:503

TopItemListProps​

Ƭ TopItemListProps: Pick<React_2.ComponentPropsWithRef<"div">, "style" | "children">

Defined in​

dist/index.d.ts:693

Variables​

VirtuosoGridMockContext​

• Const VirtuosoGridMockContext: React_2.Context<VirtuosoGridMockContextValue | undefined>

Defined in​

dist/index.d.ts:709

VirtuosoMockContext​

• Const VirtuosoMockContext: React_2.Context<VirtuosoMockContextValue | undefined>

Defined in​

dist/index.d.ts:844

Functions​

GroupedVirtuoso​

▸ GroupedVirtuoso<ItemData, Context>(props): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
ItemDataany
Contextany

Parameters​

NameType
propsGroupedVirtuosoProps<ItemData, Context> & { ref?: Ref<GroupedVirtuosoHandle> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

dist/index.d.ts:203

TableVirtuoso​

▸ TableVirtuoso<ItemData, Context>(props): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
ItemDataany
Contextany

Parameters​

NameType
propsTableVirtuosoProps<ItemData, Context> & { ref?: Ref<TableVirtuosoHandle> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

dist/index.d.ts:505

Virtuoso​

▸ Virtuoso<ItemData, Context>(props): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
ItemDataany
Contextany

Parameters​

NameType
propsVirtuosoProps<ItemData, Context> & { ref?: Ref<VirtuosoHandle> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

dist/index.d.ts:695

VirtuosoGrid​

▸ VirtuosoGrid<ItemData, Context>(props): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
ItemDataany
Contextany

Parameters​

NameType
propsVirtuosoGridProps<ItemData, Context> & { ref?: Ref<VirtuosoGridHandle> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

dist/index.d.ts:699