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

package/modern/material/variables.js

@@ -1,96 +0,0 @@
-import * as React from 'react';
-import { alpha, darken, lighten } from '@mui/material/styles';
-import { useTheme } from '@mui/material/styles';
-import { hash } from '@mui/x-internals/hash';
-import { vars } from "../constants/cssVariables.js";
-export function useMaterialCSSVariables() {
-  const theme = useTheme();
-  return React.useMemo(() => {
-    const id = hash(JSON.stringify(theme));
-    const variables = transformTheme(theme);
-    return {
-      id,
-      variables
-    };
-  }, [theme]);
-}
-function transformTheme(t) {
-  const borderColor = getBorderColor(t);
-  const dataGridPalette = t.palette.DataGrid; // FIXME: docs typecheck error
-
-  const backgroundBase = dataGridPalette?.bg ?? (t.vars || t).palette.background.default;
-  const backgroundHeader = dataGridPalette?.headerBg ?? backgroundBase;
-  const backgroundPinned = dataGridPalette?.pinnedBg ?? backgroundBase;
-  const backgroundBackdrop = t.vars ? `rgba(${t.vars.palette.background.defaultChannel} / ${t.vars.palette.action.disabledOpacity})` : alpha(t.palette.background.default, t.palette.action.disabledOpacity);
-  const backgroundOverlay = t.palette.mode === 'dark' ? `color-mix(in srgb, ${(t.vars || t).palette.background.paper} 95%, #fff)` : (t.vars || t).palette.background.paper;
-  const selectedColor = t.vars ? `rgb(${t.vars.palette.primary.mainChannel})` : t.palette.primary.main;
-  const radius = getRadius(t);
-  const fontBody = t.vars?.font?.body2 ?? formatFont(t.typography.body2);
-  const fontSmall = t.vars?.font?.caption ?? formatFont(t.typography.caption);
-  const fontLarge = t.vars?.font?.body1 ?? formatFont(t.typography.body1);
-  const k = vars.keys;
-  return {
-    [k.spacingUnit]: t.vars ? t.vars.spacing ?? t.spacing(1) : t.spacing(1),
-    [k.colors.border.base]: borderColor,
-    [k.colors.background.base]: backgroundBase,
-    [k.colors.background.overlay]: backgroundOverlay,
-    [k.colors.background.backdrop]: backgroundBackdrop,
-    [k.colors.foreground.base]: (t.vars || t).palette.text.primary,
-    [k.colors.foreground.muted]: (t.vars || t).palette.text.secondary,
-    [k.colors.foreground.accent]: (t.vars || t).palette.primary.dark,
-    [k.colors.foreground.disabled]: (t.vars || t).palette.text.disabled,
-    [k.colors.interactive.hover]: removeOpacity((t.vars || t).palette.action.hover),
-    [k.colors.interactive.hoverOpacity]: (t.vars || t).palette.action.hoverOpacity,
-    [k.colors.interactive.focus]: removeOpacity((t.vars || t).palette.primary.main),
-    [k.colors.interactive.focusOpacity]: (t.vars || t).palette.action.focusOpacity,
-    [k.colors.interactive.disabled]: removeOpacity((t.vars || t).palette.action.disabled),
-    [k.colors.interactive.disabledOpacity]: (t.vars || t).palette.action.disabledOpacity,
-    [k.colors.interactive.selected]: selectedColor,
-    [k.colors.interactive.selectedOpacity]: (t.vars || t).palette.action.selectedOpacity,
-    [k.header.background.base]: backgroundHeader,
-    [k.cell.background.pinned]: backgroundPinned,
-    [k.radius.base]: radius,
-    [k.typography.fontFamily.base]: t.typography.fontFamily,
-    [k.typography.fontWeight.light]: t.typography.fontWeightLight,
-    [k.typography.fontWeight.regular]: t.typography.fontWeightRegular,
-    [k.typography.fontWeight.medium]: t.typography.fontWeightMedium,
-    [k.typography.fontWeight.bold]: t.typography.fontWeightBold,
-    [k.typography.font.body]: fontBody,
-    [k.typography.font.small]: fontSmall,
-    [k.typography.font.large]: fontLarge,
-    [k.transitions.easing.easeIn]: t.transitions.easing.easeIn,
-    [k.transitions.easing.easeOut]: t.transitions.easing.easeOut,
-    [k.transitions.easing.easeInOut]: t.transitions.easing.easeInOut,
-    [k.transitions.duration.short]: `${t.transitions.duration.shorter}ms`,
-    [k.transitions.duration.base]: `${t.transitions.duration.short}ms`,
-    [k.transitions.duration.long]: `${t.transitions.duration.standard}ms`,
-    [k.shadows.base]: (t.vars || t).shadows[2],
-    [k.shadows.overlay]: (t.vars || t).shadows[8],
-    [k.zIndex.panel]: (t.vars || t).zIndex.modal,
-    [k.zIndex.menu]: (t.vars || t).zIndex.modal
-  };
-}
-function getRadius(theme) {
-  if (theme.vars) {
-    return theme.vars.shape.borderRadius;
-  }
-  return typeof theme.shape.borderRadius === 'number' ? `${theme.shape.borderRadius}px` : theme.shape.borderRadius;
-}
-function getBorderColor(theme) {
-  if (theme.vars) {
-    return theme.vars.palette.TableCell.border;
-  }
-  if (theme.palette.mode === 'light') {
-    return lighten(alpha(theme.palette.divider, 1), 0.88);
-  }
-  return darken(alpha(theme.palette.divider, 1), 0.68);
-}
-function setOpacity(color, opacity) {
-  return `rgba(from ${color} r g b / ${opacity})`;
-}
-function removeOpacity(color) {
-  return setOpacity(color, 1);
-}
-function formatFont(font) {
-  return `${font.fontWeight} ${font.fontSize} / ${font.lineHeight} ${font.fontFamily}`;
-}

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

