@mui/x-data-grid
Version:
The Community plan edition of the Data Grid components (MUI X).
37 lines • 1.61 kB
JavaScript
import { useGridSelector } from "../../utils/index.js";
import { useGridApiContext } from "../../utils/useGridApiContext.js";
import { useGridRootProps } from "../../utils/useGridRootProps.js";
import { gridExpandedRowCountSelector } from "../filter/index.js";
import { gridRowCountSelector, gridRowsLoadingSelector } from "../rows/index.js";
import { gridPinnedRowsCountSelector } from "../rows/gridRowsSelector.js";
/**
* Uses the grid state to determine which overlay to display.
* Returns the active overlay type and the active loading overlay variant.
*/
export const useGridOverlays = () => {
const apiRef = useGridApiContext();
const rootProps = useGridRootProps();
const totalRowCount = useGridSelector(apiRef, gridRowCountSelector);
const visibleRowCount = useGridSelector(apiRef, gridExpandedRowCountSelector);
const pinnedRowsCount = useGridSelector(apiRef, gridPinnedRowsCountSelector);
const noRows = totalRowCount === 0 && pinnedRowsCount === 0;
const loading = useGridSelector(apiRef, gridRowsLoadingSelector);
const showNoRowsOverlay = !loading && noRows;
const showNoResultsOverlay = !loading && totalRowCount > 0 && visibleRowCount === 0;
let overlayType = null;
let loadingOverlayVariant = null;
if (showNoRowsOverlay) {
overlayType = 'noRowsOverlay';
}
if (showNoResultsOverlay) {
overlayType = 'noResultsOverlay';
}
if (loading) {
overlayType = 'loadingOverlay';
loadingOverlayVariant = rootProps.slotProps?.loadingOverlay?.[noRows ? 'noRowsVariant' : 'variant'] || null;
}
return {
overlayType,
loadingOverlayVariant
};
};