@mui/x-data-grid/esm/models/api/gridFocusApi.d.ts

The Community plan edition of the Data Grid components (MUI X).

import { MuiBaseEvent } from '@mui/x-internals/types';
import { GridRowId } from "../gridRows.js";
import { GridColumnGroupIdentifier } from "../../hooks/features/focus/index.js";
export interface GridFocusApi {
  /**
   * Sets the focus to the cell at the given `id` and `field`.
   * @param {GridRowId} id The row id.
   * @param {string} field The column field.
   */
  setCellFocus: (id: GridRowId, field: string) => void;
  /**
   * Sets the focus to the column header at the given `field`.
   * @param {string} field The column field.
   * @param {string} event The event that triggers the action.
   */
  setColumnHeaderFocus: (field: string, event?: MuiBaseEvent) => void;
  /**
   * Sets the focus to the column header filter at the given `field`.
   * @param {string} field The column field.
   * @param {string} event The event that triggers the action.
   */
  setColumnHeaderFilterFocus: (field: string, event?: MuiBaseEvent) => void;
}
export interface GridFocusPrivateApi {
  /**
   * Sets the focus to the column group header at the given `field` and given depth.
   * @param {string} field The column field.
   * @param {number} depth The group depth.
   * @param {object} event The event that triggers the action.
   */
  setColumnGroupHeaderFocus: (field: string, depth: number, event?: MuiBaseEvent) => void;
  /**
   * Gets the focus to the column group header at the given `field` and given depth.
   * @returns {GridColumnGroupIdentifier | null} focused
   */
  getColumnGroupHeaderFocus: () => GridColumnGroupIdentifier | null;
  /**
   * Moves the focus to the cell situated at the given direction.
   * If field is the last and direction=right, the focus goes to the next row.
   * If field is the first and direction=left, the focus goes to the previous row.
   * @param {GridRowId} id The base row id.
   * @param {string} field The base column field.
   * @param {'below' | 'right' | 'left'} direction Which direction is the next cell to focus.
   */
  moveFocusToRelativeCell: (id: GridRowId, field: string, direction: 'below' | 'right' | 'left') => void;
}