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

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

import { RefObject } from '@mui/x-internals/types';
import { GridRowId } from "./gridRows.js";
import type { GridApiCommon } from "./api/index.js";
import type { GridApiCommunity } from "./api/gridApiCommunity.js";
/**
 * The options applicable to any export format.
 */
export interface GridExportOptions {
  /**
   * The columns exported.
   * This should only be used if you want to restrict the columns exports.
   */
  fields?: string[];
  /**
   * If `true`, the hidden columns will also be exported.
   * @default false
   */
  allColumns?: boolean;
}
/**
 * The options applicable to any document export format (CSV and Excel).
 */
export interface GridFileExportOptions<Api extends GridApiCommon = GridApiCommunity> extends GridExportOptions {
  /**
   * The string used as the file name.
   * @default document.title
   */
  fileName?: string;
  /**
   * If `true`, the first row of the file will include the headers of the grid.
   * @default true
   */
  includeHeaders?: boolean;
  /**
   * Function that returns the list of row ids to export on the order they should be exported.
   * @param {GridGetRowsToExportParams} params With all properties from [[GridGetRowsToExportParams]].
   * @returns {GridRowId[]} The list of row ids to export.
   */
  getRowsToExport?: (params: GridGetRowsToExportParams<Api>) => GridRowId[];
  /**
   * If `false`, the formulas in the cells will not be escaped.
   * It is not recommended to disable this option as it exposes the user to potential CSV injection attacks.
   * See https://owasp.org/www-community/attacks/CSV_Injection for more information.
   * @default true
   */
  escapeFormulas?: boolean;
}
export interface GridGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> {
  /**
   * The API of the grid.
   */
  apiRef: RefObject<Api>;
}
export interface GridCsvGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> extends GridGetRowsToExportParams<Api> {}
export interface GridPrintGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> extends GridGetRowsToExportParams<Api> {}
/**
 * The options to apply on the CSV export.
 * @demos
 *   - [CSV export](/x/react-data-grid/export/#csv-export)
 */
export interface GridCsvExportOptions extends GridFileExportOptions {
  /**
   * The character used to separate fields.
   * @default ','
   */
  delimiter?: string;
  /**
   * The string used as the file name.
   * @default document.title
   */
  fileName?: string;
  /**
   * If `true`, the UTF-8 Byte Order Mark (BOM) prefixes the exported file.
   * This can allow Excel to automatically detect file encoding as UTF-8.
   * @default false
   */
  utf8WithBom?: boolean;
  /**
   * If `true`, the CSV will include the column headers and column groups.
   * Use `includeColumnGroupsHeaders` to control whether the column groups are included.
   * @default true
   */
  includeHeaders?: boolean;
  /**
   * If `true`, the CSV will include the column groups.
   * @see See {@link https://mui.com/x/react-data-grid/column-groups/ column groups docs} for more details.
   * @default true
   */
  includeColumnGroupsHeaders?: boolean;
  /**
   * Function that returns the list of row ids to export on the order they should be exported.
   * @param {GridCsvGetRowsToExportParams} params With all properties from [[GridCsvGetRowsToExportParams]].
   * @returns {GridRowId[]} The list of row ids to export.
   */
  getRowsToExport?: (params: GridCsvGetRowsToExportParams) => GridRowId[];
  /**
   * @ignore
   * If `false`, the quotes will not be appended to the cell value.
   * @default true
   */
  shouldAppendQuotes?: boolean;
}
/**
 * The options to apply on the Print export.
 * @demos
 *   - [Print export](/x/react-data-grid/export/#print-export)
 */
export interface GridPrintExportOptions extends GridExportOptions {
  /**
   * The value to be used as the print window title.
   * @default The title of the page.
   */
  fileName?: string;
  /**
   * If `true`, the toolbar is removed for when printing.
   * @default false
   */
  hideToolbar?: boolean;
  /**
   * If `true`, the footer is removed for when printing.
   * @default false
   */
  hideFooter?: boolean;
  /**
   * If `true`, the selection checkboxes will be included when printing.
   * @default false
   */
  includeCheckboxes?: boolean;
  /**
   * If `false`, all <style> and <link type="stylesheet" /> tags from the <head> will not be copied
   * to the print window.
   * @default true
   */
  copyStyles?: boolean;
  /**
   * One or more classes passed to the print window.
   */
  bodyClassName?: string;
  /**
   * Provide Print specific styles to the print window.
   */
  pageStyle?: string | (() => string);
  /**
   * Function that returns the list of row ids to export in the order they should be exported.
   * @param {GridPrintGetRowsToExportParams} params With all properties from [[GridPrintGetRowsToExportParams]].
   * @returns {GridRowId[]} The list of row ids to export.
   */
  getRowsToExport?: (params: GridPrintGetRowsToExportParams) => GridRowId[];
}
/**
 * Available export formats.
 */
export type GridExportFormat = 'csv' | 'print';
/**
 * Available export extensions.
 */
export type GridExportExtension = 'csv';