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

package/modern/models/gridExport.d.ts

@@ -1,157 +0,0 @@
-import { RefObject } from '@mui/x-internals/types';
-import { GridRowId } from "./gridRows.js";
-import type { GridApiCommon } from './api';
-import type { GridApiCommunity } from './api/gridApiCommunity';
-/**
- * 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';

package/modern/models/gridExport.js

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

package/modern/models/gridFeatureMode.d.ts

@@ -1 +0,0 @@
-export type GridFeatureMode = 'client' | 'server';

package/modern/models/gridFeatureMode.js

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

package/modern/models/gridFilterInputComponent.d.ts

@@ -1,32 +0,0 @@
-import * as React from 'react';
-import { RefObject } from '@mui/x-internals/types';
-import { GridFilterItem } from "./gridFilterItem.js";
-import type { GridApiCommon } from './api/gridApiCommon';
-import type { GridApiCommunity } from './api/gridApiCommunity';
-export type GridFilterInputSlotProps = {
-  size?: 'small' | 'medium';
-  label?: React.ReactNode;
-  placeholder?: string;
-};
-export type GridFilterInputValueProps<T extends GridFilterInputSlotProps = GridFilterInputSlotProps, Api extends GridApiCommon = GridApiCommunity> = {
-  item: GridFilterItem;
-  applyValue: (value: GridFilterItem) => void;
-  apiRef: RefObject<Api>;
-  inputRef?: React.Ref<HTMLElement | null>;
-  focusElementRef?: React.Ref<any>;
-  headerFilterMenu?: React.ReactNode;
-  clearButton?: React.ReactNode | null;
-  /**
-   * It is `true` if the filter either has a value or an operator with no value
-   * required is selected (for example `isEmpty`)
-   */
-  isFilterActive?: boolean;
-  onFocus?: React.FocusEventHandler;
-  onBlur?: React.FocusEventHandler;
-  tabIndex?: number;
-  disabled?: boolean;
-  className?: string;
-  slotProps?: {
-    root: T;
-  };
-};

package/modern/models/gridFilterInputComponent.js

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

package/modern/models/gridFilterItem.d.ts

@@ -1,30 +0,0 @@
-/**
- * Filter item definition interface.
- * @demos
- *   - [Custom filter operator](/x/react-data-grid/filtering/customization/#create-a-custom-operator)
- */
-export interface GridFilterItem {
-  /**
-   * Must be unique.
-   * Only useful when the model contains several items.
-   */
-  id?: number | string;
-  /**
-   * The column from which we want to filter the rows.
-   */
-  field: string;
-  /**
-   * The filtering value.
-   * The operator filtering function will decide for each row if the row values is correct compared to this value.
-   */
-  value?: any;
-  /**
-   * The name of the operator we want to apply.
-   */
-  operator: string;
-}
-declare enum GridLogicOperator {
-  And = "and",
-  Or = "or",
-}
-export { GridLogicOperator };

package/modern/models/gridFilterItem.js

@@ -1,11 +0,0 @@
-/**
- * Filter item definition interface.
- * @demos
- *   - [Custom filter operator](/x/react-data-grid/filtering/customization/#create-a-custom-operator)
- */
-var GridLogicOperator = /*#__PURE__*/function (GridLogicOperator) {
-  GridLogicOperator["And"] = "and";
-  GridLogicOperator["Or"] = "or";
-  return GridLogicOperator;
-}(GridLogicOperator || {});
-export { GridLogicOperator };

package/modern/models/gridFilterModel.d.ts

@@ -1,34 +0,0 @@
-import { GridFilterItem, GridLogicOperator } from "./gridFilterItem.js";
-/**
- * Model describing the filters to apply to the grid.
- * @demos
- *   - [Pass filters to the grid](/x/react-data-grid/filtering/#pass-filters-to-the-data-grid)
- */
-export interface GridFilterModel {
-  /**
-   * @default []
-   */
-  items: GridFilterItem[];
-  /**
-   * - `GridLogicOperator.And`: the row must pass all the filter items.
-   * - `GridLogicOperator.Or`: the row must pass at least on filter item.
-   * @default GridLogicOperator.And
-   */
-  logicOperator?: GridLogicOperator;
-  /**
-   * values used to quick filter rows
-   * @default []
-   */
-  quickFilterValues?: any[];
-  /**
-   * - `GridLogicOperator.And`: the row must pass all the values.
-   * - `GridLogicOperator.Or`: the row must pass at least one value.
-   * @default GridLogicOperator.And
-   */
-  quickFilterLogicOperator?: GridLogicOperator;
-  /**
-   * If `false`, the quick filter will also consider cell values from hidden columns.
-   * @default true
-   */
-  quickFilterExcludeHiddenColumns?: boolean;
-}

