@mui/x-data-grid 5.4.0 → 5.6.0

package/locales/zhCN.js

@@ -0,0 +1,108 @@
+import { zhCN as zhCNCore } from '@mui/material/locale';
+import { getGridLocalization } from '../utils/getGridLocalization';
+const zhCNGrid = {
+  // Root
+  noRowsLabel: '没有数据。',
+  noResultsOverlayLabel: '未找到数据。',
+  errorOverlayDefaultLabel: '发生错误。',
+  // Density selector toolbar button text
+  toolbarDensity: '表格密度',
+  toolbarDensityLabel: '表格密度',
+  toolbarDensityCompact: '紧密',
+  toolbarDensityStandard: '标准',
+  toolbarDensityComfortable: '稀疏',
+  // Columns selector toolbar button text
+  toolbarColumns: '列',
+  toolbarColumnsLabel: '选择列',
+  // Filters toolbar button text
+  toolbarFilters: '筛选器',
+  toolbarFiltersLabel: '显示筛选器',
+  toolbarFiltersTooltipHide: '隐藏筛选器',
+  toolbarFiltersTooltipShow: '显示筛选器',
+  toolbarFiltersTooltipActive: count => `${count} 个筛选器`,
+  // Export selector toolbar button text
+  toolbarExport: '导出',
+  toolbarExportLabel: '导出',
+  toolbarExportCSV: '导出至CSV',
+  // toolbarExportPrint: 'Print',
+  // Columns panel text
+  columnsPanelTextFieldLabel: '搜索列',
+  columnsPanelTextFieldPlaceholder: '列名',
+  columnsPanelDragIconLabel: '重排序列',
+  columnsPanelShowAllButton: '显示所有',
+  columnsPanelHideAllButton: '隐藏所有',
+  // Filter panel text
+  filterPanelAddFilter: '添加筛选器',
+  filterPanelDeleteIconLabel: '删除',
+  // filterPanelLinkOperator: 'Logic operator',
+  filterPanelOperators: '操作器',
+  // TODO v6: rename to filterPanelOperator
+  filterPanelOperatorAnd: '与',
+  filterPanelOperatorOr: '或',
+  filterPanelColumns: '列',
+  filterPanelInputLabel: '值',
+  filterPanelInputPlaceholder: '筛选值',
+  // Filter operators text
+  filterOperatorContains: '包含',
+  filterOperatorEquals: '等于',
+  filterOperatorStartsWith: '开始于',
+  filterOperatorEndsWith: '结束于',
+  filterOperatorIs: '是',
+  filterOperatorNot: '不是',
+  filterOperatorAfter: '在后面',
+  filterOperatorOnOrAfter: '正在后面',
+  filterOperatorBefore: '在前面',
+  filterOperatorOnOrBefore: '正在前面',
+  filterOperatorIsEmpty: '为空',
+  filterOperatorIsNotEmpty: '不为空',
+  // filterOperatorIsAnyOf: 'is any of',
+  // Filter values text
+  filterValueAny: '任何',
+  filterValueTrue: '真',
+  filterValueFalse: '假',
+  // Column menu text
+  columnMenuLabel: '菜单',
+  columnMenuShowColumns: '显示',
+  columnMenuFilter: '筛选器',
+  columnMenuHideColumn: '隐藏',
+  columnMenuUnsort: '恢复默认',
+  columnMenuSortAsc: '升序',
+  columnMenuSortDesc: '降序',
+  // Column header text
+  columnHeaderFiltersTooltipActive: count => count !== 1 ? `${count} 个筛选器` : `${count} 个筛选器`,
+  columnHeaderFiltersLabel: '显示筛选器',
+  columnHeaderSortIconLabel: '排序',
+  // Rows selected footer text
+  footerRowSelected: count => `共选中了${count.toLocaleString()}行`,
+  // Total row amount footer text
+  footerTotalRows: '所有行:',
+  // Total visible row amount footer text
+  footerTotalVisibleRows: (visibleCount, totalCount) => `${visibleCount.toLocaleString()} / ${totalCount.toLocaleString()}`,
+  // Checkbox selection text
+  checkboxSelectionHeaderName: '多选框',
+  // checkboxSelectionSelectAllRows: 'Select all rows',
+  // checkboxSelectionUnselectAllRows: 'Unselect all rows',
+  // checkboxSelectionSelectRow: 'Select row',
+  // checkboxSelectionUnselectRow: 'Unselect row',
+  // Boolean cell text
+  booleanCellTrueLabel: '真',
+  booleanCellFalseLabel: '假' // Actions cell more text
+  // actionsCellMore: 'more',
+  // Column pinning text
+  // pinToLeft: 'Pin to left',
+  // pinToRight: 'Pin to right',
+  // unpin: 'Unpin',
+  // Tree Data
+  // treeDataGroupingHeaderName: 'Group',
+  // treeDataExpand: 'see children',
+  // treeDataCollapse: 'hide children',
+  // Grouping columns
+  // groupingColumnHeaderName: 'Group',
+  // groupColumn: name => `Group by ${name}`,
+  // unGroupColumn: name => `Stop grouping by ${name}`,
+  // Master/detail
+  // expandDetailPanel: 'Expand',
+  // collapseDetailPanel: 'Collapse',
+
+};
+export const zhCN = getGridLocalization(zhCNGrid, zhCNCore);

