306 lines
12 KiB
TypeScript
306 lines
12 KiB
TypeScript
import * as React from 'react';
|
|
import { GridCellClassNamePropType } from '../gridCellClass';
|
|
import { GridColumnHeaderClassNamePropType } from '../gridColumnHeaderClass';
|
|
import type { GridFilterOperator } from '../gridFilterOperator';
|
|
import { GridCellParams, GridRenderCellParams, GridRenderEditCellParams, GridValueFormatterParams, GridValueGetterParams, GridValueSetterParams, GridPreProcessEditCellProps } from '../params/gridCellParams';
|
|
import { GridColumnHeaderParams } from '../params/gridColumnHeaderParams';
|
|
import { GridComparatorFn, GridSortDirection } from '../gridSortModel';
|
|
import { GridColType } from './gridColType';
|
|
import { GridRowParams } from '../params/gridRowParams';
|
|
import { GridValueOptionsParams } from '../params/gridValueOptionsParams';
|
|
import { GridActionsCellItemProps } from '../../components/cell/GridActionsCellItem';
|
|
import { GridEditCellProps } from '../gridEditRowModel';
|
|
import type { GridValidRowModel } from '../gridRows';
|
|
import { GridApiCommunity } from '../api/gridApiCommunity';
|
|
/**
|
|
* Alignment used in position elements in Cells.
|
|
*/
|
|
export type GridAlignment = 'left' | 'right' | 'center';
|
|
export type ValueOptions = string | number | {
|
|
value: any;
|
|
label: string;
|
|
} | Record<string, any>;
|
|
/**
|
|
* Value that can be used as a key for grouping rows
|
|
*/
|
|
export type GridKeyValue = string | number | boolean;
|
|
export type GridApplyQuickFilterV7<R extends GridValidRowModel = GridValidRowModel, V = any> = (value: V, row: R, column: GridColDef, apiRef: React.MutableRefObject<GridApiCommunity>) => boolean;
|
|
export type GetApplyQuickFilterFnLegacy<R extends GridValidRowModel = GridValidRowModel, V = any, F = V> = (value: any, colDef: GridStateColDef, apiRef: React.MutableRefObject<GridApiCommunity>) => null | ((params: GridCellParams<R, V, F>) => boolean);
|
|
export type GetApplyQuickFilterFnV7<R extends GridValidRowModel = GridValidRowModel, V = any> = (value: any, colDef: GridStateColDef, apiRef: React.MutableRefObject<GridApiCommunity>) => null | GridApplyQuickFilterV7<R, V>;
|
|
/**
|
|
* Column Definition base interface.
|
|
*/
|
|
export interface GridBaseColDef<R extends GridValidRowModel = GridValidRowModel, V = any, F = V> {
|
|
/**
|
|
* The column identifier. It's used to map with [[GridRowModel]] values.
|
|
*/
|
|
field: string;
|
|
/**
|
|
* The title of the column rendered in the column header cell.
|
|
*/
|
|
headerName?: string;
|
|
/**
|
|
* The description of the column rendered as tooltip if the column header name is not fully displayed.
|
|
*/
|
|
description?: string;
|
|
/**
|
|
* Set the width of the column.
|
|
* @default 100
|
|
*/
|
|
width?: number;
|
|
/**
|
|
* If set, it indicates that a column has fluid width. Range [0, ∞).
|
|
*/
|
|
flex?: number;
|
|
/**
|
|
* Sets the minimum width of a column.
|
|
* @default 50
|
|
*/
|
|
minWidth?: number;
|
|
/**
|
|
* Sets the maximum width of a column.
|
|
* @default Infinity
|
|
*/
|
|
maxWidth?: number;
|
|
/**
|
|
* If `false`, removes the buttons for hiding this column.
|
|
* @default true
|
|
*/
|
|
hideable?: boolean;
|
|
/**
|
|
* If `true`, the column is sortable.
|
|
* @default true
|
|
*/
|
|
sortable?: boolean;
|
|
/**
|
|
* The order of the sorting sequence.
|
|
*/
|
|
sortingOrder?: GridSortDirection[];
|
|
/**
|
|
* If `true`, the column is resizable.
|
|
* @default true
|
|
*/
|
|
resizable?: boolean;
|
|
/**
|
|
* If `true`, the cells of the column are editable.
|
|
* @default false
|
|
*/
|
|
editable?: boolean;
|
|
/**
|
|
* If `true`, the rows can be grouped based on this column values (pro-plan only).
|
|
* Only available in DataGridPremium.
|
|
* TODO: Use module augmentation to move it to `@mui/x-data-grid-premium` (need to modify how we handle column types default values).
|
|
* @default true
|
|
*/
|
|
groupable?: boolean;
|
|
/**
|
|
* If `false`, the menu items for column pinning menu will not be rendered.
|
|
* Only available in DataGridPro.
|
|
* TODO: Use module augmentation to move it to `@mui/x-data-grid-pro` (need to modify how we handle column types default values).
|
|
* @default true
|
|
*/
|
|
pinnable?: boolean;
|
|
/**
|
|
* A comparator function used to sort rows.
|
|
*/
|
|
sortComparator?: GridComparatorFn<V>;
|
|
/**
|
|
* The type of the column.
|
|
* @default 'string'
|
|
* @see See {@link https://mui.com/x/react-data-grid/column-definition/#column-types column types docs} for more details.
|
|
*/
|
|
type?: GridColType;
|
|
/**
|
|
* Allows to align the column values in cells.
|
|
*/
|
|
align?: GridAlignment;
|
|
/**
|
|
* Function that allows to get a specific data instead of field to render in the cell.
|
|
* @template R, V
|
|
* @param {GridValueGetterParams<R, any>} params Object containing parameters for the getter.
|
|
* @returns {V} The cell value.
|
|
*/
|
|
valueGetter?: (params: GridValueGetterParams<R, any>) => V;
|
|
/**
|
|
* Function that allows to customize how the entered value is stored in the row.
|
|
* It only works with cell/row editing.
|
|
* @template R, V
|
|
* @param {GridValueSetterParams<R, V>} params Object containing parameters for the setter.
|
|
* @returns {R} The row with the updated field.
|
|
*/
|
|
valueSetter?: (params: GridValueSetterParams<R, V>) => R;
|
|
/**
|
|
* Function that allows to apply a formatter before rendering its value.
|
|
* @template V, F
|
|
* @param {GridValueFormatterParams<V>} params Object containing parameters for the formatter.
|
|
* @returns {F} The formatted value.
|
|
*/
|
|
valueFormatter?: (params: GridValueFormatterParams<V>) => F;
|
|
/**
|
|
* Function that takes the user-entered value and converts it to a value used internally.
|
|
* @template R, V, F
|
|
* @param {F | undefined} value The user-entered value.
|
|
* @param {GridCellParams<R, V, F>} params The params when called before saving the value.
|
|
* @returns {V} The converted value to use internally.
|
|
*/
|
|
valueParser?: (value: F | undefined, params?: GridCellParams<R, V, F>) => V;
|
|
/**
|
|
* Class name that will be added in cells for that column.
|
|
*/
|
|
cellClassName?: GridCellClassNamePropType<R, V>;
|
|
/**
|
|
* Allows to override the component rendered as cell for this column.
|
|
* @template R, V, F
|
|
* @param {GridRenderCellParams<R, V, F>} params Object containing parameters for the renderer.
|
|
* @returns {React.ReactNode} The element to be rendered.
|
|
*/
|
|
renderCell?: (params: GridRenderCellParams<R, V, F>) => React.ReactNode;
|
|
/**
|
|
* Allows to override the component rendered in edit cell mode for this column.
|
|
* @param {GridRenderEditCellParams} params Object containing parameters for the renderer.
|
|
* @returns {React.ReactNode} The element to be rendered.
|
|
*/
|
|
renderEditCell?: (params: GridRenderEditCellParams<R, V, F>) => React.ReactNode;
|
|
/**
|
|
* Callback fired when the edit props of the cell changes.
|
|
* It allows to process the props that saved into the state.
|
|
* @param {GridPreProcessEditCellProps} params Object containing parameters of the cell being edited.
|
|
* @returns {GridEditCellProps | Promise<GridEditCellProps>} The new edit cell props.
|
|
*/
|
|
preProcessEditCellProps?: (params: GridPreProcessEditCellProps) => GridEditCellProps | Promise<GridEditCellProps>;
|
|
/**
|
|
* Class name that will be added in the column header cell.
|
|
*/
|
|
headerClassName?: GridColumnHeaderClassNamePropType;
|
|
/**
|
|
* Allows to render a component in the column header cell.
|
|
* @template R, V, F
|
|
* @param {GridColumnHeaderParams<R, V, F>} params Object containing parameters for the renderer.
|
|
* @returns {React.ReactNode} The element to be rendered.
|
|
*/
|
|
renderHeader?: (params: GridColumnHeaderParams<R, V, F>) => React.ReactNode;
|
|
/**
|
|
* Header cell element alignment.
|
|
*/
|
|
headerAlign?: GridAlignment;
|
|
/**
|
|
* Toggle the visibility of the sort icons.
|
|
* @default false
|
|
*/
|
|
hideSortIcons?: boolean;
|
|
/**
|
|
* If `true`, the column menu is disabled for this column.
|
|
* @default false
|
|
*/
|
|
disableColumnMenu?: boolean;
|
|
/**
|
|
* If `true`, the column is filterable.
|
|
* @default true
|
|
*/
|
|
filterable?: boolean;
|
|
/**
|
|
* Allows setting the filter operators for this column.
|
|
*/
|
|
filterOperators?: GridFilterOperator<R, V, F>[];
|
|
/**
|
|
* The callback that generates a filtering function for a given quick filter value.
|
|
* This function can return `null` to skip filtering for this value and column.
|
|
* @param {any} value The value with which we want to filter the column.
|
|
* @param {GridStateColDef} colDef The column from which we want to filter the rows.
|
|
* @param {React.MutableRefObject<GridApiCommunity>} apiRef Deprecated: The API of the grid.
|
|
* @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row pass this filter value or not.
|
|
*/
|
|
getApplyQuickFilterFn?: GetApplyQuickFilterFnLegacy<R, V, F>;
|
|
/**
|
|
* The callback that generates a filtering function for a given quick filter value.
|
|
* This function can return `null` to skip filtering for this value and column.
|
|
* @param {any} value The value with which we want to filter the column.
|
|
* @param {GridStateColDef} colDef The column from which we want to filter the rows.
|
|
* @param {React.MutableRefObject<GridApiCommunity>} apiRef Deprecated: The API of the grid.
|
|
* @returns {null | GridApplyQuickFilterV7} The function to call to check if a row pass this filter value or not.
|
|
*/
|
|
getApplyQuickFilterFnV7?: GetApplyQuickFilterFnV7<R, V>;
|
|
/**
|
|
* If `true`, this column cannot be reordered.
|
|
* @default false
|
|
*/
|
|
disableReorder?: boolean;
|
|
/**
|
|
* If `true`, this column will not be included in exports.
|
|
* @default false
|
|
*/
|
|
disableExport?: boolean;
|
|
/**
|
|
* Number of columns a cell should span.
|
|
* @default 1
|
|
*/
|
|
colSpan?: number | ((params: GridCellParams<R, V, F>) => number | undefined);
|
|
}
|
|
/**
|
|
* Column Definition interface used for columns with the `actions` type.
|
|
* @demos
|
|
* - [Special column properties](/x/react-data-grid/column-definition/#special-properties)
|
|
*/
|
|
export interface GridActionsColDef<R extends GridValidRowModel = any, V = any, F = V> extends GridBaseColDef<R, V, F> {
|
|
/**
|
|
* The type of the column.
|
|
* @default 'actions'
|
|
*/
|
|
type: 'actions';
|
|
/**
|
|
* Function that returns the actions to be shown.
|
|
* @param {GridRowParams} params The params for each row.
|
|
* @returns {React.ReactElement<GridActionsCellItemProps>[]} An array of [[GridActionsCell]] elements.
|
|
*/
|
|
getActions: (params: GridRowParams<R>) => React.ReactElement<GridActionsCellItemProps>[];
|
|
}
|
|
/**
|
|
* Column Definition interface used for columns with the `singleSelect` type.
|
|
* @demos
|
|
* - [Special column properties](/x/react-data-grid/column-definition/#special-properties)
|
|
*/
|
|
export interface GridSingleSelectColDef<R extends GridValidRowModel = any, V = any, F = V> extends GridBaseColDef<R, V, F> {
|
|
/**
|
|
* The type of the column.
|
|
* @default 'singleSelect'
|
|
*/
|
|
type: 'singleSelect';
|
|
/**
|
|
* To be used in combination with `type: 'singleSelect'`. This is an array (or a function returning an array) of the possible cell values and labels.
|
|
*/
|
|
valueOptions?: Array<ValueOptions> | ((params: GridValueOptionsParams<R>) => Array<ValueOptions>);
|
|
/**
|
|
* Used to determine the label displayed for a given value option.
|
|
* @param {ValueOptions} value The current value option.
|
|
* @returns {string} The text to be displayed.
|
|
*/
|
|
getOptionLabel?: (value: ValueOptions) => string;
|
|
/**
|
|
* Used to determine the value used for a value option.
|
|
* @param {ValueOptions} value The current value option.
|
|
* @returns {string} The value to be used.
|
|
*/
|
|
getOptionValue?: (value: ValueOptions) => any;
|
|
}
|
|
/**
|
|
* Column Definition interface.
|
|
* @demos
|
|
* - [Column definition](/x/react-data-grid/column-definition/)
|
|
*/
|
|
export type GridColDef<R extends GridValidRowModel = any, V = any, F = V> = GridBaseColDef<R, V, F> | GridActionsColDef<R, V, F> | GridSingleSelectColDef<R, V, F>;
|
|
export type GridColTypeDef<V = any, F = V> = Omit<GridBaseColDef<any, V, F>, 'field'>;
|
|
export type GridStateColDef<R extends GridValidRowModel = any, V = any, F = V> = GridColDef<R, V, F> & {
|
|
computedWidth: number;
|
|
/**
|
|
* If `true`, it means that at least one of the dimension's property of this column has been modified since the last time the column prop has changed.
|
|
*/
|
|
hasBeenResized?: boolean;
|
|
};
|
|
/**
|
|
* Meta Info about columns.
|
|
*/
|
|
export interface GridColumnsMeta {
|
|
totalWidth: number;
|
|
positions: number[];
|
|
}
|