@mui/x-data-grid 8.0.0-beta.3 → 8.0.0

package/modern/models/api/gridEditingApi.d.ts

@@ -1,238 +0,0 @@
-import { GridCellMode, GridRowMode } from "../gridCell.js";
-import { GridCellModes, GridRowModes } from "../gridEditRowModel.js";
-import { GridRowId, GridRowModel } from "../gridRows.js";
-import { GridCellParams } from "../params/gridCellParams.js";
-import { GridEditCellValueParams } from "../params/gridEditCellParams.js";
-import { MuiBaseEvent } from "../muiEvent.js";
-export type GridCellModesModelProps = ({
-  mode: GridCellModes.View;
-} & Omit<GridStopCellEditModeParams, 'id' | 'field'>) | ({
-  mode: GridCellModes.Edit;
-} & Omit<GridStartCellEditModeParams, 'id' | 'field'>);
-export type GridCellModesModel = Record<GridRowId, Record<string, GridCellModesModelProps>>;
-export type GridRowModesModelProps = ({
-  mode: GridRowModes.View;
-} & Omit<GridStopRowEditModeParams, 'id' | 'field'>) | ({
-  mode: GridRowModes.Edit;
-} & Omit<GridStartRowEditModeParams, 'id' | 'field'>);
-export type GridRowModesModel = Record<GridRowId, GridRowModesModelProps>;
-export interface GridEditCellMeta {
-  changeReason?: 'debouncedSetEditCellValue' | 'setEditCellValue';
-}
-export interface GridEditingSharedApi {
-  /**
-   * Controls if a cell is editable.
-   * @param {GridCellParams} params The cell params.
-   * @returns {boolean} A boolean value determining if the cell is editable.
-   */
-  isCellEditable: (params: GridCellParams) => boolean;
-  /**
-   * Sets the value of the edit cell.
-   * Commonly used inside the edit cell component.
-   * @param {GridEditCellValueParams} params Contains the id, field and value to set.
-   * @param {React.SyntheticEvent} event The event to pass forward.
-   * @returns {Promise<boolean> | void} A promise with the validation status.
-   */
-  setEditCellValue: (params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise<boolean> | void;
-  /**
-   * Returns the row with the values that were set by editing the cells.
-   * In row editing, `field` is ignored and all fields are considered.
-   * @param {GridRowId} id The row id being edited.
-   * @param {string} field The field being edited.
-   * @returns {GridRowModel} The row with edited values.
-   */
-  getRowWithUpdatedValues: (id: GridRowId, field: string) => GridRowModel;
-  /**
-   * Gets the meta information for the edit cell.
-   * @param {GridRowId} id The row id being edited.
-   * @param {string} field The field being edited.
-   * @ignore - do not document.
-   */
-  unstable_getEditCellMeta: (id: GridRowId, field: string) => GridEditCellMeta | null;
-}
-export interface GridEditingSharedPrivateApi {
-  /**
-   * Immediately updates the value of the cell, without waiting for the debounce.
-   * @param {GridRowId} id The row id.
-   * @param {string} field The field to update. If not passed, updates all fields in the given row id.
-   */
-  runPendingEditCellValueMutation: (id: GridRowId, field?: string) => void;
-}
-/**
- * Params passed to `apiRef.current.startCellEditMode`.
- */
-export interface GridStartCellEditModeParams {
-  /**
-   * The row id.
-   */
-  id: GridRowId;
-  /**
-   * The field.
-   */
-  field: string;
-  /**
-   * If `true`, the value will be deleted before entering the edit mode.
-   */
-  deleteValue?: boolean;
-  /**
-   * The initial value for the field.
-   * If `deleteValue` is also true, this value is not used.
-   * @deprecated No longer needed.
-   */
-  initialValue?: any;
-}
-/**
- * Params passed to `apiRef.current.stopCellEditMode`.
- */
-export interface GridStopCellEditModeParams {
-  /**
-   * The row id.
-   */
-  id: GridRowId;
-  /**
-   * The field.
-   */
-  field: string;
-  /**
-   * Whether or not to ignore the modifications made on this cell.
-   * @default false
-   */
-  ignoreModifications?: boolean;
-  /**
-   * To which cell to move focus after finishing editing.
-   * @default "none"
-   */
-  cellToFocusAfter?: 'none' | 'below' | 'right' | 'left';
-}
-/**
- * Params passed to `apiRef.current.startRowEditMode`.
- */
-export interface GridStartRowEditModeParams {
-  /**
-   * The row id.
-   */
-  id: GridRowId;
-  /**
-   * The field to put focus.
-   */
-  fieldToFocus?: string;
-  /**
-   * If `true`, the value in `fieldToFocus` will be deleted before entering the edit mode.
-   */
-  deleteValue?: boolean;
-  /**
-   * The initial value for the given `fieldToFocus`.
-   * If `deleteValue` is also true, this value is not used.
-   * @deprecated No longer needed.
-   */
-  initialValue?: string;
-}
-/**
- * Params passed to `apiRef.current.stopRowEditMode`.
- */
-export interface GridStopRowEditModeParams {
-  /**
-   * The row id.
-   */
-  id: GridRowId;
-  /**
-   * Whether or not to ignore the modifications made on this cell.
-   * @default false
-   */
-  ignoreModifications?: boolean;
-  /**
-   * The field that has focus when the editing is stopped.
-   * Used to calculate which cell to move the focus to after finishing editing.
-   */
-  field?: string;
-  /**
-   * To which cell to move focus after finishing editing.
-   * Only works if the field is also specified, otherwise focus stay in the same cell.
-   * @default "none"
-   */
-  cellToFocusAfter?: 'none' | 'below' | 'right' | 'left';
-}
-/**
- * The cell editing API interface.
- */
-export interface GridCellEditingApi extends GridEditingSharedApi {
-  /**
-   * Gets the mode of a cell.
-   * @param {GridRowId} id The id of the row.
-   * @param {string} field The field to get the mode.
-   * @returns {GridCellMode} Returns `"edit"` or `"view"`.
-   */
-  getCellMode: (id: GridRowId, field: string) => GridCellMode;
-  /**
-   * Puts the cell corresponding to the given row id and field into edit mode.
-   * @param {GridStartCellEditModeParams} params The row id and field of the cell to edit.
-   */
-  startCellEditMode(params: GridStartCellEditModeParams): void;
-  /**
-   * Puts the cell corresponding to the given row id and field into view mode and updates the original row with the new value stored.
-   * If `params.ignoreModifications` is `true` it will discard the modifications made.
-   * @param {GridStopCellEditModeParams} params The row id and field of the cell to stop editing.
-   */
-  stopCellEditMode(params: GridStopCellEditModeParams): void;
-}
-export interface GridCellEditingPrivateApi extends GridEditingSharedPrivateApi {
-  /**
-   * Updates the value of a cell being edited.
-   * Don't call this method directly, prefer `setEditCellValue`.
-   * @param {GridCommitCellChangeParams} params Object with the new value and id and field to update.
-   * @returns {Promise<boolean>} Resolves with `true` when the new value is valid.
-   */
-  setCellEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
-  /**
-   * Returns the row with the new value that was set by editing the cell.
-   * @param {GridRowId} id The row id being edited.
-   * @param {string} field The field being edited.
-   * @returns {GridRowModel} The data model of the row.
-   */
-  getRowWithUpdatedValuesFromCellEditing: (id: GridRowId, field: string) => GridRowModel;
-}
-/**
- * The row editing API interface.
- */
-export interface GridRowEditingApi extends GridEditingSharedApi {
-  /**
-   * Gets the mode of a row.
-   * @param {GridRowId} id The id of the row.
-   * @returns {GridRowMode} Returns `"edit"` or `"view"`.
-   */
-  getRowMode: (id: GridRowId) => GridRowMode;
-  /**
-   * Puts the row corresponding to the given id into edit mode.
-   * @param {GridStartCellEditModeParams} params The row id edit.
-   */
-  startRowEditMode(params: GridStartRowEditModeParams): void;
-  /**
-   * Puts the row corresponding to the given id and into view mode and updates the original row with the new values stored.
-   * If `params.ignoreModifications` is `true` it will discard the modifications made.
-   * @param {GridStopCellEditModeParams} params The row id and field of the cell to stop editing.
-   */
-  stopRowEditMode(params: GridStopRowEditModeParams): void;
-}
-export interface GridRowEditingPrivateApi extends GridEditingSharedPrivateApi {
-  /**
-   * Updates the value of a cell being edited.
-   * Don't call this method directly, prefer `setEditCellValue`.
-   * @param {GridCommitCellChangeParams} params Object with the new value and id and field to update.
-   * @returns {Promise<boolean>} Resolves with `true` when all values in the row are valid.
-   */
-  setRowEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
-  /**
-   * Returns the row with the values that were set by editing all cells.
-   * @param {GridRowId} id The row id being edited.
-   * @returns {GridRowModel} The data model of the row.
-   */
-  getRowWithUpdatedValuesFromRowEditing: (id: GridRowId) => GridRowModel;
-}
-/**
- * The editing API interface that is available in the grid `apiRef`.
- */
-export interface GridEditingApi extends GridCellEditingApi, GridRowEditingApi {}
-/**
- * The private editing API interface that is available in the grid `privateApiRef`.
- */
-export interface GridEditingPrivateApi extends GridCellEditingPrivateApi, GridRowEditingPrivateApi {}

package/modern/models/api/gridEditingApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridFilterApi.d.ts

@@ -1,67 +0,0 @@
-import { GridFilterModel } from "../gridFilterModel.js";
-import { GridFilterItem, GridLogicOperator } from "../gridFilterItem.js";
-import { GridControlledStateReasonLookup } from "../events/index.js";
-import type { DataGridProcessedProps } from '../props/DataGridProps';
-import { GridStateCommunity } from "../gridStateCommunity.js";
-/**
- * The filter API interface that is available in the grid [[apiRef]].
- */
-export interface GridFilterApi {
-  /**
-   * Shows the filter panel. If `targetColumnField` is given, a filter for this field is also added.
-   * @param {string} targetColumnField The column field to add a filter.
-   * @param {string} panelId The unique panel id
-   * @param {string} labelId The unique button id
-   */
-  showFilterPanel: (targetColumnField?: string, panelId?: string, labelId?: string) => void;
-  /**
-   * Hides the filter panel.
-   */
-  hideFilterPanel: () => void;
-  /**
-   * Updates or inserts a [[GridFilterItem]].
-   * @param {GridFilterItem} item The filter to update.
-   */
-  upsertFilterItem: (item: GridFilterItem) => void;
-  /**
-   * Updates or inserts many [[GridFilterItem]].
-   * @param {GridFilterItem[]} items The filters to update.
-   */
-  upsertFilterItems: (items: GridFilterItem[]) => void;
-  /**
-   * Applies all filters on all rows.
-   * @ignore - do not document.
-   */
-  unstable_applyFilters: () => void;
-  /**
-   * Deletes a [[GridFilterItem]].
-   * @param {GridFilterItem} item The filter to delete.
-   */
-  deleteFilterItem: (item: GridFilterItem) => void;
-  /**
-   * Changes the [[GridLogicOperator]] used to connect the filters.
-   * @param {GridLogicOperator} operator The new logic operator. It can be: `"and"` or `"or`".
-   */
-  setFilterLogicOperator: (operator: GridLogicOperator) => void;
-  /**
-   * Sets the filter model to the one given by `model`.
-   * @param {GridFilterModel} model The new filter model.
-   * @param {string} reason The reason for the model to have changed.
-   */
-  setFilterModel: (model: GridFilterModel, reason?: GridControlledStateReasonLookup['filter']) => void;
-  /**
-   * Set the quick filter values to the one given by `values`
-   * @param {any[]} values The list of element to quick filter
-   */
-  setQuickFilterValues: (values: any[]) => void;
-  /**
-   * Returns the value of the `ignoreDiacritics` prop.
-   */
-  ignoreDiacritics: DataGridProcessedProps['ignoreDiacritics'];
-  /**
-   * Returns the filter state for the given filter model without applying it to the Data Grid.
-   * @param {GridFilterModel} filterModel The filter model to get the state for.
-   * @returns {GridStateCommunity['filter']} The filter state.
-   */
-  getFilterState: (filterModel: GridFilterModel) => GridStateCommunity['filter'];
-}

package/modern/models/api/gridFilterApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridFocusApi.d.ts

@@ -1,46 +0,0 @@
-import { GridRowId } from "../gridRows.js";
-import { MuiBaseEvent } from "../muiEvent.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;
-}

