@mui/x-data-grid/models/configuration/gridConfiguration.d.mts

The Community plan edition of the MUI X Data Grid components.

import type * as React from 'react';
import type { GridRowAriaAttributesInternalHook, GridRowsOverridableMethodsInternalHook } from "./gridRowConfiguration.mjs";
import type { GridAggregationInternalHooks } from "./gridAggregationConfiguration.mjs";
import type { GridCellEditableInternalHook } from "./gridCellEditableConfiguration.mjs";
import type { GridCSSVariablesInterface } from "../../constants/cssVariables.mjs";
import type { GridPrivateApiCommon } from "../api/gridApiCommon.mjs";
import type { GridPrivateApiCommunity } from "../api/gridApiCommunity.mjs";
import type { DataGridProcessedProps } from "../props/DataGridProps.mjs";
import type { GridParamsOverridableMethodsInternalHook } from "./gridParamsConfiguration.mjs";
export interface GridAriaAttributesInternalHook {
  useGridAriaAttributes: () => React.HTMLAttributes<HTMLElement>;
}
export interface GridColumnHeaderAdornmentInternalHook {
  /**
   * Returns an optional adornment rendered inside a column header's title
   * content, at the start, before the title label. Placing it inside the
   * (non-reversed) title content keeps it on the same side of the title for
   * both left- and right-aligned headers. Called once per rendered header
   * cell, so the implementation may use hooks.
   * @param {string} field The column field.
   * @returns {React.ReactNode} The adornment node, or `null` for none.
   */
  useColumnHeaderAdornment: (field: string) => React.ReactNode;
}
export interface GridInternalHook<Api, Props> extends GridAriaAttributesInternalHook, GridRowAriaAttributesInternalHook, GridCellEditableInternalHook<Api, Props>, GridAggregationInternalHooks<Api, Props>, GridColumnHeaderAdornmentInternalHook, GridRowsOverridableMethodsInternalHook<Api, Props>, GridParamsOverridableMethodsInternalHook<Api> {
  useCSSVariables: () => {
    id: string;
    variables: GridCSSVariablesInterface;
  };
}
export interface GridConfiguration<Api extends GridPrivateApiCommon = GridPrivateApiCommunity, Props = DataGridProcessedProps> {
  hooks: GridInternalHook<Api, Props>;
}