@@ -1,34 +0,0 @@
-import type { GridColumnApi } from './gridColumnApi';
-import type { GridColumnMenuApi } from './gridColumnMenuApi';
-import type { GridCoreApi, GridCorePrivateApi } from './gridCoreApi';
-import type { GridCsvExportApi } from './gridCsvExportApi';
-import type { GridDensityApi } from './gridDensityApi';
-import type { GridEditingApi, GridEditingPrivateApi } from './gridEditingApi';
-import type { GridFilterApi } from './gridFilterApi';
-import type { GridFocusApi, GridFocusPrivateApi } from './gridFocusApi';
-import type { GridLocaleTextApi } from './gridLocaleTextApi';
-import type { GridParamsApi, GridParamsPrivateApi } from './gridParamsApi';
-import type { GridPreferencesPanelApi } from './gridPreferencesPanelApi';
-import type { GridPrintExportApi } from './gridPrintExportApi';
-import type { GridRowApi, GridRowProPrivateApi } from './gridRowApi';
-import type { GridRowsMetaApi, GridRowsMetaPrivateApi } from './gridRowsMetaApi';
-import type { GridRowSelectionApi } from './gridRowSelectionApi';
-import type { GridSortApi } from './gridSortApi';
-import type { GridStateApi, GridStatePrivateApi } from './gridStateApi';
-import type { GridLoggerApi } from './gridLoggerApi';
-import type { GridScrollApi } from './gridScrollApi';
-import type { GridVirtualizationApi, GridVirtualizationPrivateApi } from './gridVirtualizationApi';
-import type { GridPipeProcessingApi, GridPipeProcessingPrivateApi } from '../../hooks/core/pipeProcessing';
-import type { GridColumnSpanningApi, GridColumnSpanningPrivateApi } from './gridColumnSpanning';
-import type { GridStrategyProcessingApi } from '../../hooks/core/strategyProcessing';
-import type { GridDimensionsApi, GridDimensionsPrivateApi } from '../../hooks/features/dimensions/gridDimensionsApi';
-import type { GridPaginationApi } from '../../hooks/features/pagination';
-import type { GridStatePersistenceApi } from '../../hooks/features/statePersistence';
-import type { GridColumnGroupingApi } from './gridColumnGroupingApi';
-import type { GridInitialStateCommunity, GridStateCommunity } from '../gridStateCommunity';
-import type { GridHeaderFilteringApi, GridHeaderFilteringPrivateApi } from './gridHeaderFilteringApi';
-import type { DataGridProcessedProps } from '../props/DataGridProps';
-import type { GridColumnResizeApi } from '../../hooks/features/columnResize';
-export interface GridApiCommon<GridState extends GridStateCommunity = any, GridInitialState extends GridInitialStateCommunity = any> extends GridCoreApi, GridPipeProcessingApi, GridDensityApi, GridDimensionsApi, GridRowApi, GridRowsMetaApi, GridEditingApi, GridParamsApi, GridColumnApi, GridRowSelectionApi, GridSortApi, GridPaginationApi, GridCsvExportApi, GridFocusApi, GridFilterApi, GridColumnMenuApi, GridPreferencesPanelApi, GridPrintExportApi, GridVirtualizationApi, GridLocaleTextApi, GridScrollApi, GridColumnSpanningApi, GridStateApi<GridState>, GridStatePersistenceApi<GridInitialState>, GridColumnGroupingApi, GridHeaderFilteringApi, GridColumnResizeApi {}
-export interface GridPrivateOnlyApiCommon<Api extends GridApiCommon, PrivateApi extends GridPrivateApiCommon, Props extends DataGridProcessedProps> extends GridCorePrivateApi<Api, PrivateApi, Props>, GridStatePrivateApi<PrivateApi['state']>, GridPipeProcessingPrivateApi, GridStrategyProcessingApi, GridColumnSpanningPrivateApi, GridRowsMetaPrivateApi, GridDimensionsPrivateApi, GridEditingPrivateApi, GridLoggerApi, GridFocusPrivateApi, GridHeaderFilteringPrivateApi, GridVirtualizationPrivateApi, GridRowProPrivateApi, GridParamsPrivateApi {}
-export interface GridPrivateApiCommon extends GridApiCommon, GridPrivateOnlyApiCommon<GridApiCommon, GridPrivateApiCommon, DataGridProcessedProps> {}