package/modern/models/gridFilterModel.js

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

package/modern/models/gridFilterOperator.d.ts

@@ -1,58 +0,0 @@
-import * as React from 'react';
-import { RefObject } from '@mui/x-internals/types';
-import { GridFilterItem } from "./gridFilterItem.js";
-import type { GridColDef } from './colDef/gridColDef';
-import type { GridValidRowModel } from './gridRows';
-import type { GridApiCommunity } from './api/gridApiCommunity';
-import type { GridFilterInputValueProps } from './gridFilterInputComponent';
-type ApplyFilterFn<R extends GridValidRowModel = any, V = any, F = V> = (value: V, row: R, column: GridColDef<R, V, F>, apiRef: RefObject<GridApiCommunity>) => boolean;
-export type GetApplyFilterFn<R extends GridValidRowModel = any, V = any, F = V> = (filterItem: GridFilterItem, column: GridColDef<R, V, F>) => null | ApplyFilterFn<R, V, F>;
-/**
- * Filter operator definition interface.
- * @demos
- *   - [Custom filter operator](/x/react-data-grid/filtering/customization/#create-a-custom-operator)
- */
-export interface GridFilterOperator<R extends GridValidRowModel = any, V = any, F = V, I extends GridFilterInputValueProps<any> = GridFilterInputValueProps> {
-  /**
-   * The label of the filter operator.
-   */
-  label?: string;
-  /**
-   * The label of the filter shown in header filter row.
-   */
-  headerLabel?: string;
-  /**
-   * The name of the filter operator.
-   * It will be matched with the `operator` property of the filter items.
-   */
-  value: string;
-  /**
-   * The callback that generates a filtering function for a given filter item and column.
-   * This function can return `null` to skip filtering for this item and column.
-   * @param {GridFilterItem} filterItem The filter item with which we want to filter the column.
-   * @param {GridColDef} column The column from which we want to filter the rows.
-   * @returns {null | ApplyFilterFn} The function to call to check if a row pass this filter item or not.
-   */
-  getApplyFilterFn: GetApplyFilterFn<R, V, F>;
-  /**
-   * The input component to render in the filter panel for this filter operator.
-   */
-  InputComponent?: React.JSXElementConstructor<I>;
-  /**
-   * The props to pass to the input component in the filter panel for this filter operator.
-   */
-  InputComponentProps?: Partial<I>;
-  /**
-   * Converts the value of a filter item to a human-readable form.
-   * @param {GridFilterItem['value']} value The filter item value.
-   * @returns {string} The value formatted to be displayed in the UI of filter button tooltip.
-   */
-  getValueAsString?: (value: GridFilterItem['value']) => string;
-  /**
-   * If `false`, filter operator doesn't require user-entered value to work.
-   * Usually should be set to `false` for filter operators that don't have `InputComponent` (for example `isEmpty`)
-   * @default true
-   */
-  requiresFilterValue?: boolean;
-}
-export {};

package/modern/models/gridFilterOperator.js

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

package/modern/models/gridHeaderFilteringModel.d.ts

@@ -1,6 +0,0 @@
-import { GridColDef } from "./colDef/index.js";
-export type GridHeaderFilteringState = {
-  enabled: boolean;
-  editing: GridColDef['field'] | null;
-  menuOpen: GridColDef['field'] | null;
-};

package/modern/models/gridHeaderFilteringModel.js

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

package/modern/models/gridIconSlotsComponent.d.ts