package/modern/models/api/gridFocusApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridHeaderFilteringApi.d.ts

@@ -1,30 +0,0 @@
-import { GridColDef } from "../colDef/index.js";
-import { GridHeaderFilteringState } from "../gridHeaderFilteringModel.js";
-export interface GridHeaderFilteringPrivateApi {
-  /**
-   * Internal function to set the header filter state.
-   * @param {Partial<GridHeaderFilteringState>} headerFilterState The field to be edited.
-   * @ignore - do not document.
-   */
-  setHeaderFilterState: (headerFilterState: Partial<GridHeaderFilteringState>) => void;
-}
-export interface GridHeaderFilteringApi {
-  /**
-   * Puts the cell corresponding to the given row id and field into edit mode.
-   * @param {GridColDef['field']} field The field of the header filter to put in edit mode.
-   */
-  startHeaderFilterEditMode: (field: GridColDef['field']) => void;
-  /**
-   * Stops the edit mode for the current field.
-   */
-  stopHeaderFilterEditMode: () => void;
-  /**
-   * Opens the header filter menu for the given field.
-   * @param {GridColDef['field']} field The field of the header filter to open menu for.
-   */
-  showHeaderFilterMenu: (field: GridColDef['field']) => void;
-  /**
-   * Hides the header filter menu.
-   */
-  hideHeaderFilterMenu: () => void;
-}

