@mui/x-data-grid/models/gridStateCommunity.d.ts

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

import type { GridColumnMenuState, GridColumnsInitialState, GridColumnsState, GridColumnsGroupingState, GridColumnPinningState, GridDensityState, GridDimensionsState, GridFilterInitialState, GridFilterState, GridFocusState, GridPaginationInitialState, GridPaginationState, GridPreferencePanelInitialState, GridPreferencePanelState, GridRowsState, GridSortingInitialState, GridSortingState, GridTabIndexState, GridVirtualizationState } from "../hooks/index.js";
import type { DataGridProcessedProps } from "./props/DataGridProps.js";
import type { GridRowsMetaState } from "../hooks/features/rows/gridRowsMetaState.js";
import type { GridEditingState } from "./gridEditRowModel.js";
import { GridHeaderFilteringState } from "./gridHeaderFilteringModel.js";
import type { GridRowSelectionModel } from "./gridRowSelectionModel.js";
import type { GridVisibleRowsLookupState } from "../hooks/features/filter/gridFilterState.js";
import type { GridColumnResizeState } from "../hooks/features/columnResize/index.js";
import type { GridRowSpanningState } from "../hooks/features/rows/useGridRowSpanning.js";
import type { GridListViewState } from "../hooks/features/listView/useGridListView.js";
/**
 * Some props are passed on the state to enable grid selectors to select
 * and react to them.
 */
type GridStateProps = Pick<DataGridProcessedProps, 'getRowId' | 'listView'>;
/**
 * The state of Data Grid.
 */
export interface GridStateCommunity {
  isRtl: boolean;
  props: GridStateProps;
  dimensions: GridDimensionsState;
  rows: GridRowsState;
  visibleRowsLookup: GridVisibleRowsLookupState;
  rowsMeta: GridRowsMetaState;
  editRows: GridEditingState;
  headerFiltering: GridHeaderFilteringState;
  pagination: GridPaginationState;
  columns: GridColumnsState;
  columnGrouping: GridColumnsGroupingState;
  columnMenu: GridColumnMenuState;
  pinnedColumns: GridColumnPinningState;
  sorting: GridSortingState;
  focus: GridFocusState;
  tabIndex: GridTabIndexState;
  rowSelection: GridRowSelectionModel;
  filter: GridFilterState;
  preferencePanel: GridPreferencePanelState;
  density: GridDensityState;
  virtualization: GridVirtualizationState;
  columnResize: GridColumnResizeState;
  rowSpanning: GridRowSpanningState;
  listViewColumn: GridListViewState;
}
/**
 * The initial state of Data Grid.
 */
export interface GridInitialStateCommunity {
  pagination?: GridPaginationInitialState;
  sorting?: GridSortingInitialState;
  filter?: GridFilterInitialState;
  columns?: GridColumnsInitialState;
  preferencePanel?: GridPreferencePanelInitialState;
  density?: GridDensityState;
  scroll?: {
    top: number;
    left: number;
  };
}
export {};