@@ -1,191 +0,0 @@
-import * as React from 'react';
-/**
- * Set of icons used in the grid component UI.
- */
-export interface GridIconSlotsComponent {
-  /**
-   * Icon displayed on the boolean cell to represent the true value.
-   * @default GridCheckIcon
-   */
-  booleanCellTrueIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the boolean cell to represent the false value.
-   * @default GridCloseIcon
-   */
-  booleanCellFalseIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the side of the column header title to display the filter input component.
-   * @default GridTripleDotsVerticalIcon
-   */
-  columnMenuIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the open filter button present in the toolbar by default.
-   * @default GridFilterListIcon
-   */
-  openFilterButtonIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the column header menu to show that a filter has been applied to the column.
-   * @default GridFilterAltIcon
-   */
-  columnFilteredIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the column menu selector tab.
-   * @default GridColumnIcon
-   */
-  columnSelectorIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the side of the column header title when unsorted.
-   * @default GridColumnUnsortedIcon
-   */
-  columnUnsortedIcon: React.JSXElementConstructor<any> | null;
-  /**
-   * Icon displayed on the side of the column header title when sorted in ascending order.
-   * @default GridArrowUpwardIcon
-   */
-  columnSortedAscendingIcon: React.JSXElementConstructor<any> | null;
-  /**
-   * Icon displayed on the side of the column header title when sorted in descending order.
-   * @default GridArrowDownwardIcon
-   */
-  columnSortedDescendingIcon: React.JSXElementConstructor<any> | null;
-  /**
-   * Icon displayed in between two column headers that allows to resize the column header.
-   * @default GridSeparatorIcon
-   */
-  columnResizeIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the compact density option in the toolbar.
-   * @default GridViewHeadlineIcon
-   */
-  densityCompactIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the standard density option in the toolbar.
-   * @default GridTableRowsIcon
-   */
-  densityStandardIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the "comfortable" density option in the toolbar.
-   * @default GridViewStreamIcon
-   */
-  densityComfortableIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the open export button present in the toolbar by default.
-   * @default GridDownloadIcon
-   */
-  exportIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the `actions` column type to open the menu.
-   * @default GridMoreVertIcon
-   */
-  moreActionsIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the tree data toggling column when the children are collapsed
-   * @default GridKeyboardArrowRight
-   */
-  treeDataExpandIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the tree data toggling column when the children are expanded
-   * @default GridExpandMoreIcon
-   */
-  treeDataCollapseIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the grouping column when the children are collapsed
-   * @default GridKeyboardArrowRight
-   */
-  groupingCriteriaExpandIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the grouping column when the children are expanded
-   * @default GridExpandMoreIcon
-   */
-  groupingCriteriaCollapseIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the detail panel toggle column when collapsed.
-   * @default GridAddIcon
-   */
-  detailPanelExpandIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the detail panel toggle column when expanded.
-   * @default GridRemoveIcon
-   */
-  detailPanelCollapseIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed for deleting the filter from filter panel.
-   * @default GridAddIcon
-   */
-  filterPanelAddIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed for deleting the filter from filter panel.
-   * @default GridDeleteIcon
-   */
-  filterPanelDeleteIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed for deleting all the active filters from filter panel.
-   * @default GridDeleteForeverIcon
-   */
-  filterPanelRemoveAllIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the `reorder` column type to reorder a row.
-   * @default GridDragIcon
-   */
-  rowReorderIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the quick filter input.
-   * @default GridSearchIcon
-   */
-  quickFilterIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the quick filter reset input.
-   * @default GridCloseIcon
-   */
-  quickFilterClearIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for hiding column
-   * @default GridVisibilityOffIcon
-   */
-  columnMenuHideIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for ascending sort
-   * @default GridArrowUpwardIcon
-   */
-  columnMenuSortAscendingIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for descending sort
-   * @default GridArrowDownwardIcon
-   */
-  columnMenuSortDescendingIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for unsort
-   * @default null
-   */
-  columnMenuUnsortIcon: React.JSXElementConstructor<any> | null;
-  /**
-   * Icon displayed in column menu for filter
-   * @default GridFilterAltIcon
-   */
-  columnMenuFilterIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for showing all columns
-   * @default GridViewColumnIcon
-   */
-  columnMenuManageColumnsIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed in column menu for clearing values
-   * @default GridClearIcon
-   */
-  columnMenuClearIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the input while processing.
-   * @default GridLoadIcon
-   */
-  loadIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed on the column reorder button.
-   * @default GridDragIcon
-   */
-  columnReorderIcon: React.JSXElementConstructor<any>;
-  /**
-   * Icon displayed to indicate that a menu item is selected.
-   * @default GridCheckIcon
-   */
-  menuItemCheckIcon: React.JSXElementConstructor<any>;
-}