package/modern/models/api/gridApiCommon.js

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

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

@@ -1,12 +0,0 @@
-import type { GridDataSourceApi } from '../../hooks/features/dataSource/models';
-import type { GridInitialStateCommunity, GridStateCommunity } from '../gridStateCommunity';
-import type { DataGridProcessedProps } from '../props/DataGridProps';
-import type { GridApiCommon, GridPrivateOnlyApiCommon } from './gridApiCommon';
-import type { GridColumnReorderApi } from './gridColumnApi';
-import type { GridRowProApi } from './gridRowApi';
-import type { GridRowMultiSelectionApi } from './gridRowSelectionApi';
-/**
- * The API of the community version of the Data Grid.
- */
-export interface GridApiCommunity extends GridApiCommon<GridStateCommunity, GridInitialStateCommunity>, GridDataSourceApi {}
-export interface GridPrivateApiCommunity extends GridApiCommunity, GridPrivateOnlyApiCommon<GridApiCommunity, GridPrivateApiCommunity, DataGridProcessedProps>, GridRowMultiSelectionApi, GridColumnReorderApi, GridRowProApi {}

package/modern/models/api/gridApiCommunity.js

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

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

@@ -1,15 +0,0 @@
-import type { GridControlledStateReasonLookup } from '../events/gridEventLookup';
-import type { GridApiCommon } from './gridApiCommon';
-/**
- * Additional details passed to the callbacks
- */
-export interface GridCallbackDetails<K extends keyof GridControlledStateReasonLookup = any> {
-  /**
-   * The reason for this callback to have been called.
-   */
-  reason?: GridControlledStateReasonLookup[K];
-  /**
-   * GridApi that let you manipulate the grid.
-   */
-  api: GridApiCommon;
-}

