@mui/x-data-grid/models/gridSortModel.d.ts

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

import { GridRowId, GridTreeNode } from "./gridRows.js";
export type GridSortDirection = 'asc' | 'desc' | null | undefined;
export interface GridSortCellParams<V = any> {
  id: GridRowId;
  field: string;
  value: V;
  rowNode: GridTreeNode;
  api: any;
}
/**
 * The type of the sort comparison function.
 * @param {V} v1 The first value to compare.
 * @param {V} v2 The second value to compare.
 * @param {GridSortCellParams<V>} cellParams1 The parameters of the first cell.
 * @param {GridSortCellParams<V>} cellParams2 The parameters of the second cell.
 * @returns {number} The result of the comparison.
 */
export type GridComparatorFn<V = any> = (v1: V, v2: V, cellParams1: GridSortCellParams<V>, cellParams2: GridSortCellParams<V>) => number;
/**
 * Object that represents the column sorted data, part of the [[GridSortModel]].
 */
export interface GridSortItem {
  /**
   * The column field identifier.
   */
  field: string;
  /**
   * The direction of the column that the grid should sort.
   */
  sort: GridSortDirection;
}
/**
 * The model used for sorting the grid.
 */
export type GridSortModel = readonly GridSortItem[];