package/models/api/gridApiCommon.d.ts

@@ -0,0 +1,33 @@
+import { GridColumnApi } from './gridColumnApi';
+import { GridColumnMenuApi } from './gridColumnMenuApi';
+import { GridCoreApi } from './gridCoreApi';
+import { GridClipboardApi } from './gridClipboardApi';
+import { GridCsvExportApi } from './gridCsvExportApi';
+import { GridDensityApi } from './gridDensityApi';
+import { GridEditingApi } from './gridEditingApi';
+import { GridFilterApi } from './gridFilterApi';
+import { GridFocusApi } from './gridFocusApi';
+import { GridLocaleTextApi } from './gridLocaleTextApi';
+import type { GridParamsApi } from './gridParamsApi';
+import { GridPreferencesPanelApi } from './gridPreferencesPanelApi';
+import { GridPrintExportApi } from './gridPrintExportApi';
+import { GridDisableVirtualizationApi } from './gridDisableVirtualizationApi';
+import { GridRowApi } from './gridRowApi';
+import { GridRowsMetaApi } from './gridRowsMetaApi';
+import { GridSelectionApi } from './gridSelectionApi';
+import { GridSortApi } from './gridSortApi';
+import { GridStateApi } from './gridStateApi';
+import { GridLoggerApi } from './gridLoggerApi';
+import { GridScrollApi } from './gridScrollApi';
+import { GridVirtualScrollerApi } from './gridVirtualScrollerApi';
+import type { GridPreProcessingApi } from '../../hooks/core/preProcessing';
+import type { GridRowGroupsPreProcessingApi } from '../../hooks/core/rowGroupsPreProcessing';
+import type { GridDimensionsApi } from '../../hooks/features/dimensions';
+import type { GridPaginationApi } from '../../hooks/features/pagination';
+import type { GridStatePersistenceApi } from '../../hooks/features/statePersistence';
+declare type GridStateApiUntyped = {
+    [key in keyof (GridStateApi<any> & GridStatePersistenceApi<any>)]: any;
+};
+export interface GridApiCommon extends GridCoreApi, GridLoggerApi, GridPreProcessingApi, GridRowGroupsPreProcessingApi, GridDensityApi, GridDimensionsApi, GridRowApi, GridRowsMetaApi, GridEditingApi, GridParamsApi, GridColumnApi, GridSelectionApi, GridSortApi, GridPaginationApi, GridCsvExportApi, GridFocusApi, GridFilterApi, GridColumnMenuApi, GridPreferencesPanelApi, GridPrintExportApi, GridDisableVirtualizationApi, GridVirtualScrollerApi, GridLocaleTextApi, GridClipboardApi, GridScrollApi, GridStateApiUntyped {
+}
+export {};