package/modern/models/api/gridCallbackDetails.js

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

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

@@ -1,74 +0,0 @@
-import { GridColDef, GridStateColDef } from "../colDef/gridColDef.js";
-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 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 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;
-  /**
-   * Updates the width of a column.
-   * @param {string} field The column field.
-   * @param {number} width The new width.
-   */
-  setColumnWidth: (field: string, width: number) => void;
-  /**
-   * Gets the index of a column relative to the columns that are reachable by scroll.
-   * @param {string} field The column field.
-   * @returns {number} The index of the column.
-   */
-  getColumnIndexRelativeToVisibleColumns: (field: string) => number;
-}
-export interface GridColumnReorderApi {
-  /**
-   * 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;
-}

package/modern/models/api/gridColumnApi.js

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

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

@@ -1,19 +0,0 @@
-import { GridColumnGroupLookup } from "../../hooks/features/columnGrouping/gridColumnGroupsInterfaces.js";
-import { GridColumnGroup } from "../gridColumnGrouping.js";
-/**
- * The column grouping API interface that is available in the grid [[apiRef]].
- */
-export interface GridColumnGroupingApi {
-  /**
-   * Returns the id of the groups leading to the requested column.
-   * The array is ordered by increasing depth (the last element is the direct parent of the column).
-   * @param {string} field The field of of the column requested.
-   * @returns {string[]} The id of the groups leading to the requested column.
-   */
-  getColumnGroupPath: (field: string) => GridColumnGroup['groupId'][];
-  /**
-   * Returns the column group lookup.
-   * @returns {GridColumnGroupLookup} The column group lookup.
-   */
-  getAllGroupDetails: () => GridColumnGroupLookup;
-}

package/modern/models/api/gridColumnGroupingApi.js

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

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

@@ -1,19 +0,0 @@
-/**
- * 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/modern/models/api/gridColumnMenuApi.js

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

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

@@ -1,34 +0,0 @@
-import { GridStateColDef } from "../colDef/gridColDef.js";
-import { GridColumnIndex, GridCellColSpanInfo } from "../gridColumnSpanning.js";
-import { GridRowId } from "../gridRows.js";
-/**
- * The Column Spanning API interface that is available in the grid `apiRef`.
- */
-export interface GridColumnSpanningApi {
-  /**
-   * Returns cell colSpan info.
-   * @param {GridRowId} rowId The row id
-   * @param {number} columnIndex The column index (0-based)
-   * @returns {GridCellColSpanInfo|undefined} Cell colSpan info
-   * @ignore - do not document.
-   */
-  unstable_getCellColSpanInfo: (rowId: GridRowId, columnIndex: GridColumnIndex) => GridCellColSpanInfo | undefined;
-}
-export interface GridColumnSpanningPrivateApi {
-  /** Reset the colspan cache */
-  resetColSpan: () => void;
-  /**
-   * Calculate column spanning for each cell in the row
-   * @param {Object} options The options to apply on the calculation.
-   * @param {GridRowId} options.rowId The row id
-   * @param {number} options.minFirstColumn First visible column index
-   * @param {number} options.maxLastColumn Last visible column index
-   * @param {GridStateColDef[]} options.columns List of columns to calculate colSpan for
-   */
-  calculateColSpan: (options: {
-    rowId: GridRowId;
-    minFirstColumn: number;
-    maxLastColumn: number;
-    columns: GridStateColDef[];
-  }) => void;
-}

package/modern/models/api/gridColumnSpanning.js

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

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

@@ -1,96 +0,0 @@
-import * as React from 'react';
-import { EventManager, EventListenerOptions } from '@mui/x-internals/EventManager';
-import type { GridEventPublisher, GridEventListener, GridEvents } from '../events';
-import { Store } from "../../utils/Store.js";
-import type { GridApiCaches } from '../gridApiCaches';
-import type { GridApiCommon, GridPrivateApiCommon } from './gridApiCommon';
-import type { DataGridProcessedProps } from '../props/DataGridProps';
-/**
- * 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 | null>;
-  /**
-   * 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 GridEvents>(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;
-  /**
-   * Unique identifier for each component instance in a page.
-   * @ignore - do not document.
-   */
-  instanceId: {
-    id: number;
-  };
-  /**
-   * The pub/sub store containing a reference to the public state.
-   * @ignore - do not document.
-   */
-  store: Store<GridApiCommon['state']>;
-}
-export interface GridCorePrivateApi<GridPublicApi extends GridApiCommon, GridPrivateApi extends GridPrivateApiCommon, GridProps extends DataGridProcessedProps> {
-  /**
-   * The caches used by hooks and state initializers.
-   */
-  caches: GridApiCaches;
-  /**
-   * Registers a method on the public or private API.
-   * @param {'public' | 'private'} visibility The visibility of the methods.
-   * @param {Partial<GridApiRef>} methods The methods to register.
-   */
-  /**
-   * The generic event emitter manager.
-   */
-  eventManager: EventManager;
-  /**
-   * The React ref of the grid main container div element.
-   */
-  mainElementRef: React.RefObject<HTMLDivElement | null>;
-  /**
-   * The React ref of the grid's virtual scroller container element.
-   */
-  virtualScrollerRef: React.RefObject<HTMLDivElement | null>;
-  /**
-   * The React ref of the grid's vertical virtual scrollbar container element.
-   */
-  virtualScrollbarVerticalRef: React.RefObject<HTMLDivElement | null>;
-  /**
-   * The React ref of the grid's horizontal virtual scrollbar container element.
-   */
-  virtualScrollbarHorizontalRef: React.RefObject<HTMLDivElement | null>;
-  /**
-   * The React ref of the grid column container virtualized div element.
-   */
-  columnHeadersContainerRef: React.RefObject<HTMLDivElement | null>;
-  /**
-   * The React ref of the grid header filter row element.
-   */
-  headerFiltersElementRef?: React.RefObject<HTMLDivElement | null>;
-  register: <V extends 'public' | 'private', T extends (V extends 'public' ? Partial<GridPublicApi> : Partial<Omit<GridPrivateApi, keyof GridPublicApi>>)>(visibility: V, methods: T) => void;
-  /**
-   * Returns the public API.
-   * Can be useful on a feature hook if we want to pass the `apiRef` to a callback.
-   * Do not use it to access the public method in private parts of the codebase.
-   * @returns {GridPublicApi} The public api.
-   */
-  getPublicApi: () => GridPublicApi;
-  /**
-   * Allows to access the root props outside of the React component.
-   * Do not use in React components - use the `useGridRootProps` hook instead.
-   */
-  rootProps: GridProps;
-}

package/modern/models/api/gridCoreApi.js

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

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

@@ -1,18 +0,0 @@
-import { GridCsvExportOptions } from "../gridExport.js";
-/**
- * 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/modern/models/api/gridCsvExportApi.js

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

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

@@ -1,17 +0,0 @@
-import * as React from 'react';
-import { GridDensity } from "../gridDensity.js";
-export interface GridDensityOption {
-  icon: React.ReactElement<any>;
-  label: string;
-  value: GridDensity;
-}
-/**
- * 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"`.
-   */
-  setDensity: (density: GridDensity) => void;
-}

package/modern/models/api/gridDensityApi.js

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