Interface GridImperativeAPI

lib/components/grid/types.ts:246–314

 * ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience use in TypeScript projects.
 */
export interface GridImperativeAPI {
  /**
   * Outermost HTML element for the grid if mounted and null (if not mounted.
   */
  get element(): HTMLDivElement | null;

  /**
   * Scrolls the grid so that the specified row and column are visible.
   *
   * @param behavior Determines whether scrolling is instant or animates smoothly
   * @param columnAlign Determines the horizontal alignment of the element within the list
   * @param columnIndex Index of the column to scroll to (0-based)
   * @param rowAlign Determines the vertical alignment of the element within the list
   * @param rowIndex Index of the row to scroll to (0-based)
   *
   * @throws RangeError if an invalid row or column index is provided
   */
  scrollToCell: ({
    behavior,
    columnAlign,
    columnIndex,
    rowAlign,
    rowIndex
  }: {
    behavior?: "auto" | "instant" | "smooth";
    columnAlign?: "auto" | "center" | "end" | "smart" | "start";
    columnIndex: number;
    rowAlign?: "auto" | "center" | "end" | "smart" | "start";
    rowIndex: number;
  }) => void;

  /**
   * Scrolls the grid so that the specified column is visible.
   *
   * @param align Determines the horizontal alignment of the element within the list
   * @param behavior Determines whether scrolling is instant or animates smoothly
   * @param index Index of the column to scroll to (0-based)
   *
   * @throws RangeError if an invalid column index is provided
   */
  scrollToColumn: ({
    align,
    behavior,
    index
  }: {
    align?: "auto" | "center" | "end" | "smart" | "start";
    behavior?: "auto" | "instant" | "smooth";
    index: number;
  }) => void;

  /**
   * Scrolls the grid so that the specified row is visible.
   *
   * @param align Determines the vertical alignment of the element within the list
   * @param behavior Determines whether scrolling is instant or animates smoothly
   * @param index Index of the row to scroll to (0-based)
   *
   * @throws RangeError if an invalid row index is provided