package/modern/models/gridIconSlotsComponent.js

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

package/modern/models/gridPaginationProps.d.ts

@@ -1,16 +0,0 @@
-export interface GridPaginationModel {
-  /**
-   * Set the number of rows in one page.
-   * If some of the rows have children (for instance in the tree data), this number represents the amount of top level rows wanted on each page.
-   * @default 100
-   */
-  pageSize: number;
-  /**
-   * The zero-based index of the current page.
-   * @default 0
-   */
-  page: number;
-}
-export interface GridPaginationMeta {
-  hasNextPage?: boolean;
-}

package/modern/models/gridPaginationProps.js

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

package/modern/models/gridRenderContextProps.d.ts

@@ -1,55 +0,0 @@
-/**
- * The object containing the column properties of the rendering state.
- */
-export interface GridRenderColumnsProps {
-  /**
-   * The index of the first rendered column.
-   */
-  firstColIdx: number;
-  /**
-   * The index of the last rendered column.
-   */
-  lastColIdx: number;
-  /**
-   * The left offset required to position the viewport at the beginning of the first rendered column.
-   */
-  leftEmptyWidth: number;
-  /**
-   * The right offset required to position the viewport to the end of the last rendered column.
-   */
-  rightEmptyWidth: number;
-}
-/**
- * The object containing the row properties of the rendering state.
- */
-export interface GridRenderRowProps {
-  /**
-   * The rendering zone page calculated from the scroll position.
-   */
-  page: number;
-  /**
-   * The index of the first rendered row.
-   */
-  firstRowIdx: number;
-  /**
-   * The index of the last rendered row.
-   */
-  lastRowIdx: number;
-}
-/**
- * The object containing the pagination properties of the rendering state.
- */
-export interface GridRenderPaginationProps {
-  /**
-   * The current page if pagination is enabled.
-   */
-  paginationCurrentPage?: number;
-  /**
-   * The page size if pagination is enabled.
-   */
-  pageSize?: number;
-}
-/**
- * The full rendering state.
- */
-export type GridRenderContextProps = GridRenderColumnsProps & GridRenderRowProps & GridRenderPaginationProps;

package/modern/models/gridRenderContextProps.js

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

package/modern/models/gridRowSelectionManager.d.ts

@@ -1,9 +0,0 @@
-import type { GridRowId } from './gridRows';
-import type { GridRowSelectionModel } from './gridRowSelectionModel';
-export interface RowSelectionManager {
-  data: Set<GridRowId>;
-  has(id: GridRowId): boolean;
-  select(id: GridRowId): void;
-  unselect(id: GridRowId): void;
-}
-export declare const createRowSelectionManager: (model: GridRowSelectionModel) => RowSelectionManager;

package/modern/models/gridRowSelectionManager.js

@@ -1,36 +0,0 @@
-class IncludeManager {
-  constructor(model) {
-    this.data = void 0;
-    this.data = model.ids;
-  }
-  has(id) {
-    return this.data.has(id);
-  }
-  select(id) {
-    this.data.add(id);
-  }
-  unselect(id) {
-    this.data.delete(id);
-  }
-}
-class ExcludeManager {
-  constructor(model) {
-    this.data = void 0;
-    this.data = model.ids;
-  }
-  has(id) {
-    return !this.data.has(id);
-  }
-  select(id) {
-    this.data.delete(id);
-  }
-  unselect(id) {
-    this.data.add(id);
-  }
-}
-export const createRowSelectionManager = model => {
-  if (model.type === 'include') {
-    return new IncludeManager(model);
-  }
-  return new ExcludeManager(model);
-};