package/modern/models/api/gridHeaderFilteringApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridInfiniteLoaderApi.d.ts

@@ -1,7 +0,0 @@
-export interface GridInfiniteLoaderPrivateApi {
-  getInfiniteLoadingTriggerElement?: ({
-    lastRowId
-  }: {
-    lastRowId: string | number;
-  }) => React.ReactNode;
-}

package/modern/models/api/gridInfiniteLoaderApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridLocaleTextApi.d.ts

@@ -1,163 +0,0 @@
-import * as React from 'react';
-import type { GridColDef } from '../colDef';
-/**
- * Set the types of the texts in the grid.
- */
-export interface GridLocaleText {
-  noRowsLabel: string;
-  noResultsOverlayLabel: string;
-  noColumnsOverlayLabel: string;
-  noColumnsOverlayManageColumns: string;
-  toolbarDensity: React.ReactNode;
-  toolbarDensityLabel: string;
-  toolbarDensityCompact: string;
-  toolbarDensityStandard: string;
-  toolbarDensityComfortable: string;
-  toolbarColumns: React.ReactNode;
-  toolbarColumnsLabel: string;
-  toolbarFilters: React.ReactNode;
-  toolbarFiltersLabel: string;
-  toolbarFiltersTooltipHide: React.ReactNode;
-  toolbarFiltersTooltipShow: React.ReactNode;
-  toolbarFiltersTooltipActive: (count: number) => React.ReactNode;
-  toolbarQuickFilterPlaceholder: string;
-  toolbarQuickFilterLabel: string;
-  toolbarQuickFilterDeleteIconLabel: string;
-  toolbarPromptControlPlaceholder: string;
-  toolbarPromptControlWithRecordingPlaceholder: string;
-  toolbarPromptControlRecordingPlaceholder: string;
-  toolbarPromptControlLabel: string;
-  toolbarPromptControlRecordButtonDefaultLabel: string;
-  toolbarPromptControlRecordButtonActiveLabel: string;
-  toolbarPromptControlSendActionLabel: string;
-  toolbarPromptControlSendActionAriaLabel: string;
-  toolbarPromptControlErrorMessage: string;
-  toolbarExport: React.ReactNode;
-  toolbarExportLabel: string;
-  toolbarExportCSV: React.ReactNode;
-  toolbarExportPrint: React.ReactNode;
-  toolbarExportExcel: string;
-  columnsManagementSearchTitle: string;
-  columnsManagementNoColumns: string;
-  columnsManagementShowHideAllText: string;
-  columnsManagementReset: string;
-  columnsManagementDeleteIconLabel: string;
-  filterPanelAddFilter: React.ReactNode;
-  filterPanelRemoveAll: React.ReactNode;
-  filterPanelDeleteIconLabel: string;
-  filterPanelLogicOperator: string;
-  filterPanelOperator: React.ReactNode;
-  filterPanelOperatorAnd: React.ReactNode;
-  filterPanelOperatorOr: React.ReactNode;
-  filterPanelColumns: React.ReactNode;
-  filterPanelInputLabel: string;
-  filterPanelInputPlaceholder: string;
-  filterOperatorContains: string;
-  filterOperatorDoesNotContain: string;
-  filterOperatorEquals: string;
-  filterOperatorDoesNotEqual: string;
-  filterOperatorStartsWith: string;
-  filterOperatorEndsWith: string;
-  filterOperatorIs: string;
-  filterOperatorNot: string;
-  filterOperatorAfter: string;
-  filterOperatorOnOrAfter: string;
-  filterOperatorBefore: string;
-  filterOperatorOnOrBefore: string;
-  filterOperatorIsEmpty: string;
-  filterOperatorIsNotEmpty: string;
-  filterOperatorIsAnyOf: string;
-  'filterOperator=': string;
-  'filterOperator!=': string;
-  'filterOperator>': string;
-  'filterOperator>=': string;
-  'filterOperator<': string;
-  'filterOperator<=': string;
-  headerFilterOperatorContains: string;
-  headerFilterOperatorDoesNotContain: string;
-  headerFilterOperatorEquals: string;
-  headerFilterOperatorDoesNotEqual: string;
-  headerFilterOperatorStartsWith: string;
-  headerFilterOperatorEndsWith: string;
-  headerFilterOperatorIs: string;
-  headerFilterOperatorNot: string;
-  headerFilterOperatorAfter: string;
-  headerFilterOperatorOnOrAfter: string;
-  headerFilterOperatorBefore: string;
-  headerFilterOperatorOnOrBefore: string;
-  headerFilterOperatorIsEmpty: string;
-  headerFilterOperatorIsNotEmpty: string;
-  headerFilterOperatorIsAnyOf: string;
-  'headerFilterOperator=': string;
-  'headerFilterOperator!=': string;
-  'headerFilterOperator>': string;
-  'headerFilterOperator>=': string;
-  'headerFilterOperator<': string;
-  'headerFilterOperator<=': string;
-  headerFilterClear: string;
-  filterValueAny: string;
-  filterValueTrue: string;
-  filterValueFalse: string;
-  columnMenuLabel: string;
-  columnMenuAriaLabel: (columnName: string) => string;
-  columnMenuShowColumns: React.ReactNode;
-  columnMenuManageColumns: React.ReactNode;
-  columnMenuFilter: React.ReactNode;
-  columnMenuHideColumn: React.ReactNode;
-  columnMenuUnsort: React.ReactNode;
-  columnMenuSortAsc: React.ReactNode | ((colDef: GridColDef) => React.ReactNode);
-  columnMenuSortDesc: React.ReactNode | ((colDef: GridColDef) => React.ReactNode);
-  columnHeaderFiltersTooltipActive: (count: number) => React.ReactNode;
-  columnHeaderFiltersLabel: string;
-  columnHeaderSortIconLabel: string;
-  footerRowSelected: (count: number) => React.ReactNode;
-  footerTotalRows: React.ReactNode;
-  footerTotalVisibleRows: (visibleCount: number, totalCount: number) => React.ReactNode;
-  checkboxSelectionHeaderName: string;
-  checkboxSelectionSelectAllRows: string;
-  checkboxSelectionUnselectAllRows: string;
-  checkboxSelectionSelectRow: string;
-  checkboxSelectionUnselectRow: string;
-  booleanCellTrueLabel: string;
-  booleanCellFalseLabel: string;
-  actionsCellMore: string;
-  pinToLeft: string;
-  pinToRight: string;
-  unpin: string;
-  treeDataGroupingHeaderName: string;
-  treeDataExpand: string;
-  treeDataCollapse: string;
-  groupingColumnHeaderName: string;
-  groupColumn: (name: string) => string;
-  unGroupColumn: (name: string) => string;
-  detailPanelToggle: string;
-  expandDetailPanel: string;
-  collapseDetailPanel: string;
-  rowReorderingHeaderName: string;
-  aggregationMenuItemHeader: string;
-  aggregationFunctionLabelSum: string;
-  aggregationFunctionLabelAvg: string;
-  aggregationFunctionLabelMin: string;
-  aggregationFunctionLabelMax: string;
-  aggregationFunctionLabelSize: string;
-  paginationRowsPerPage: string;
-  paginationDisplayedRows: (params: {
-    from: number;
-    to: number;
-    count: number;
-    estimated: number | undefined;
-  }) => string;
-  paginationItemAriaLabel: (type: 'first' | 'last' | 'previous' | 'next') => string;
-}
-export type GridTranslationKeys = keyof GridLocaleText;
-/**
- * The grid locale text API [[apiRef]].
- */
-export interface GridLocaleTextApi {
-  /**
-   * Returns the translation for the `key`.
-   * @param {T} key One of the keys in [[GridLocaleText]].
-   * @returns {GridLocaleText[T]} The translated value.
-   */
-  getLocaleText: <T extends GridTranslationKeys>(key: T) => GridLocaleText[T];
-}

package/modern/models/api/gridLocaleTextApi.js

@@ -1 +0,0 @@
-export {};

package/modern/models/api/gridLoggerApi.d.ts

@@ -1,11 +0,0 @@
-import { Logger } from "../logger.js";
-/**
- * The logger API interface that is available in the grid `apiRef`.
- */
-export interface GridLoggerApi {
-  /**
-   * @param {string} name The name of the logger
-   * @returns {Logger} Instance of the logger
-   */
-  getLogger: (name: string) => Logger;
-}

package/modern/models/api/gridLoggerApi.js

@@ -1 +0,0 @@
-export {};