Data Grid - Scrolling

This section presents how to programmatically control the scroll.

Scrolling to specific cells

You can scroll to a specific cell by calling apiRef.current.scrollToIndexes(). The only argument that must be passed is an object containing the row index and the column index of the cell to scroll. If the row or column index is not present, the grid will not do any movement in the missing axis.

The following demo explores the usage of this API:

apiRef

⚠️ Only use this API as the last option. Give preference to the props to control the grid.

getScrollPosition()

Returns the current scroll position.

Signature:

getScrollPosition: () => GridScrollParams

scroll()

Triggers the viewport to scroll to the given positions (in pixels).

Signature:

scroll: (params: Partial<GridScrollParams>) => void

scrollToIndexes()

Triggers the viewport to scroll to the cell at indexes given by params. Returns true if the grid had to scroll to reach the target.

Signature:

scrollToIndexes: (params: Partial<GridCellIndexCoordinates>) => boolean