Interface VirtualGridProxy

Custom ref handle returned by VirtualGrid that exposes imperative methods

Use React.useRef<VirtualGridProxy>(null) to create a ref.

interface VirtualGridProxy {
    get clientHeight(): number;
    get clientWidth(): number;
    get horizontalOffset(): number;
    get verticalOffset(): number;
    scrollTo(rowOffset?: number, columnOffset?: number): void;
    scrollToItem(rowIndex?: number, columnIndex?: number, option?: ScrollToOption): void;
}

Index

Accessors

clientHeight clientWidth horizontalOffset verticalOffset

Methods

scrollTo scrollToItem

Accessors

clientHeight

get clientHeight(): number
Exposes DOM clientHeight property

Returns number
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:27

clientWidth

get clientWidth(): number
Exposes DOM clientWidth property

Returns number
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:24

horizontalOffset

get horizontalOffset(): number
Current horizontal position of scroll bar

Returns number
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:33

verticalOffset

get verticalOffset(): number
Current vertical position of scroll bar

Returns number
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:30

Methods

scrollTo

scrollTo(rowOffset?, columnOffset?): void
Scrolls the list to the specified row and column in pixels
Parameters
- OptionalrowOffset: number
- OptionalcolumnOffset: number
Returns void
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:13

scrollToItem

scrollToItem(rowIndex?, columnIndex?, option?): void
Scrolls the list so that the specified item is visible
Parameters
- OptionalrowIndex: number
  Row of item to scroll to
- OptionalcolumnIndex: number
  Column of item to scroll to
- Optionaloption: ScrollToOption
  Where to position the item within the viewport
Returns void
- Defined in packages/react-virtual-scroll/src/VirtualGridProxy.ts:21