package/models/api/gridApiCommon.js

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

package/models/api/gridApiCommunity.d.ts

@@ -0,0 +1,13 @@
+import type { GridStateApi } from './gridStateApi';
+import type { GridInitialStateCommunity, GridStateCommunity } from '../gridStateCommunity';
+import type { GridApiCommon } from './gridApiCommon';
+import type { GridStatePersistenceApi } from '../../hooks/features/statePersistence';
+declare type GridStateApiUntyped = {
+    [key in keyof (GridStateApi<any> & GridStatePersistenceApi<any>)]: any;
+};
+/**
+ * The api of `DataGrid`.
+ */
+export interface GridApiCommunity extends Omit<GridApiCommon, keyof GridStateApiUntyped>, GridStateApi<GridStateCommunity>, GridStatePersistenceApi<GridInitialStateCommunity> {
+}
+export {};

package/models/api/gridApiCommunity.js

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

package/models/api/gridCallbackDetails.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Additional details passed to the callbacks
+ */
+export interface GridCallbackDetails {
+    /**
+     * Provided only if `DataGridPro` is being used.
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api?: any;
+}

package/models/api/gridCallbackDetails.js

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

package/models/api/gridClipboardApi.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The Clipboard API interface that is available in the grid [[apiRef]].
+ */
+export interface GridClipboardApi {
+    /**
+     * Copies the selected rows to the clipboard.
+     * The fields will be separated by the TAB character.
+     * @param {boolean} includeHeaders Whether to include the headers or not. Default is `false`.
+     * @ignore - do not document.
+     */
+    unstable_copySelectedRowsToClipboard: (includeHeaders?: boolean) => void;
+}

package/models/api/gridClipboardApi.js

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

package/models/api/gridColumnApi.d.ts

@@ -0,0 +1,78 @@
+import { GridColDef, GridColumnsMeta, GridStateColDef } from '../colDef/gridColDef';
+import type { GridColumnVisibilityModel } from '../../hooks/features/columns/gridColumnsInterfaces';
+/**
+ * The column API interface that is available in the grid [[apiRef]].
+ * TODO: Differentiate interfaces based on the plan
+ */
+export interface GridColumnApi {
+    /**
+     * Returns the [[GridColDef]] for the given `field`.
+     * @param {string} field The column field.
+     * @returns {{GridStateColDef}} The [[GridStateColDef]].
+     */
+    getColumn: (field: string) => GridStateColDef;
+    /**
+     * Returns an array of [[GridColDef]] containing all the column definitions.
+     * @returns {GridStateColDef[]} An array of [[GridStateColDef]].
+     */
+    getAllColumns: () => GridStateColDef[];
+    /**
+     * Returns the currently visible columns.
+     * @returns {GridStateColDef[]} An array of [[GridStateColDef]].
+     */
+    getVisibleColumns: () => GridStateColDef[];
+    /**
+     * Returns the [[GridColumnsMeta]] for each column.
+     * @returns {GridColumnsMeta[]} All [[GridColumnsMeta]] objects.
+     * @deprecatedUse Use `gridColumnsTotalWidthSelector` or `gridColumnPositionsSelector` selectors instead.
+     */
+    getColumnsMeta: () => GridColumnsMeta;
+    /**
+     * Returns the index position of a column. By default, only the visible columns are considered.
+     * Pass `false` to `useVisibleColumns` to consider all columns.
+     * @param {string} field The column field.
+     * @param {boolean} useVisibleColumns Determines if all columns or the visible ones should be considered. Default is `true`.
+     * @returns {number} The index position.
+     */
+    getColumnIndex: (field: string, useVisibleColumns?: boolean) => number;
+    /**
+     * Returns the left-position of a column relative to the inner border of the grid.
+     * @param {string} field The column field.
+     * @returns {number} The position in pixels.
+     */
+    getColumnPosition: (field: string) => number;
+    /**
+     * Updates the definition of a column.
+     * @param {GridColDef} col The new [[GridColDef]] object.
+     * @deprecated Use `apiRef.current.updateColumns` instead.
+     */
+    updateColumn: (col: GridColDef) => void;
+    /**
+     * Updates the definition of multiple columns at the same time.
+     * @param {GridColDef[]} cols The new column [[GridColDef]] objects.
+     */
+    updateColumns: (cols: GridColDef[]) => void;
+    /**
+     * Sets the column visibility model to the one given by `model`.
+     * @param {GridColumnVisibilityModel} model The new visible columns model.
+     */
+    setColumnVisibilityModel: (model: GridColumnVisibilityModel) => void;
+    /**
+     * Changes the visibility of the column referred by `field`.
+     * @param {string} field The column to change visibility.
+     * @param {boolean} isVisible Pass `true` to show the column, or `false` to hide it. Default is `false`
+     */
+    setColumnVisibility: (field: string, isVisible: boolean) => void;
+    /**
+     * Moves a column from its original position to the position given by `targetIndexPosition`.
+     * @param {string} field The field name
+     * @param {number} targetIndexPosition The new position (0-based).
+     */
+    setColumnIndex: (field: string, targetIndexPosition: number) => void;
+    /**
+     * Updates the width of a column.
+     * @param {string} field The column field.
+     * @param {number} width The new width.
+     */
+    setColumnWidth: (field: string, width: number) => void;
+}

package/models/api/gridColumnApi.js

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

package/models/api/gridColumnMenuApi.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The column menu API interface that is available in the grid [[apiRef]].
+ */
+export interface GridColumnMenuApi {
+    /**
+     * Display the column menu under the `field` column.
+     * @param {string} field The column to display the menu.
+     */
+    showColumnMenu: (field: string) => void;
+    /**
+     * Hides the column menu that is open.
+     */
+    hideColumnMenu: () => void;
+    /**
+     * Toggles the column menu under the `field` column.
+     * @param {string} field The field name to toggle the column menu.
+     */
+    toggleColumnMenu: (field: string) => void;
+}

package/models/api/gridColumnMenuApi.js

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

package/models/api/gridCoreApi.d.ts

@@ -0,0 +1,73 @@
+import * as React from 'react';
+import { GridEventPublisher, GridEventListener, GridEventsStr } from '../events';
+import { EventManager, EventListenerOptions } from '../../utils/EventManager';
+/**
+ * The core API interface that is available in the grid `apiRef`.
+ */
+export interface GridCoreApi {
+    /**
+     * The React ref of the grid root container div element.
+     * @ignore - do not document.
+     */
+    rootElementRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid column container virtualized div element.
+     * @ignore - do not document.
+     */
+    columnHeadersContainerElementRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid column headers container element.
+     * @ignore - do not document.
+     */
+    columnHeadersElementRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid window container element.
+     * @ignore - do not document.
+     */
+    windowRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid data rendering zone.
+     * @ignore - do not document.
+     */
+    renderingZoneRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid header element.
+     * @ignore - do not document.
+     */
+    headerRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The React ref of the grid footer element.
+     * @ignore - do not document.
+     */
+    footerRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * The generic event emitter manager.
+     * @ignore - do not document
+     */
+    unstable_eventManager: EventManager;
+    /**
+     * Registers a handler for an event.
+     * @param {string} event The name of the event.
+     * @param {function} handler The handler to be called.
+     * @param {object} options Additional options for this listener.
+     * @returns {function} A function to unsubscribe from this event.
+     */
+    subscribeEvent: <E extends GridEventsStr>(event: E, handler: GridEventListener<E>, options?: EventListenerOptions) => () => void;
+    /**
+     * Emits an event.
+     * @param {GridEvents} name The name of the event.
+     * @param {any} params Arguments to be passed to the handlers.
+     * @param {MuiEvent<MuiBaseEvent>} event The event object to pass forward.
+     */
+    publishEvent: GridEventPublisher;
+    /**
+     * Displays the error overlay component.
+     * @param {any} props Props to be passed to the `ErrorOverlay` component.
+     */
+    showError: (props: any) => void;
+    /**
+     * Unique identifier for each component instance in a page.
+     * @ignore - do not document.
+     */
+    instanceId: number;
+}

package/models/api/gridCoreApi.js

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

package/models/api/gridCsvExportApi.d.ts

@@ -0,0 +1,18 @@
+import { GridCsvExportOptions } from '../gridExport';
+/**
+ * The CSV export API interface that is available in the grid [[apiRef]].
+ */
+export interface GridCsvExportApi {
+    /**
+     * Returns the grid data as a CSV string.
+     * This method is used internally by `exportDataAsCsv`.
+     * @param {GridCsvExportOptions} options The options to apply on the export.
+     * @returns {string} The data in the CSV format.
+     */
+    getDataAsCsv: (options?: GridCsvExportOptions) => string;
+    /**
+     * Downloads and exports a CSV of the grid's data.
+     * @param {GridCsvExportOptions} options The options to apply on the export.
+     */
+    exportDataAsCsv: (options?: GridCsvExportOptions) => void;
+}

package/models/api/gridCsvExportApi.js

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

package/models/api/gridDensityApi.d.ts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+import { GridDensity, GridDensityTypes } from '../gridDensity';
+export interface GridDensityOption {
+    icon: React.ReactElement;
+    label: string;
+    value: GridDensityTypes;
+}
+/**
+ * The density API interface that is available in the grid `apiRef`.
+ */
+export interface GridDensityApi {
+    /**
+     * Sets the density of the grid.
+     * @param {string} density Can be: `"compact"`, `"standard"`, `"comfortable"`.
+     * @param {number} headerHeight The new header height.
+     * @param {number} rowHeight The new row height.
+     */
+    setDensity: (density: GridDensity, headerHeight?: number, rowHeight?: number) => void;
+}

package/models/api/gridDensityApi.js

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

package/models/api/gridDisableVirtualizationApi.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The API to disable the virtualization that is available in the grid [[apiRef]].
+ */
+export interface GridDisableVirtualizationApi {
+    /**
+     * Disables grid's virtualization.
+     * @ignore - do not document. Remove before releasing v5 stable version.
+     */
+    unstable_disableVirtualization: () => void;
+    /**
+     * Enables grid's virtualization.
+     * @ignore - do not document. Remove before releasing v5 stable version.
+     */
+    unstable_enableVirtualization: () => void;
+}

package/models/api/gridDisableVirtualizationApi.js

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

package/models/api/gridEditingApi.d.ts

@@ -0,0 +1,119 @@
+import { GridCellMode, GridRowMode, GridCellValue } from '../gridCell';
+import { GridEditRowsModel, GridEditCellProps } from '../gridEditRowModel';
+import { GridRowId } from '../gridRows';
+import { GridCellParams } from '../params/gridCellParams';
+import { GridCommitCellChangeParams, GridEditCellValueParams, GridEditCellPropsParams } from '../params/gridEditCellParams';
+import { MuiBaseEvent } from '../muiEvent';
+/**
+ * The shared methods used by the cell and row editing API.
+ */
+export interface GridEditingSharedApi {
+    /**
+     * Set the edit rows model of the grid.
+     * @param {GridEditRowsModel} model The new edit rows model.
+     */
+    setEditRowsModel: (model: GridEditRowsModel) => void;
+    /**
+     * Gets the edit rows model of the grid.
+     * @returns {GridEditRowsModel} The edit rows model.
+     */
+    getEditRowsModel: () => GridEditRowsModel;
+    /**
+     * 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 if `preventCommitWhileValidating` is `true`. Otherwise, void.
+     */
+    setEditCellValue: (params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise<boolean> | void;
+    /**
+     * Immediatelly 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.
+     * @ignore - do not document.
+     */
+    unstable_runPendingEditCellValueChangeDebounce: (id: GridRowId, field?: string) => void;
+    /**
+     * @ignore - do not document.
+     */
+    unstable_setEditCellProps: (params: GridEditCellPropsParams) => GridEditCellProps;
+    /**
+     * @ignore - do not document.
+     */
+    unstable_parseValue: (id: GridRowId, field: string, value: GridCellValue) => GridCellValue;
+}
+/**
+ * The row editing API interface.
+ */
+export interface GridRowEditingApi extends GridEditingSharedApi {
+    /**
+     * Sets the mode of a row.
+     * @param {GridRowId} id The id of the row.
+     * @param {GridRowMode} mode Can be: `"edit"`, `"view"`.
+     */
+    setRowMode: (id: GridRowId, mode: GridRowMode) => void;
+    /**
+     * Gets the mode of a row.
+     * @param {GridRowId} id The id of the row.
+     * @returns {GridRowMode} Returns `"edit"` or `"view"`.
+     */
+    getRowMode: (id: GridRowId) => GridRowMode;
+    /**
+     * Updates the row at the given id with the values stored in the edit row model.
+     * @param {GridRowId} id The id to commit to.
+     * @param {React.SyntheticEvent} event The event to pass forward.
+     * @returns {boolean} A boolean indicating if there is an error.
+     */
+    commitRowChange: (id: GridRowId, event?: MuiBaseEvent) => boolean | Promise<boolean>;
+    /**
+     * Updates the value of a cell and calls all `preProcessEditCellProps` if necessary.
+     * @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.
+     * @ignore - do not document.
+     */
+    unstable_setRowEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
+}
+/**
+ * The cell editing API interface.
+ */
+export interface GridCellEditingApi extends GridEditingSharedApi {
+    /**
+     * Updates the field at the given id with the value stored in the edit row model.
+     * @param {GridCommitCellChangeParams} params The id and field to commit to.
+     * @param {React.SyntheticEvent} event The event to pass forward.
+     * @returns {boolean} A boolean indicating if there is an error.
+     */
+    commitCellChange: (params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean | Promise<boolean>;
+    /**
+     * Sets the mode of a cell.
+     * @param {GridRowId} id The id of the row.
+     * @param {string} field The field to change the mode.
+     * @param {GridCellMode} mode Can be: `"edit"`, `"view"`.
+     */
+    setCellMode: (id: GridRowId, field: string, mode: GridCellMode) => void;
+    /**
+     * 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;
+    /**
+     * Updates the value of a cell and calls `preProcessEditCellProps` if necessary.
+     * @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.
+     * @ignore - do not document.
+     */
+    unstable_setCellEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
+}
+/**
+ * The editing API interface that is available in the grid `apiRef`.
+ */
+export interface GridEditingApi extends GridCellEditingApi, GridRowEditingApi {
+}

package/models/api/gridEditingApi.js

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

package/models/api/gridFilterApi.d.ts

@@ -0,0 +1,47 @@
+import { GridRowId, GridRowModel } from '../gridRows';
+import { GridFilterModel } from '../gridFilterModel';
+import { GridFilterItem, GridLinkOperator } from '../gridFilterItem';
+/**
+ * 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.
+     */
+    showFilterPanel: (targetColumnField?: string) => void;
+    /**
+     * Hides the filter panel.
+     */
+    hideFilterPanel: () => void;
+    /**
+     * Updates or inserts a [[GridFilterItem]].
+     * @param {GridFilterItem} item The filter to update.
+     */
+    upsertFilterItem: (item: 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 [[GridLinkOperator]] used to connect the filters.
+     * @param {GridLinkOperator} operator The new link operator. It can be: `"and"` or `"or`".
+     */
+    setFilterLinkOperator: (operator: GridLinkOperator) => void;
+    /**
+     * Sets the filter model to the one given by `model`.
+     * @param {GridFilterModel} model The new filter model.
+     */
+    setFilterModel: (model: GridFilterModel) => void;
+    /**
+     * Returns a sorted `Map` containing only the visible rows.
+     * @returns {Map<GridRowId, GridRowModel>} The sorted `Map`.
+     */
+    getVisibleRowModels: () => Map<GridRowId, GridRowModel>;
+}

package/models/api/gridFilterApi.js

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

package/models/api/gridFocusApi.d.ts

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

package/models/api/gridFocusApi.js

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