@mui/x-data-grid-premium/hooks/features/history/gridHistoryInterfaces.d.ts

The Premium plan edition of the MUI X Data Grid Components.

import type { GridRowId, GridEvents, GridValidRowModel } from '@mui/x-data-grid-pro';
/**
 * Handler for a specific grid event
 */
export interface GridHistoryEventHandler<T = any> {
  /**
   * Store the data to be used for undo/redo operations.
   * @param {any} params The parameters from the original event.
   * @returns {T | null} The data to store in the history stack.
   * Return `null` if the event should not be stored.
   * This can be used to descrease the granularity of the undo steps.
   */
  store: (...params: any[]) => T | null;
  /**
   * Undo the changes made by this event.
   * @param {T} data The stored data.
   * @returns {boolean | Promise<boolean>} True if the operation was successful, false otherwise.
   */
  undo: (data: T) => void | Promise<void>;
  /**
   * Redo the changes made by this event.
   * @param {T} data The stored data.
   * @returns {boolean | Promise<boolean>} True if the operation was successful, false otherwise.
   */
  redo: (data: T) => void | Promise<void>;
  /**
   * Validate if the undo/redo operation can be performed.
   * If validation is not needed, do not provide this method to avoid impacting performance.
   * @param {T} data The stored data.
   * @param {'undo' | 'redo'} operation - The operation to validate.
   * @returns {boolean} True if the operation is valid, false otherwise.
   */
  validate?: (data: T, operation: 'undo' | 'redo') => boolean;
}
export interface GridHistoryItem<T = any> {
  eventName: GridEvents;
  data: T;
}
export interface GridHistoryState {
  stack: GridHistoryItem[];
  /**
   * The current position in the stack.
   * Points to the last executed action.
   * -1 means no actions have been executed.
   */
  currentPosition: number;
  /**
   * True if the stack size is greater than 0 and there is at least one event handler.
   */
  enabled: boolean;
}
export interface GridHistoryApi {
  /**
   * The history API.
   */
  history: {
    /**
     * Undo the last action.
     * @returns {Promise<boolean>} True if the operation was successful, false otherwise.
     */
    undo: () => Promise<boolean>;
    /**
     * Redo the last undone action.
     * @returns {Promise<boolean>} True if the operation was successful, false otherwise.
     */
    redo: () => Promise<boolean>;
    /**
     * Clear the entire history.
     */
    clear: () => void;
    /**
     * @returns {boolean} True if there are undo steps available, false otherwise.
     */
    canUndo: () => boolean;
    /**
     * @returns {boolean} True if there are redo steps available, false otherwise.
     */
    canRedo: () => boolean;
  };
}
export interface GridCellEditHistoryData {
  id: GridRowId;
  field: string;
  oldValue: any;
  newValue: any;
}
export interface GridRowEditHistoryData {
  id: GridRowId;
  oldRow: GridValidRowModel;
  newRow: GridValidRowModel;
}
export interface GridClipboardPasteHistoryData {
  oldRows: Map<GridRowId, GridValidRowModel>;
  newRows: Map<GridRowId, GridValidRowModel>;
}