Skip to content

[DataGrid] Refactor: move skeleton to leaf import #15931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romgrk merged 4 commits into from
Dec 20, 2024
Merged

[DataGrid] Refactor: move skeleton to leaf import #15931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9054d6c
refactor: move skeleton to leaf import
romgrk Dec 18, 2024
773d23a
fix
romgrk Dec 18, 2024
15363c9
doc: update
romgrk Dec 19, 2024
e5a4c6d
Merge branch 'master' into refactor-agnostic-skeleton
romgrk Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/pages/x/api/data-grid/data-grid-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,13 @@
{
"name": "baseSelectOption",
"description": "The custom SelectOption component used in the grid.",
"default": "MenuItem",
"default": "SelectOption",
"class": null
},
{
"name": "baseSkeleton",
"description": "The custom Skeleton component used in the grid.",
"default": "Skeleton",
"class": null
},
{
Expand Down
8 changes: 7 additions & 1 deletion docs/pages/x/api/data-grid/data-grid-pro.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,13 @@
{
"name": "baseSelectOption",
"description": "The custom SelectOption component used in the grid.",
"default": "MenuItem",
"default": "SelectOption",
"class": null
},
{
"name": "baseSkeleton",
"description": "The custom Skeleton component used in the grid.",
"default": "Skeleton",
"class": null
},
{
Expand Down
8 changes: 7 additions & 1 deletion docs/pages/x/api/data-grid/data-grid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,13 @@
{
"name": "baseSelectOption",
"description": "The custom SelectOption component used in the grid.",
"default": "MenuItem",
"default": "SelectOption",
"class": null
},
{
"name": "baseSkeleton",
"description": "The custom Skeleton component used in the grid.",
"default": "Skeleton",
"class": null
},
{
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1274,6 +1274,7 @@
"basePopper": "The custom Popper component used in the grid.",
"baseSelect": "The custom Select component used in the grid.",
"baseSelectOption": "The custom SelectOption component used in the grid.",
"baseSkeleton": "The custom Skeleton component used in the grid.",
"baseTextField": "The custom TextField component used in the grid.",
"baseTooltip": "The custom Tooltip component used in the grid.",
"booleanCellFalseIcon": "Icon displayed on the boolean cell to represent the false value.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1212,6 +1212,7 @@
"basePopper": "The custom Popper component used in the grid.",
"baseSelect": "The custom Select component used in the grid.",
"baseSelectOption": "The custom SelectOption component used in the grid.",
"baseSkeleton": "The custom Skeleton component used in the grid.",
"baseTextField": "The custom TextField component used in the grid.",
"baseTooltip": "The custom Tooltip component used in the grid.",
"booleanCellFalseIcon": "Icon displayed on the boolean cell to represent the false value.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid/data-grid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,6 +1086,7 @@
"basePopper": "The custom Popper component used in the grid.",
"baseSelect": "The custom Select component used in the grid.",
"baseSelectOption": "The custom SelectOption component used in the grid.",
"baseSkeleton": "The custom Skeleton component used in the grid.",
"baseTextField": "The custom TextField component used in the grid.",
"baseTooltip": "The custom Tooltip component used in the grid.",
"booleanCellFalseIcon": "Icon displayed on the boolean cell to represent the false value.",
Expand Down
3 changes: 1 addition & 2 deletions packages/x-data-grid/src/components/cell/GridSkeletonCell.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import Skeleton from '@mui/material/Skeleton';
import {
unstable_composeClasses as composeClasses,
unstable_capitalize as capitalize,
Expand Down Expand Up @@ -99,7 +98,7 @@ function GridSkeletonCell(props: GridSkeletonCellProps) {
style={{ height, maxWidth: width, minWidth: width, ...style }}
{...other}
>
{!empty && <Skeleton {...skeletonProps} />}
{!empty && <rootProps.slots.baseSkeleton {...skeletonProps} />}
</div>
);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/x-data-grid/src/material/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import MUITooltip from '@mui/material/Tooltip';
import MUIPopper from '@mui/material/Popper';
import MUIInputLabel from '@mui/material/InputLabel';
import MUIChip from '@mui/material/Chip';
import MUISkeleton from '@mui/material/Skeleton';
import { GridColumnUnsortedIcon } from './icons/GridColumnUnsortedIcon';
import {
GridAddIcon,
Expand Down Expand Up @@ -107,6 +108,7 @@ const baseSlots: GridBaseSlots = {
basePopper: MUIPopper,
baseInputLabel: MUIInputLabel,
baseSelectOption: MUISelectOption,
baseSkeleton: MUISkeleton,
baseChip: MUIChip,
};

Expand Down
6 changes: 6 additions & 0 deletions packages/x-data-grid/src/models/gridBaseSlots.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ export type CircularProgressProps = {
};

export type LinearProgressProps = {};

export type SkeletonProps = {
variant?: 'circular' | 'text';
width?: number | string;
height?: number | string;
};
7 changes: 6 additions & 1 deletion packages/x-data-grid/src/models/gridSlotsComponent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,14 @@ export interface GridBaseSlots {
baseInputLabel: React.JSXElementConstructor<GridSlotProps['baseInputLabel']>;
/**
* The custom SelectOption component used in the grid.
* @default MenuItem
* @default SelectOption
*/
baseSelectOption: React.JSXElementConstructor<GridSlotProps['baseSelectOption']>;
/**
* The custom Skeleton component used in the grid.
* @default Skeleton
*/
baseSkeleton: React.JSXElementConstructor<GridSlotProps['baseSkeleton']>;
}

/**
Expand Down
3 changes: 3 additions & 0 deletions packages/x-data-grid/src/models/gridSlotsComponentsProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import type {
DividerProps,
LinearProgressProps,
MenuItemProps,
SkeletonProps,
} from './gridBaseSlots';

type RootProps = React.HTMLAttributes<HTMLDivElement> & Record<`data-${string}`, string>;
Expand All @@ -65,6 +66,7 @@ export interface BaseTooltipPropsOverrides {}
export interface BasePopperPropsOverrides {}
export interface BaseInputLabelPropsOverrides {}
export interface BaseSelectOptionPropsOverrides {}
export interface BaseSkeletonPropsOverrides {}
export interface BaseChipPropsOverrides {}

export interface CellPropsOverrides {}
Expand Down Expand Up @@ -110,6 +112,7 @@ interface BaseSlotProps {
value: any;
children?: React.ReactNode;
} & BaseSelectOptionPropsOverrides;
baseSkeleton: SkeletonProps & BaseSkeletonPropsOverrides;
baseChip: ChipProps & BaseChipPropsOverrides;
}

Expand Down
1 change: 1 addition & 0 deletions scripts/x-data-grid-premium.exports.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
{ "name": "BasePopperPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectOptionPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectPropsOverrides", "kind": "Interface" },
{ "name": "BaseSkeletonPropsOverrides", "kind": "Interface" },
{ "name": "BaseSwitchPropsOverrides", "kind": "Interface" },
{ "name": "BaseTextFieldPropsOverrides", "kind": "Interface" },
{ "name": "BaseTooltipPropsOverrides", "kind": "Interface" },
Expand Down
1 change: 1 addition & 0 deletions scripts/x-data-grid-pro.exports.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
{ "name": "BasePopperPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectOptionPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectPropsOverrides", "kind": "Interface" },
{ "name": "BaseSkeletonPropsOverrides", "kind": "Interface" },
{ "name": "BaseSwitchPropsOverrides", "kind": "Interface" },
{ "name": "BaseTextFieldPropsOverrides", "kind": "Interface" },
{ "name": "BaseTooltipPropsOverrides", "kind": "Interface" },
Expand Down
1 change: 1 addition & 0 deletions scripts/x-data-grid.exports.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
{ "name": "BasePopperPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectOptionPropsOverrides", "kind": "Interface" },
{ "name": "BaseSelectPropsOverrides", "kind": "Interface" },
{ "name": "BaseSkeletonPropsOverrides", "kind": "Interface" },
{ "name": "BaseSwitchPropsOverrides", "kind": "Interface" },
{ "name": "BaseTextFieldPropsOverrides", "kind": "Interface" },
{ "name": "BaseTooltipPropsOverrides", "kind": "Interface" },
Expand Down