From 76b62133c7bb9612bf6f9ea21da87a1075250c1c Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Fri, 23 Aug 2024 19:29:26 +0200 Subject: [PATCH 01/13] add missing themeAugmentation to charts pro --- .../src/themeAugmentation/components.d.ts | 31 +++++++++++ .../src/themeAugmentation/index.js | 1 + .../src/themeAugmentation/index.ts | 4 ++ .../src/themeAugmentation/overrides.d.ts | 14 +++++ .../src/themeAugmentation/props.d.ts | 26 +++++++++ .../themeAugmentation.spec.ts | 53 +++++++++++++++++++ 6 files changed, 129 insertions(+) create mode 100644 packages/x-charts-pro/src/themeAugmentation/components.d.ts create mode 100644 packages/x-charts-pro/src/themeAugmentation/index.js create mode 100644 packages/x-charts-pro/src/themeAugmentation/index.ts create mode 100644 packages/x-charts-pro/src/themeAugmentation/overrides.d.ts create mode 100644 packages/x-charts-pro/src/themeAugmentation/props.d.ts create mode 100644 packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts diff --git a/packages/x-charts-pro/src/themeAugmentation/components.d.ts b/packages/x-charts-pro/src/themeAugmentation/components.d.ts new file mode 100644 index 0000000000000..e622c4273bc12 --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/components.d.ts @@ -0,0 +1,31 @@ +import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles'; + +export interface ChartsProComponents { + // BarChartPro components + MuiBarChartPro: { + defaultProps?: ComponentsProps['MuiBarChartPro']; + }; + // LineChartPro components + MuiLineChartPro: { + defaultProps?: ComponentsProps['MuiLineChartPro']; + }; + // Heatmap components + MuiHeatmap: { + defaultProps?: ComponentsProps['MuiHeatmap']; + styleOverrides?: ComponentsOverrides['MuiHeatmap']; + }; + MuiHeatmapItem: { + defaultProps?: ComponentsProps['MuiHeatmapItem']; + }; + MuiHeatmapPlot: { + defaultProps?: ComponentsProps['MuiHeatmapPlot']; + }; + // ScatterChartPro components + MuiScatterChartPro: { + defaultProps?: ComponentsProps['MuiScatterChartPro']; + }; +} + +declare module '@mui/material/styles' { + interface Components extends ChartsProComponents {} +} diff --git a/packages/x-charts-pro/src/themeAugmentation/index.js b/packages/x-charts-pro/src/themeAugmentation/index.js new file mode 100644 index 0000000000000..6467405078b09 --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/index.js @@ -0,0 +1 @@ +// Prefer to use `import type {} from '@mui/x-charts-pro/themeAugmentation';` instead to avoid importing an empty file. diff --git a/packages/x-charts-pro/src/themeAugmentation/index.ts b/packages/x-charts-pro/src/themeAugmentation/index.ts new file mode 100644 index 0000000000000..1a4a7fc3c80d0 --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/index.ts @@ -0,0 +1,4 @@ +export * from '@mui/x-charts/themeAugmentation'; +export * from './overrides'; +export * from './props'; +export * from './components'; diff --git a/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts b/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts new file mode 100644 index 0000000000000..2cf95e4906cee --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts @@ -0,0 +1,14 @@ +import { HeatmapClassKey } from '../Heatmap'; + +// prettier-ignore +export interface ChartsProComponentNameToClassKey { + // Heatmap components + MuiHeatmap: HeatmapClassKey; +} + +declare module '@mui/material/styles' { + interface ComponentNameToClassKey extends ChartsProComponentNameToClassKey {} +} + +// disable automatic export +export {}; diff --git a/packages/x-charts-pro/src/themeAugmentation/props.d.ts b/packages/x-charts-pro/src/themeAugmentation/props.d.ts new file mode 100644 index 0000000000000..d102fd6185159 --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/props.d.ts @@ -0,0 +1,26 @@ +import { ScatterChartProps } from '@mui/x-charts'; +import { BarChartProProps } from '../BarChartPro'; +import { HeatmapProps } from '../Heatmap/Heatmap'; +import { LineChartProProps } from '../LineChartPro'; +import { HeatmapItemProps } from '../Heatmap/HeatmapItem'; +import { HeatmapPlotProps } from '../Heatmap/HeatmapPlot'; + +export interface ChartsProComponentsPropsList { + // BarChartPro components + MuiBarChartPro: BarChartProProps; + // LineChartPro components + MuiLineChartPro: LineChartProProps; + // Heatmap components + MuiHeatmap: HeatmapProps; + MuiHeatmapItem: HeatmapItemProps; + MuiHeatmapPlot: HeatmapPlotProps; + // ScatterChartPro components + MuiScatterChartPro: ScatterChartProps; +} + +declare module '@mui/material/styles' { + interface ComponentsPropsList extends ChartsProComponentsPropsList {} +} + +// disable automatic export +export {}; diff --git a/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts b/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts new file mode 100644 index 0000000000000..caca18818c7c2 --- /dev/null +++ b/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts @@ -0,0 +1,53 @@ +import { createTheme } from '@mui/material/styles'; + +createTheme({ + components: { + MuiBarChartPro: { + defaultProps: { + title: 'toto', + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + }, + MuiLineChartPro: { + defaultProps: { + title: 'toto', + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + }, + MuiScatterChartPro: { + defaultProps: { + title: 'toto', + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + }, + MuiHeatmap: { + defaultProps: { + title: 'toto', + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + styleOverrides: { + highlighted: { backgroundColor: 'red' }, + // @ts-expect-error invalid MuiChartsAxis class key + constent: { color: 'red' }, + }, + }, + MuiHeatmapItem: { + defaultProps: { + seriesId: 'toto', + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + }, + MuiHeatmapPlot: { + defaultProps: { + slotProps: { cell: { id: 'toto' } }, + // @ts-expect-error invalid MuiChartsAxis prop + someRandomProp: true, + }, + }, + }, +}); From cc92e2be3897446cafb407fb79a994a041f8e4c2 Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Fri, 23 Aug 2024 20:22:55 +0200 Subject: [PATCH 02/13] update docs --- .../charts/getting-started/getting-started.md | 31 +++++++ .../charts/bar-chart-pro/bar-chart-pro.json | 6 +- .../api-docs/charts/bar-chart/bar-chart.json | 6 +- .../chart-container-pro.json | 4 +- .../chart-container/chart-container.json | 4 +- .../api-docs/charts/heatmap/heatmap.json | 6 +- .../charts/line-chart-pro/line-chart-pro.json | 6 +- .../charts/line-chart/line-chart.json | 6 +- .../api-docs/charts/pie-chart/pie-chart.json | 6 +- .../responsive-chart-container-pro.json | 4 +- .../responsive-chart-container.json | 4 +- .../scatter-chart-pro/scatter-chart-pro.json | 6 +- .../charts/scatter-chart/scatter-chart.json | 6 +- .../spark-line-chart/spark-line-chart.json | 4 +- .../data-grid-premium/data-grid-premium.json | 92 +++++++++---------- .../data-grid-pro/data-grid-pro.json | 90 +++++++++--------- .../data-grid/data-grid/data-grid.json | 82 ++++++++--------- .../grid-filter-form/grid-filter-form.json | 12 +-- 18 files changed, 197 insertions(+), 178 deletions(-) diff --git a/docs/data/charts/getting-started/getting-started.md b/docs/data/charts/getting-started/getting-started.md index fbd74b8ecb3d7..7d8873896cd2d 100644 --- a/docs/data/charts/getting-started/getting-started.md +++ b/docs/data/charts/getting-started/getting-started.md @@ -118,3 +118,34 @@ Visit the [Axis page](/x/react-charts/axis/) for more details. MUI X Charts follows the Material UI styling and features all of the customization tools you'd find there, making tweaking charts as straightforward as designing buttons. Visit the [Styling page](/x/react-charts/styling/) for more details. + +## TypeScript + +In order to benefit from the [CSS overrides](/material-ui/customization/theme-components/#theme-style-overrides) and [default prop customization](/material-ui/customization/theme-components/#theme-default-props) with the theme, TypeScript users need to import the following types. +Internally, it uses module augmentation to extend the default theme structure. + +```tsx +// When using TypeScript 4.x and above +import type {} from '@mui/x-charts/themeAugmentation'; +import type {} from '@mui/x-charts-pro/themeAugmentation'; +// When using TypeScript 3.x and below +import '@mui/x-charts/themeAugmentation'; +import '@mui/x-charts-pro/themeAugmentation'; + +const theme = createTheme({ + components: { + MuiChartsAxis: { + styleOverrides: { + tick: { + stroke: '#006BD6', + }, + }, + }, + }, +}); +``` + +:::info +You don't have to import the theme augmentation from both `@mui/x-charts` and `@mui/x-charts-pro` when using `@mui/x-charts-pro`. +Importing it from `@mui/x-charts-pro` is enough. +::: diff --git a/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json b/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json index 48e64539542e8..092552c73a44d 100644 --- a/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json +++ b/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json @@ -56,7 +56,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of BarSeriesType objects." + "description": "The series to display in the bar chart. An array of [[BarSeriesType]] objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -72,10 +72,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/charts/bar-chart/bar-chart.json b/docs/translations/api-docs/charts/bar-chart/bar-chart.json index b20ef3bdfad0c..76d48449d3383 100644 --- a/docs/translations/api-docs/charts/bar-chart/bar-chart.json +++ b/docs/translations/api-docs/charts/bar-chart/bar-chart.json @@ -56,7 +56,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of BarSeriesType objects." + "description": "The series to display in the bar chart. An array of [[BarSeriesType]] objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -72,10 +72,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json b/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json index 20c5b4a301057..052911bc3b090 100644 --- a/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json +++ b/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json @@ -31,10 +31,10 @@ }, "width": { "description": "The width of the chart in px." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/chart-container/chart-container.json b/docs/translations/api-docs/charts/chart-container/chart-container.json index 5a13d2067ae7c..19dceccad2607 100644 --- a/docs/translations/api-docs/charts/chart-container/chart-container.json +++ b/docs/translations/api-docs/charts/chart-container/chart-container.json @@ -27,10 +27,10 @@ }, "width": { "description": "The width of the chart in px." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/heatmap/heatmap.json b/docs/translations/api-docs/charts/heatmap/heatmap.json index 8db3fec541fc5..8316e6449d231 100644 --- a/docs/translations/api-docs/charts/heatmap/heatmap.json +++ b/docs/translations/api-docs/charts/heatmap/heatmap.json @@ -39,7 +39,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of HeatmapSeriesType objects." + "description": "The series to display in the bar chart. An array of [[HeatmapSeriesType]] objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -54,10 +54,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json b/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json index a262e0ac15bf2..dd7cb67083165 100644 --- a/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json +++ b/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json @@ -50,7 +50,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the line chart. An array of LineSeriesType objects." + "description": "The series to display in the line chart. An array of [[LineSeriesType]] objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -66,10 +66,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/charts/line-chart/line-chart.json b/docs/translations/api-docs/charts/line-chart/line-chart.json index 5b85ec4bd7cb9..edfc613c77d23 100644 --- a/docs/translations/api-docs/charts/line-chart/line-chart.json +++ b/docs/translations/api-docs/charts/line-chart/line-chart.json @@ -50,7 +50,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the line chart. An array of LineSeriesType objects." + "description": "The series to display in the line chart. An array of [[LineSeriesType]] objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -66,10 +66,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/pie-chart/pie-chart.json b/docs/translations/api-docs/charts/pie-chart/pie-chart.json index 7f1be4fa44ccf..f7108630908fc 100644 --- a/docs/translations/api-docs/charts/pie-chart/pie-chart.json +++ b/docs/translations/api-docs/charts/pie-chart/pie-chart.json @@ -38,7 +38,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the pie chart. An array of PieSeriesType objects." + "description": "The series to display in the pie chart. An array of [[PieSeriesType]] objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -54,10 +54,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json b/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json index 469366dd9aad7..a154d3ae1175b 100644 --- a/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json +++ b/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json @@ -35,10 +35,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json b/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json index 1623c12c44cda..43252b72df1f7 100644 --- a/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json +++ b/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json @@ -31,10 +31,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json b/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json index 6a6c1e0b1bf6a..b3130514fac27 100644 --- a/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json +++ b/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json @@ -51,7 +51,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the scatter chart. An array of ScatterSeriesType objects." + "description": "The series to display in the scatter chart. An array of [[ScatterSeriesType]] objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -69,10 +69,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json b/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json index 5e9b1baac91e9..fc85fa638b111 100644 --- a/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json +++ b/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json @@ -47,7 +47,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the scatter chart. An array of ScatterSeriesType objects." + "description": "The series to display in the scatter chart. An array of [[ScatterSeriesType]] objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -65,10 +65,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json b/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json index c4595d0c6f196..b10e13270214a 100644 --- a/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json +++ b/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json @@ -42,10 +42,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The xAxis configuration. Notice it is a single AxisConfig object, not an array of configuration." + "description": "The xAxis configuration. Notice it is a single [[AxisConfig]] object, not an array of configuration." }, "yAxis": { - "description": "The yAxis configuration. Notice it is a single AxisConfig object, not an array of configuration." + "description": "The yAxis configuration. Notice it is a single [[AxisConfig]] object, not an array of configuration." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json b/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json index 68ba1ef303b5f..ccfea66cd309c 100644 --- a/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json +++ b/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json @@ -42,11 +42,9 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { - "description": "Set of columns of type GridColDef[]." - }, + "columns": { "description": "Set of columns of type [[GridColDef]][]." }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." }, "defaultGroupingExpansionDepth": { "description": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded." @@ -127,50 +125,50 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "React.JSX.Element": "The row detail element." } }, "getDetailPanelHeight": { "description": "Function that returns the height of the row detail panel.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "number | string": "The height in pixels or "auto" to use the content height." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from GridRowClassNameParams.", + "params": "With all properties from [[GridRowClassNameParams]].", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given GridRowModel." }, + "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from GridRowSpacingParams.", + "params": "With all properties from [[GridRowSpacingParams]].", "GridRowSpacing": "The row spacing values." } }, @@ -208,7 +206,7 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "boolean": "A boolean indicating if the cell is editable." } }, @@ -222,7 +220,7 @@ "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "boolean": "A boolean indicating if the row is selectable." } }, @@ -237,7 +235,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the Logger interface." + "description": "Pass a custom logger in the components that implements the [[Logger]] interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -257,7 +255,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -265,7 +263,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -273,21 +271,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -302,7 +300,7 @@ "onCellSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple cells changes.", "typeDescriptions": { - "cellSelectionModel": "Object in the shape of GridCellSelectionModel containing the selected cells.", + "cellSelectionModel": "Object in the shape of [[GridCellSelectionModel]] containing the selected cells.", "details": "Additional details for this callback." } }, @@ -319,7 +317,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -327,7 +325,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -335,7 +333,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -343,7 +341,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -351,7 +349,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -359,7 +357,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -367,7 +365,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from GridColumnOrderChangeParams.", + "params": "With all properties from [[GridColumnOrderChangeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -375,7 +373,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -390,7 +388,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -413,7 +411,7 @@ "onFetchRows": { "description": "Callback fired when rowCount is set and the next batch of virtualized rows is rendered.", "typeDescriptions": { - "params": "With all properties from GridFetchRowsParams.", + "params": "With all properties from [[GridFetchRowsParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -421,14 +419,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from GridFilterModel.", + "model": "With all properties from [[GridFilterModel]].", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -436,7 +434,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -462,7 +460,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -470,7 +468,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -482,7 +480,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from ElementSize.", + "containerSize": "With all properties from [[ElementSize]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -490,7 +488,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -502,7 +500,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from RowParams.", + "params": "With all properties from [[RowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -510,14 +508,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, @@ -538,7 +536,7 @@ "onRowOrderChange": { "description": "Callback fired when a row is being reordered.", "typeDescriptions": { - "params": "With all properties from GridRowOrderChangeParams.", + "params": "With all properties from [[GridRowOrderChangeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -546,14 +544,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids GridSelectionModel.", + "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", "details": "Additional details for this callback." } }, "onRowsScrollEnd": { "description": "Callback fired when scrolling to the bottom of the grid viewport.", "typeDescriptions": { - "params": "With all properties from GridRowScrollEndParams.", + "params": "With all properties from [[GridRowScrollEndParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -561,7 +559,7 @@ "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from GridSortModel.", + "model": "With all properties from [[GridSortModel]].", "details": "Additional details for this callback." } }, @@ -574,7 +572,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." + "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." }, "pinnedColumns": { "description": "The column fields to display pinned to left or right." }, "pinnedRows": { "description": "Rows data to pin on top or bottom." }, @@ -601,7 +599,7 @@ "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, "rowReordering": { "description": "If true, the reordering of rows is enabled." }, - "rows": { "description": "Set of rows of type GridRowsProp." }, + "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowsLoadingMode": { diff --git a/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json b/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json index b52063f75d28a..243e39f0e5ffe 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json +++ b/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json @@ -35,11 +35,9 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { - "description": "Set of columns of type GridColDef[]." - }, + "columns": { "description": "Set of columns of type [[GridColDef]][]." }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." }, "defaultGroupingExpansionDepth": { "description": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded." @@ -108,50 +106,50 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "React.JSX.Element": "The row detail element." } }, "getDetailPanelHeight": { "description": "Function that returns the height of the row detail panel.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "number | string": "The height in pixels or "auto" to use the content height." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from GridRowClassNameParams.", + "params": "With all properties from [[GridRowClassNameParams]].", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given GridRowModel." }, + "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from GridRowSpacingParams.", + "params": "With all properties from [[GridRowSpacingParams]].", "GridRowSpacing": "The row spacing values." } }, @@ -189,7 +187,7 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "boolean": "A boolean indicating if the cell is editable." } }, @@ -203,7 +201,7 @@ "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "boolean": "A boolean indicating if the row is selectable." } }, @@ -218,7 +216,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the Logger interface." + "description": "Pass a custom logger in the components that implements the [[Logger]] interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -227,7 +225,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -235,7 +233,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -243,21 +241,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -276,7 +274,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -284,7 +282,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -292,7 +290,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -300,7 +298,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -308,7 +306,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -316,7 +314,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -324,7 +322,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from GridColumnOrderChangeParams.", + "params": "With all properties from [[GridColumnOrderChangeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -332,7 +330,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -347,7 +345,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -366,7 +364,7 @@ "onFetchRows": { "description": "Callback fired when rowCount is set and the next batch of virtualized rows is rendered.", "typeDescriptions": { - "params": "With all properties from GridFetchRowsParams.", + "params": "With all properties from [[GridFetchRowsParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -374,14 +372,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from GridFilterModel.", + "model": "With all properties from [[GridFilterModel]].", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -389,7 +387,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -415,7 +413,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -423,7 +421,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -435,7 +433,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from ElementSize.", + "containerSize": "With all properties from [[ElementSize]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -443,7 +441,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -455,7 +453,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from RowParams.", + "params": "With all properties from [[RowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -463,14 +461,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, @@ -484,7 +482,7 @@ "onRowOrderChange": { "description": "Callback fired when a row is being reordered.", "typeDescriptions": { - "params": "With all properties from GridRowOrderChangeParams.", + "params": "With all properties from [[GridRowOrderChangeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -492,14 +490,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids GridSelectionModel.", + "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", "details": "Additional details for this callback." } }, "onRowsScrollEnd": { "description": "Callback fired when scrolling to the bottom of the grid viewport.", "typeDescriptions": { - "params": "With all properties from GridRowScrollEndParams.", + "params": "With all properties from [[GridRowScrollEndParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -507,7 +505,7 @@ "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from GridSortModel.", + "model": "With all properties from [[GridSortModel]].", "details": "Additional details for this callback." } }, @@ -520,7 +518,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." + "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." }, "pinnedColumns": { "description": "The column fields to display pinned to left or right." }, "pinnedRows": { "description": "Rows data to pin on top or bottom." }, @@ -543,7 +541,7 @@ "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, "rowReordering": { "description": "If true, the reordering of rows is enabled." }, - "rows": { "description": "Set of rows of type GridRowsProp." }, + "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowsLoadingMode": { diff --git a/docs/translations/api-docs/data-grid/data-grid/data-grid.json b/docs/translations/api-docs/data-grid/data-grid/data-grid.json index 545e3c09ac3a1..eac62afb36393 100644 --- a/docs/translations/api-docs/data-grid/data-grid/data-grid.json +++ b/docs/translations/api-docs/data-grid/data-grid/data-grid.json @@ -32,11 +32,9 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { - "description": "Set of columns of type GridColDef[]." - }, + "columns": { "description": "Set of columns of type [[GridColDef]][]." }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." }, "density": { "description": "Set the density of the Data Grid." }, "disableAutosize": { @@ -83,43 +81,43 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "React.JSX.Element": "The row detail element." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from GridRowClassNameParams.", + "params": "With all properties from [[GridRowClassNameParams]].", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from GridRowHeightParams.", + "params": "With all properties from [[GridRowHeightParams]].", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given GridRowModel." }, + "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from GridRowSpacingParams.", + "params": "With all properties from [[GridRowSpacingParams]].", "GridRowSpacing": "The row spacing values." } }, @@ -142,14 +140,14 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "boolean": "A boolean indicating if the cell is editable." } }, "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "boolean": "A boolean indicating if the row is selectable." } }, @@ -161,7 +159,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the Logger interface." + "description": "Pass a custom logger in the components that implements the [[Logger]] interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -170,7 +168,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -178,7 +176,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -186,21 +184,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from GridCellParams.", + "params": "With all properties from [[GridCellParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -219,7 +217,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -227,7 +225,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -235,7 +233,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -243,7 +241,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -251,7 +249,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -259,7 +257,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from GridColumnHeaderParams.", + "params": "With all properties from [[GridColumnHeaderParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -267,7 +265,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from GridColumnOrderChangeParams.", + "params": "With all properties from [[GridColumnOrderChangeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -275,7 +273,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -290,7 +288,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from GridColumnResizeParams.", + "params": "With all properties from [[GridColumnResizeParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -302,14 +300,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from GridFilterModel.", + "model": "With all properties from [[GridFilterModel]].", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -317,7 +315,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from GridMenuParams.", + "params": "With all properties from [[GridMenuParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -336,7 +334,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -344,7 +342,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from GridPreferencePanelParams.", + "params": "With all properties from [[GridPreferencePanelParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -356,7 +354,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from ElementSize.", + "containerSize": "With all properties from [[ElementSize]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -364,7 +362,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -376,7 +374,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from RowParams.", + "params": "With all properties from [[RowParams]].", "event": "The event object.", "details": "Additional details for this callback." } @@ -384,14 +382,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from GridRowParams.", + "params": "With all properties from [[GridRowParams]].", "event": "The event that caused this prop to be called." } }, @@ -405,14 +403,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids GridSelectionModel.", + "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", "details": "Additional details for this callback." } }, "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from GridSortModel.", + "model": "With all properties from [[GridSortModel]].", "details": "Additional details for this callback." } }, @@ -424,7 +422,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." + "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." }, "processRowUpdate": { "description": "Callback called before updating a row with new values in the row and cell editing.", @@ -444,7 +442,7 @@ "rowPositionsDebounceMs": { "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, - "rows": { "description": "Set of rows of type GridRowsProp." }, + "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowSpacingType": { diff --git a/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json b/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json index f61c3e27024e6..3fc1499e92932 100644 --- a/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json +++ b/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json @@ -3,9 +3,7 @@ "propDescriptions": { "applyFilterChanges": { "description": "Callback called when the operator, column field or value is changed.", - "typeDescriptions": { - "item": "The updated GridFilterItem." - } + "typeDescriptions": { "item": "The updated [[GridFilterItem]]." } }, "applyMultiFilterOperatorChanges": { "description": "Callback called when the logic operator is changed.", @@ -17,9 +15,7 @@ }, "deleteFilter": { "description": "Callback called when the delete button is clicked.", - "typeDescriptions": { - "item": "The deleted GridFilterItem." - } + "typeDescriptions": { "item": "The deleted [[GridFilterItem]]." } }, "deleteIconProps": { "description": "Props passed to the delete icon." }, "disableMultiFilterOperator": { @@ -35,9 +31,7 @@ "hasMultipleFilters": { "description": "If true, the logic operator field is rendered. The field will be invisible if showMultiFilterOperators is also true." }, - "item": { - "description": "The GridFilterItem representing this form." - }, + "item": { "description": "The [[GridFilterItem]] representing this form." }, "logicOperatorInputProps": { "description": "Props passed to the logic operator input component." }, From 750f4401a0655dd65d83210482e782641a95c94c Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Fri, 23 Aug 2024 21:57:19 +0200 Subject: [PATCH 03/13] pnpm docs:api --- .../charts/bar-chart-pro/bar-chart-pro.json | 6 +- .../api-docs/charts/bar-chart/bar-chart.json | 6 +- .../chart-container-pro.json | 4 +- .../chart-container/chart-container.json | 4 +- .../api-docs/charts/heatmap/heatmap.json | 6 +- .../charts/line-chart-pro/line-chart-pro.json | 6 +- .../charts/line-chart/line-chart.json | 6 +- .../api-docs/charts/pie-chart/pie-chart.json | 6 +- .../responsive-chart-container-pro.json | 4 +- .../responsive-chart-container.json | 4 +- .../scatter-chart-pro/scatter-chart-pro.json | 6 +- .../charts/scatter-chart/scatter-chart.json | 6 +- .../spark-line-chart/spark-line-chart.json | 4 +- .../data-grid-premium/data-grid-premium.json | 92 ++++++++++--------- .../data-grid-pro/data-grid-pro.json | 90 +++++++++--------- .../data-grid/data-grid/data-grid.json | 82 +++++++++-------- .../grid-filter-form/grid-filter-form.json | 12 ++- 17 files changed, 178 insertions(+), 166 deletions(-) diff --git a/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json b/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json index 092552c73a44d..48e64539542e8 100644 --- a/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json +++ b/docs/translations/api-docs/charts/bar-chart-pro/bar-chart-pro.json @@ -56,7 +56,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of [[BarSeriesType]] objects." + "description": "The series to display in the bar chart. An array of BarSeriesType objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -72,10 +72,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/charts/bar-chart/bar-chart.json b/docs/translations/api-docs/charts/bar-chart/bar-chart.json index 76d48449d3383..b20ef3bdfad0c 100644 --- a/docs/translations/api-docs/charts/bar-chart/bar-chart.json +++ b/docs/translations/api-docs/charts/bar-chart/bar-chart.json @@ -56,7 +56,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of [[BarSeriesType]] objects." + "description": "The series to display in the bar chart. An array of BarSeriesType objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -72,10 +72,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json b/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json index 052911bc3b090..20c5b4a301057 100644 --- a/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json +++ b/docs/translations/api-docs/charts/chart-container-pro/chart-container-pro.json @@ -31,10 +31,10 @@ }, "width": { "description": "The width of the chart in px." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/chart-container/chart-container.json b/docs/translations/api-docs/charts/chart-container/chart-container.json index 19dceccad2607..5a13d2067ae7c 100644 --- a/docs/translations/api-docs/charts/chart-container/chart-container.json +++ b/docs/translations/api-docs/charts/chart-container/chart-container.json @@ -27,10 +27,10 @@ }, "width": { "description": "The width of the chart in px." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/heatmap/heatmap.json b/docs/translations/api-docs/charts/heatmap/heatmap.json index 8316e6449d231..8db3fec541fc5 100644 --- a/docs/translations/api-docs/charts/heatmap/heatmap.json +++ b/docs/translations/api-docs/charts/heatmap/heatmap.json @@ -39,7 +39,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the bar chart. An array of [[HeatmapSeriesType]] objects." + "description": "The series to display in the bar chart. An array of HeatmapSeriesType objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -54,10 +54,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json b/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json index dd7cb67083165..a262e0ac15bf2 100644 --- a/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json +++ b/docs/translations/api-docs/charts/line-chart-pro/line-chart-pro.json @@ -50,7 +50,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the line chart. An array of [[LineSeriesType]] objects." + "description": "The series to display in the line chart. An array of LineSeriesType objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -66,10 +66,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/charts/line-chart/line-chart.json b/docs/translations/api-docs/charts/line-chart/line-chart.json index edfc613c77d23..5b85ec4bd7cb9 100644 --- a/docs/translations/api-docs/charts/line-chart/line-chart.json +++ b/docs/translations/api-docs/charts/line-chart/line-chart.json @@ -50,7 +50,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the line chart. An array of [[LineSeriesType]] objects." + "description": "The series to display in the line chart. An array of LineSeriesType objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -66,10 +66,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/pie-chart/pie-chart.json b/docs/translations/api-docs/charts/pie-chart/pie-chart.json index f7108630908fc..7f1be4fa44ccf 100644 --- a/docs/translations/api-docs/charts/pie-chart/pie-chart.json +++ b/docs/translations/api-docs/charts/pie-chart/pie-chart.json @@ -38,7 +38,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the pie chart. An array of [[PieSeriesType]] objects." + "description": "The series to display in the pie chart. An array of PieSeriesType objects." }, "skipAnimation": { "description": "If true, animations are skipped." }, "slotProps": { "description": "The props used for each component slot." }, @@ -54,10 +54,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json b/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json index a154d3ae1175b..469366dd9aad7 100644 --- a/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json +++ b/docs/translations/api-docs/charts/responsive-chart-container-pro/responsive-chart-container-pro.json @@ -35,10 +35,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json b/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json index 43252b72df1f7..1623c12c44cda 100644 --- a/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json +++ b/docs/translations/api-docs/charts/responsive-chart-container/responsive-chart-container.json @@ -31,10 +31,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json b/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json index b3130514fac27..6a6c1e0b1bf6a 100644 --- a/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json +++ b/docs/translations/api-docs/charts/scatter-chart-pro/scatter-chart-pro.json @@ -51,7 +51,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the scatter chart. An array of [[ScatterSeriesType]] objects." + "description": "The series to display in the scatter chart. An array of ScatterSeriesType objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -69,10 +69,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." }, "zoom": { "description": "The list of zoom data related to each axis." } diff --git a/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json b/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json index fc85fa638b111..5e9b1baac91e9 100644 --- a/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json +++ b/docs/translations/api-docs/charts/scatter-chart/scatter-chart.json @@ -47,7 +47,7 @@ "description": "Indicate which axis to display the right of the charts. Can be a string (the id of the axis) or an object ChartsYAxisProps." }, "series": { - "description": "The series to display in the scatter chart. An array of [[ScatterSeriesType]] objects." + "description": "The series to display in the scatter chart. An array of ScatterSeriesType objects." }, "slotProps": { "description": "The props used for each component slot." }, "slots": { "description": "Overridable component slots." }, @@ -65,10 +65,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the x-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "yAxis": { - "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of [[AxisConfig]] objects." + "description": "The configuration of the y-axes. If not provided, a default axis config is used. An array of AxisConfig objects." }, "zAxis": { "description": "The configuration of the z-axes." } }, diff --git a/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json b/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json index b10e13270214a..c4595d0c6f196 100644 --- a/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json +++ b/docs/translations/api-docs/charts/spark-line-chart/spark-line-chart.json @@ -42,10 +42,10 @@ "description": "The width of the chart in px. If not defined, it takes the width of the parent element." }, "xAxis": { - "description": "The xAxis configuration. Notice it is a single [[AxisConfig]] object, not an array of configuration." + "description": "The xAxis configuration. Notice it is a single AxisConfig object, not an array of configuration." }, "yAxis": { - "description": "The yAxis configuration. Notice it is a single [[AxisConfig]] object, not an array of configuration." + "description": "The yAxis configuration. Notice it is a single AxisConfig object, not an array of configuration." } }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json b/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json index ccfea66cd309c..68ba1ef303b5f 100644 --- a/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json +++ b/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json @@ -42,9 +42,11 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { "description": "Set of columns of type [[GridColDef]][]." }, + "columns": { + "description": "Set of columns of type GridColDef[]." + }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." }, "defaultGroupingExpansionDepth": { "description": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded." @@ -125,50 +127,50 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "React.JSX.Element": "The row detail element." } }, "getDetailPanelHeight": { "description": "Function that returns the height of the row detail panel.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "number | string": "The height in pixels or "auto" to use the content height." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowClassNameParams]].", + "params": "With all properties from GridRowClassNameParams.", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, + "getRowId": { "description": "Return the id of a given GridRowModel." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowSpacingParams]].", + "params": "With all properties from GridRowSpacingParams.", "GridRowSpacing": "The row spacing values." } }, @@ -206,7 +208,7 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "boolean": "A boolean indicating if the cell is editable." } }, @@ -220,7 +222,7 @@ "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "boolean": "A boolean indicating if the row is selectable." } }, @@ -235,7 +237,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the [[Logger]] interface." + "description": "Pass a custom logger in the components that implements the Logger interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -255,7 +257,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -263,7 +265,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -271,21 +273,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -300,7 +302,7 @@ "onCellSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple cells changes.", "typeDescriptions": { - "cellSelectionModel": "Object in the shape of [[GridCellSelectionModel]] containing the selected cells.", + "cellSelectionModel": "Object in the shape of GridCellSelectionModel containing the selected cells.", "details": "Additional details for this callback." } }, @@ -317,7 +319,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -325,7 +327,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -333,7 +335,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -341,7 +343,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -349,7 +351,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -357,7 +359,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -365,7 +367,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from [[GridColumnOrderChangeParams]].", + "params": "With all properties from GridColumnOrderChangeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -373,7 +375,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -388,7 +390,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -411,7 +413,7 @@ "onFetchRows": { "description": "Callback fired when rowCount is set and the next batch of virtualized rows is rendered.", "typeDescriptions": { - "params": "With all properties from [[GridFetchRowsParams]].", + "params": "With all properties from GridFetchRowsParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -419,14 +421,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from [[GridFilterModel]].", + "model": "With all properties from GridFilterModel.", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -434,7 +436,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -460,7 +462,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -468,7 +470,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -480,7 +482,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from [[ElementSize]].", + "containerSize": "With all properties from ElementSize.", "event": "The event object.", "details": "Additional details for this callback." } @@ -488,7 +490,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -500,7 +502,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from [[RowParams]].", + "params": "With all properties from RowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -508,14 +510,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, @@ -536,7 +538,7 @@ "onRowOrderChange": { "description": "Callback fired when a row is being reordered.", "typeDescriptions": { - "params": "With all properties from [[GridRowOrderChangeParams]].", + "params": "With all properties from GridRowOrderChangeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -544,14 +546,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", + "rowSelectionModel": "With all the row ids GridSelectionModel.", "details": "Additional details for this callback." } }, "onRowsScrollEnd": { "description": "Callback fired when scrolling to the bottom of the grid viewport.", "typeDescriptions": { - "params": "With all properties from [[GridRowScrollEndParams]].", + "params": "With all properties from GridRowScrollEndParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -559,7 +561,7 @@ "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from [[GridSortModel]].", + "model": "With all properties from GridSortModel.", "details": "Additional details for this callback." } }, @@ -572,7 +574,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." + "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." }, "pinnedColumns": { "description": "The column fields to display pinned to left or right." }, "pinnedRows": { "description": "Rows data to pin on top or bottom." }, @@ -599,7 +601,7 @@ "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, "rowReordering": { "description": "If true, the reordering of rows is enabled." }, - "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, + "rows": { "description": "Set of rows of type GridRowsProp." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowsLoadingMode": { diff --git a/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json b/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json index 243e39f0e5ffe..b52063f75d28a 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json +++ b/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json @@ -35,9 +35,11 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { "description": "Set of columns of type [[GridColDef]][]." }, + "columns": { + "description": "Set of columns of type GridColDef[]." + }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." }, "defaultGroupingExpansionDepth": { "description": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded." @@ -106,50 +108,50 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "React.JSX.Element": "The row detail element." } }, "getDetailPanelHeight": { "description": "Function that returns the height of the row detail panel.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "number | string": "The height in pixels or "auto" to use the content height." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowClassNameParams]].", + "params": "With all properties from GridRowClassNameParams.", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, + "getRowId": { "description": "Return the id of a given GridRowModel." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowSpacingParams]].", + "params": "With all properties from GridRowSpacingParams.", "GridRowSpacing": "The row spacing values." } }, @@ -187,7 +189,7 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "boolean": "A boolean indicating if the cell is editable." } }, @@ -201,7 +203,7 @@ "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "boolean": "A boolean indicating if the row is selectable." } }, @@ -216,7 +218,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the [[Logger]] interface." + "description": "Pass a custom logger in the components that implements the Logger interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -225,7 +227,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -233,7 +235,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -241,21 +243,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -274,7 +276,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -282,7 +284,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -290,7 +292,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -298,7 +300,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -306,7 +308,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -314,7 +316,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -322,7 +324,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from [[GridColumnOrderChangeParams]].", + "params": "With all properties from GridColumnOrderChangeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -330,7 +332,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -345,7 +347,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -364,7 +366,7 @@ "onFetchRows": { "description": "Callback fired when rowCount is set and the next batch of virtualized rows is rendered.", "typeDescriptions": { - "params": "With all properties from [[GridFetchRowsParams]].", + "params": "With all properties from GridFetchRowsParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -372,14 +374,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from [[GridFilterModel]].", + "model": "With all properties from GridFilterModel.", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -387,7 +389,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -413,7 +415,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -421,7 +423,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -433,7 +435,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from [[ElementSize]].", + "containerSize": "With all properties from ElementSize.", "event": "The event object.", "details": "Additional details for this callback." } @@ -441,7 +443,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -453,7 +455,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from [[RowParams]].", + "params": "With all properties from RowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -461,14 +463,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, @@ -482,7 +484,7 @@ "onRowOrderChange": { "description": "Callback fired when a row is being reordered.", "typeDescriptions": { - "params": "With all properties from [[GridRowOrderChangeParams]].", + "params": "With all properties from GridRowOrderChangeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -490,14 +492,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", + "rowSelectionModel": "With all the row ids GridSelectionModel.", "details": "Additional details for this callback." } }, "onRowsScrollEnd": { "description": "Callback fired when scrolling to the bottom of the grid viewport.", "typeDescriptions": { - "params": "With all properties from [[GridRowScrollEndParams]].", + "params": "With all properties from GridRowScrollEndParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -505,7 +507,7 @@ "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from [[GridSortModel]].", + "model": "With all properties from GridSortModel.", "details": "Additional details for this callback." } }, @@ -518,7 +520,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." + "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." }, "pinnedColumns": { "description": "The column fields to display pinned to left or right." }, "pinnedRows": { "description": "Rows data to pin on top or bottom." }, @@ -541,7 +543,7 @@ "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, "rowReordering": { "description": "If true, the reordering of rows is enabled." }, - "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, + "rows": { "description": "Set of rows of type GridRowsProp." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowsLoadingMode": { diff --git a/docs/translations/api-docs/data-grid/data-grid/data-grid.json b/docs/translations/api-docs/data-grid/data-grid/data-grid.json index eac62afb36393..545e3c09ac3a1 100644 --- a/docs/translations/api-docs/data-grid/data-grid/data-grid.json +++ b/docs/translations/api-docs/data-grid/data-grid/data-grid.json @@ -32,9 +32,11 @@ "columnHeaderHeight": { "description": "Sets the height in pixel of the column headers in the Data Grid." }, - "columns": { "description": "Set of columns of type [[GridColDef]][]." }, + "columns": { + "description": "Set of columns of type GridColDef[]." + }, "columnVisibilityModel": { - "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in [[GridColDef]]." + "description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the hide property in GridColDef." }, "density": { "description": "Set the density of the Data Grid." }, "disableAutosize": { @@ -81,43 +83,43 @@ "getCellClassName": { "description": "Function that applies CSS classes dynamically on cells.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "string": "The CSS class to apply to the cell." } }, "getDetailPanelContent": { "description": "Function that returns the element to render in row detail.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "React.JSX.Element": "The row detail element." } }, "getEstimatedRowHeight": { "description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "number | null": "The estimated row height value. If null or undefined then the default row height, based on the density, is applied." } }, "getRowClassName": { "description": "Function that applies CSS classes dynamically on rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowClassNameParams]].", + "params": "With all properties from GridRowClassNameParams.", "string": "The CSS class to apply to the row." } }, "getRowHeight": { "description": "Function that sets the row height per row.", "typeDescriptions": { - "params": "With all properties from [[GridRowHeightParams]].", + "params": "With all properties from GridRowHeightParams.", "GridRowHeightReturnValue": "The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content." } }, - "getRowId": { "description": "Return the id of a given [[GridRowModel]]." }, + "getRowId": { "description": "Return the id of a given GridRowModel." }, "getRowSpacing": { "description": "Function that allows to specify the spacing between rows.", "typeDescriptions": { - "params": "With all properties from [[GridRowSpacingParams]].", + "params": "With all properties from GridRowSpacingParams.", "GridRowSpacing": "The row spacing values." } }, @@ -140,14 +142,14 @@ "isCellEditable": { "description": "Callback fired when a cell is rendered, returns true if the cell is editable.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "boolean": "A boolean indicating if the cell is editable." } }, "isRowSelectable": { "description": "Determines if a row can be selected.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "boolean": "A boolean indicating if the row is selectable." } }, @@ -159,7 +161,7 @@ "description": "Set the locale text of the Data Grid. You can find all the translation keys supported in the source in the GitHub repository." }, "logger": { - "description": "Pass a custom logger in the components that implements the [[Logger]] interface." + "description": "Pass a custom logger in the components that implements the Logger interface." }, "logLevel": { "description": "Allows to pass the logging level or false to turn off logging." }, "nonce": { @@ -168,7 +170,7 @@ "onCellClick": { "description": "Callback fired when any cell is clicked.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -176,7 +178,7 @@ "onCellDoubleClick": { "description": "Callback fired when a double click event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -184,21 +186,21 @@ "onCellEditStart": { "description": "Callback fired when the cell turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellEditStop": { "description": "Callback fired when the cell turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event that caused this prop to be called." } }, "onCellKeyDown": { "description": "Callback fired when a keydown event comes from a cell element.", "typeDescriptions": { - "params": "With all properties from [[GridCellParams]].", + "params": "With all properties from GridCellParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -217,7 +219,7 @@ "onColumnHeaderClick": { "description": "Callback fired when a click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -225,7 +227,7 @@ "onColumnHeaderDoubleClick": { "description": "Callback fired when a double click event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -233,7 +235,7 @@ "onColumnHeaderEnter": { "description": "Callback fired when a mouse enter event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -241,7 +243,7 @@ "onColumnHeaderLeave": { "description": "Callback fired when a mouse leave event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -249,7 +251,7 @@ "onColumnHeaderOut": { "description": "Callback fired when a mouseout event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -257,7 +259,7 @@ "onColumnHeaderOver": { "description": "Callback fired when a mouseover event comes from a column header element.", "typeDescriptions": { - "params": "With all properties from [[GridColumnHeaderParams]].", + "params": "With all properties from GridColumnHeaderParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -265,7 +267,7 @@ "onColumnOrderChange": { "description": "Callback fired when a column is reordered.", "typeDescriptions": { - "params": "With all properties from [[GridColumnOrderChangeParams]].", + "params": "With all properties from GridColumnOrderChangeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -273,7 +275,7 @@ "onColumnResize": { "description": "Callback fired while a column is being resized.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -288,7 +290,7 @@ "onColumnWidthChange": { "description": "Callback fired when the width of a column is changed.", "typeDescriptions": { - "params": "With all properties from [[GridColumnResizeParams]].", + "params": "With all properties from GridColumnResizeParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -300,14 +302,14 @@ "onFilterModelChange": { "description": "Callback fired when the Filter model changes before the filters are applied.", "typeDescriptions": { - "model": "With all properties from [[GridFilterModel]].", + "model": "With all properties from GridFilterModel.", "details": "Additional details for this callback." } }, "onMenuClose": { "description": "Callback fired when the menu is closed.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -315,7 +317,7 @@ "onMenuOpen": { "description": "Callback fired when the menu is opened.", "typeDescriptions": { - "params": "With all properties from [[GridMenuParams]].", + "params": "With all properties from GridMenuParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -334,7 +336,7 @@ "onPreferencePanelClose": { "description": "Callback fired when the preferences panel is closed.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -342,7 +344,7 @@ "onPreferencePanelOpen": { "description": "Callback fired when the preferences panel is opened.", "typeDescriptions": { - "params": "With all properties from [[GridPreferencePanelParams]].", + "params": "With all properties from GridPreferencePanelParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -354,7 +356,7 @@ "onResize": { "description": "Callback fired when the Data Grid is resized.", "typeDescriptions": { - "containerSize": "With all properties from [[ElementSize]].", + "containerSize": "With all properties from ElementSize.", "event": "The event object.", "details": "Additional details for this callback." } @@ -362,7 +364,7 @@ "onRowClick": { "description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -374,7 +376,7 @@ "onRowDoubleClick": { "description": "Callback fired when a double click event comes from a row container element.", "typeDescriptions": { - "params": "With all properties from [[RowParams]].", + "params": "With all properties from RowParams.", "event": "The event object.", "details": "Additional details for this callback." } @@ -382,14 +384,14 @@ "onRowEditStart": { "description": "Callback fired when the row turns to edit mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, "onRowEditStop": { "description": "Callback fired when the row turns to view mode.", "typeDescriptions": { - "params": "With all properties from [[GridRowParams]].", + "params": "With all properties from GridRowParams.", "event": "The event that caused this prop to be called." } }, @@ -403,14 +405,14 @@ "onRowSelectionModelChange": { "description": "Callback fired when the selection state of one or multiple rows changes.", "typeDescriptions": { - "rowSelectionModel": "With all the row ids [[GridSelectionModel]].", + "rowSelectionModel": "With all the row ids GridSelectionModel.", "details": "Additional details for this callback." } }, "onSortModelChange": { "description": "Callback fired when the sort model changes before a column is sorted.", "typeDescriptions": { - "model": "With all properties from [[GridSortModel]].", + "model": "With all properties from GridSortModel.", "details": "Additional details for this callback." } }, @@ -422,7 +424,7 @@ "description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side." }, "paginationModel": { - "description": "The pagination model of type [[GridPaginationModel]] which refers to current page and pageSize." + "description": "The pagination model of type GridPaginationModel which refers to current page and pageSize." }, "processRowUpdate": { "description": "Callback called before updating a row with new values in the row and cell editing.", @@ -442,7 +444,7 @@ "rowPositionsDebounceMs": { "description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows." }, - "rows": { "description": "Set of rows of type [[GridRowsProp]]." }, + "rows": { "description": "Set of rows of type GridRowsProp." }, "rowSelection": { "description": "If false, the row selection mode is disabled." }, "rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." }, "rowSpacingType": { diff --git a/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json b/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json index 3fc1499e92932..f61c3e27024e6 100644 --- a/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json +++ b/docs/translations/api-docs/data-grid/grid-filter-form/grid-filter-form.json @@ -3,7 +3,9 @@ "propDescriptions": { "applyFilterChanges": { "description": "Callback called when the operator, column field or value is changed.", - "typeDescriptions": { "item": "The updated [[GridFilterItem]]." } + "typeDescriptions": { + "item": "The updated GridFilterItem." + } }, "applyMultiFilterOperatorChanges": { "description": "Callback called when the logic operator is changed.", @@ -15,7 +17,9 @@ }, "deleteFilter": { "description": "Callback called when the delete button is clicked.", - "typeDescriptions": { "item": "The deleted [[GridFilterItem]]." } + "typeDescriptions": { + "item": "The deleted GridFilterItem." + } }, "deleteIconProps": { "description": "Props passed to the delete icon." }, "disableMultiFilterOperator": { @@ -31,7 +35,9 @@ "hasMultipleFilters": { "description": "If true, the logic operator field is rendered. The field will be invisible if showMultiFilterOperators is also true." }, - "item": { "description": "The [[GridFilterItem]] representing this form." }, + "item": { + "description": "The GridFilterItem representing this form." + }, "logicOperatorInputProps": { "description": "Props passed to the logic operator input component." }, From 79e44efc5621a3162d7006c72fff0810fc6fdbf5 Mon Sep 17 00:00:00 2001 From: Jose Quintas Date: Fri, 23 Aug 2024 22:20:10 +0200 Subject: [PATCH 04/13] remove prettier ignore --- packages/x-charts-pro/src/themeAugmentation/overrides.d.ts | 1 - packages/x-charts/src/themeAugmentation/overrides.d.ts | 4 +--- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts b/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts index 2cf95e4906cee..b57a5f0362d60 100644 --- a/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts +++ b/packages/x-charts-pro/src/themeAugmentation/overrides.d.ts @@ -1,6 +1,5 @@ import { HeatmapClassKey } from '../Heatmap'; -// prettier-ignore export interface ChartsProComponentNameToClassKey { // Heatmap components MuiHeatmap: HeatmapClassKey; diff --git a/packages/x-charts/src/themeAugmentation/overrides.d.ts b/packages/x-charts/src/themeAugmentation/overrides.d.ts index c2699e9f67d0a..bbf2a68b07cc6 100644 --- a/packages/x-charts/src/themeAugmentation/overrides.d.ts +++ b/packages/x-charts/src/themeAugmentation/overrides.d.ts @@ -7,7 +7,6 @@ import { ChartsLegendClassKey } from '../ChartsLegend'; import { ChartsTooltipClassKey } from '../ChartsTooltip'; import { AreaElementClassKey, LineElementClassKey, MarkElementClassKey } from '../LineChart'; -// prettier-ignore export interface PickersComponentNameToClassKey { MuiChartsAxis: ChartsAxisClassKey; MuiChartsAxisHighlight: ChartsAxisHighlightClassKey; @@ -20,12 +19,11 @@ export interface PickersComponentNameToClassKey { MuiBarLabel: BarLabelClassKey; // LineChart components - MuiAreaElement: AreaElementClassKey; MuiLineElement: LineElementClassKey; MuiMarkElement: MarkElementClassKey; + // ScatterChart components - } declare module '@mui/material/styles' { From 42bcaeeb36da3abd24085a6cc1daf45f51c26589 Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Sat, 24 Aug 2024 23:36:15 +0200 Subject: [PATCH 05/13] remove not supported code --- docs/data/charts/getting-started/getting-started.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/data/charts/getting-started/getting-started.md b/docs/data/charts/getting-started/getting-started.md index 7d8873896cd2d..0ce614bf1f92a 100644 --- a/docs/data/charts/getting-started/getting-started.md +++ b/docs/data/charts/getting-started/getting-started.md @@ -125,12 +125,8 @@ In order to benefit from the [CSS overrides](/material-ui/customization/theme-co Internally, it uses module augmentation to extend the default theme structure. ```tsx -// When using TypeScript 4.x and above import type {} from '@mui/x-charts/themeAugmentation'; import type {} from '@mui/x-charts-pro/themeAugmentation'; -// When using TypeScript 3.x and below -import '@mui/x-charts/themeAugmentation'; -import '@mui/x-charts-pro/themeAugmentation'; const theme = createTheme({ components: { From 884e110bfa81aee6ce5a0ee59879fbfd6cee2561 Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Sun, 25 Aug 2024 18:29:13 +0200 Subject: [PATCH 06/13] make components partial --- .../src/themeAugmentation/components.d.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/x-charts-pro/src/themeAugmentation/components.d.ts b/packages/x-charts-pro/src/themeAugmentation/components.d.ts index e622c4273bc12..76d92c2e4acf4 100644 --- a/packages/x-charts-pro/src/themeAugmentation/components.d.ts +++ b/packages/x-charts-pro/src/themeAugmentation/components.d.ts @@ -2,26 +2,26 @@ import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles'; export interface ChartsProComponents { // BarChartPro components - MuiBarChartPro: { + MuiBarChartPro?: { defaultProps?: ComponentsProps['MuiBarChartPro']; }; // LineChartPro components - MuiLineChartPro: { + MuiLineChartPro?: { defaultProps?: ComponentsProps['MuiLineChartPro']; }; // Heatmap components - MuiHeatmap: { + MuiHeatmap?: { defaultProps?: ComponentsProps['MuiHeatmap']; styleOverrides?: ComponentsOverrides['MuiHeatmap']; }; - MuiHeatmapItem: { + MuiHeatmapItem?: { defaultProps?: ComponentsProps['MuiHeatmapItem']; }; - MuiHeatmapPlot: { + MuiHeatmapPlot?: { defaultProps?: ComponentsProps['MuiHeatmapPlot']; }; // ScatterChartPro components - MuiScatterChartPro: { + MuiScatterChartPro?: { defaultProps?: ComponentsProps['MuiScatterChartPro']; }; } From 930253b84b9a177fb381a6f71965ea7e47d8c7a8 Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 26 Aug 2024 16:44:00 +0200 Subject: [PATCH 07/13] Add single components charts --- .../src/BarChartPro/BarChartPro.tsx | 4 +++- packages/x-charts-pro/src/Heatmap/Heatmap.tsx | 6 ++++-- .../src/LineChartPro/LineChartPro.tsx | 4 +++- .../src/ScatterChartPro/ScatterChartPro.tsx | 4 +++- .../src/themeAugmentation/props.d.ts | 8 ++------ packages/x-charts/src/BarChart/BarChart.tsx | 4 +++- packages/x-charts/src/ChartsSurface.tsx | 5 +++-- packages/x-charts/src/LineChart/LineChart.tsx | 4 +++- packages/x-charts/src/PieChart/PieChart.tsx | 4 +++- .../x-charts/src/ScatterChart/ScatterChart.tsx | 4 +++- .../x-charts/src/themeAugmentation/props.d.ts | 17 +++-------------- 11 files changed, 33 insertions(+), 31 deletions(-) diff --git a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx index 9f03659068b1b..853af3e5c9361 100644 --- a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx +++ b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { BarChartProps, BarPlot } from '@mui/x-charts/BarChart'; import { ChartsOnAxisClickHandler } from '@mui/x-charts/ChartsOnAxisClickHandler'; import { ChartsGrid } from '@mui/x-charts/ChartsGrid'; @@ -30,7 +31,8 @@ export interface BarChartProProps extends BarChartProps, ZoomProps {} * - [BarChart API](https://mui.com/x/api/charts/bar-chart/) */ const BarChartPro = React.forwardRef(function BarChartPro(props: BarChartProProps, ref) { - const { zoom, onZoomChange, ...other } = props; + const themeProps = useThemeProps({ props, name: 'MuiBarChartPro' }); + const { zoom, onZoomChange, ...other } = themeProps; const { chartContainerProps, barPlotProps, diff --git a/packages/x-charts-pro/src/Heatmap/Heatmap.tsx b/packages/x-charts-pro/src/Heatmap/Heatmap.tsx index 7b393a9f11a12..8be52ac59617d 100644 --- a/packages/x-charts-pro/src/Heatmap/Heatmap.tsx +++ b/packages/x-charts-pro/src/Heatmap/Heatmap.tsx @@ -1,7 +1,8 @@ import * as React from 'react'; import PropTypes from 'prop-types'; -import { interpolateRgbBasis } from '@mui/x-charts-vendor/d3-interpolate'; +import { useThemeProps } from '@mui/material/styles'; import useId from '@mui/utils/useId'; +import { interpolateRgbBasis } from '@mui/x-charts-vendor/d3-interpolate'; import { ChartsAxis, ChartsAxisProps } from '@mui/x-charts/ChartsAxis'; import { ChartsTooltip, @@ -105,6 +106,7 @@ const defaultColorMap = interpolateRgbBasis([ ]); const Heatmap = React.forwardRef(function Heatmap(props: HeatmapProps, ref) { + const themeProps = useThemeProps({ props, name: 'MuiHeatmap' }); const { xAxis, yAxis, @@ -128,7 +130,7 @@ const Heatmap = React.forwardRef(function Heatmap(props: HeatmapProps, ref) { loading, highlightedItem, onHighlightChange, - } = props; + } = themeProps; const id = useId(); const clipPathId = `${id}-clip-path`; diff --git a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx index 323d37fb05d53..cf9d9916b9046 100644 --- a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx +++ b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { AreaPlot, AreaPlotProps, @@ -37,7 +38,8 @@ export interface LineChartProProps extends LineChartProps, ZoomProps {} * - [LineChart API](https://mui.com/x/api/charts/line-chart/) */ const LineChartPro = React.forwardRef(function LineChartPro(props: LineChartProProps, ref) { - const { zoom, onZoomChange, ...other } = props; + const themeProps = useThemeProps({ props, name: 'MuiLineChartPro' }); + const { zoom, onZoomChange, ...other } = themeProps; const { chartContainerProps, axisClickHandlerProps, diff --git a/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx b/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx index 1ca22d2eb0609..14dc0c02d3ee1 100644 --- a/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx +++ b/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { ChartsOverlay } from '@mui/x-charts/ChartsOverlay'; import { ScatterChartProps, ScatterPlot } from '@mui/x-charts/ScatterChart'; import { ZAxisContextProvider } from '@mui/x-charts/context'; @@ -30,7 +31,8 @@ const ScatterChartPro = React.forwardRef(function ScatterChartPro( props: ScatterChartProProps, ref, ) { - const { zoom, onZoomChange, ...other } = props; + const themeProps = useThemeProps({ props, name: 'MuiScatterChartPro' }); + const { zoom, onZoomChange, ...other } = themeProps; const { chartContainerProps, zAxisProps, diff --git a/packages/x-charts-pro/src/themeAugmentation/props.d.ts b/packages/x-charts-pro/src/themeAugmentation/props.d.ts index d102fd6185159..5012285682988 100644 --- a/packages/x-charts-pro/src/themeAugmentation/props.d.ts +++ b/packages/x-charts-pro/src/themeAugmentation/props.d.ts @@ -1,9 +1,7 @@ -import { ScatterChartProps } from '@mui/x-charts'; +import { ScatterChartProProps } from '../ScatterChartPro'; import { BarChartProProps } from '../BarChartPro'; import { HeatmapProps } from '../Heatmap/Heatmap'; import { LineChartProProps } from '../LineChartPro'; -import { HeatmapItemProps } from '../Heatmap/HeatmapItem'; -import { HeatmapPlotProps } from '../Heatmap/HeatmapPlot'; export interface ChartsProComponentsPropsList { // BarChartPro components @@ -12,10 +10,8 @@ export interface ChartsProComponentsPropsList { MuiLineChartPro: LineChartProProps; // Heatmap components MuiHeatmap: HeatmapProps; - MuiHeatmapItem: HeatmapItemProps; - MuiHeatmapPlot: HeatmapPlotProps; // ScatterChartPro components - MuiScatterChartPro: ScatterChartProps; + MuiScatterChartPro: ScatterChartProProps; } declare module '@mui/material/styles' { diff --git a/packages/x-charts/src/BarChart/BarChart.tsx b/packages/x-charts/src/BarChart/BarChart.tsx index bba9190cabac5..3f2af40bb439f 100644 --- a/packages/x-charts/src/BarChart/BarChart.tsx +++ b/packages/x-charts/src/BarChart/BarChart.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { BarPlot, BarPlotProps, BarPlotSlotProps, BarPlotSlots } from './BarPlot'; import { ResponsiveChartContainer, @@ -110,6 +111,7 @@ export interface BarChartProps * - [BarChart API](https://mui.com/x/api/charts/bar-chart/) */ const BarChart = React.forwardRef(function BarChart(props: BarChartProps, ref) { + const themeProps = useThemeProps({ props, name: 'MuiBarChart' }); const { chartContainerProps, barPlotProps, @@ -123,7 +125,7 @@ const BarChart = React.forwardRef(function BarChart(props: BarChartProps, ref) { legendProps, tooltipProps, children, - } = useBarChartProps(props); + } = useBarChartProps(themeProps); return ( diff --git a/packages/x-charts/src/ChartsSurface.tsx b/packages/x-charts/src/ChartsSurface.tsx index 47147d81f2a0a..4f429523144e4 100644 --- a/packages/x-charts/src/ChartsSurface.tsx +++ b/packages/x-charts/src/ChartsSurface.tsx @@ -1,4 +1,4 @@ -import { styled, SxProps, Theme } from '@mui/material/styles'; +import { styled, SxProps, Theme, useThemeProps } from '@mui/material/styles'; import PropTypes from 'prop-types'; import * as React from 'react'; import { useAxisEvents } from './hooks/useAxisEvents'; @@ -45,6 +45,7 @@ const ChartsSurface = React.forwardRef(functi props: ChartsSurfaceProps, ref, ) { + const themeProps = useThemeProps({ props, name: 'MuiChartsSurface' }); const { children, width, @@ -55,7 +56,7 @@ const ChartsSurface = React.forwardRef(functi title, desc, ...other - } = props; + } = themeProps; const svgView = { width, height, x: 0, y: 0, ...viewBox }; useAxisEvents(disableAxisListener); diff --git a/packages/x-charts/src/LineChart/LineChart.tsx b/packages/x-charts/src/LineChart/LineChart.tsx index a8e65b19c18a9..7634ca1f4d3dc 100644 --- a/packages/x-charts/src/LineChart/LineChart.tsx +++ b/packages/x-charts/src/LineChart/LineChart.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { AreaPlot, AreaPlotProps, AreaPlotSlotProps, AreaPlotSlots } from './AreaPlot'; import { LinePlot, LinePlotProps, LinePlotSlotProps, LinePlotSlots } from './LinePlot'; import { @@ -136,6 +137,7 @@ export interface LineChartProps * - [LineChart API](https://mui.com/x/api/charts/line-chart/) */ const LineChart = React.forwardRef(function LineChart(props: LineChartProps, ref) { + const themeProps = useThemeProps({ props, name: 'MuiLineChart' }); const { chartContainerProps, axisClickHandlerProps, @@ -152,7 +154,7 @@ const LineChart = React.forwardRef(function LineChart(props: LineChartProps, ref legendProps, tooltipProps, children, - } = useLineChartProps(props); + } = useLineChartProps(themeProps); return ( diff --git a/packages/x-charts/src/PieChart/PieChart.tsx b/packages/x-charts/src/PieChart/PieChart.tsx index 769553547ee57..20f45c261c8bb 100644 --- a/packages/x-charts/src/PieChart/PieChart.tsx +++ b/packages/x-charts/src/PieChart/PieChart.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { ResponsiveChartContainer, ResponsiveChartContainerProps, @@ -124,6 +125,7 @@ const defaultRTLMargin = { top: 5, bottom: 5, left: 100, right: 5 }; * - [PieChart API](https://mui.com/x/api/charts/pie-chart/) */ const PieChart = React.forwardRef(function PieChart(props: PieChartProps, ref) { + const themeProps = useThemeProps({ props, name: 'MuiPieChart' }); const { xAxis, yAxis, @@ -150,7 +152,7 @@ const PieChart = React.forwardRef(function PieChart(props: PieChartProps, ref) { onHighlightChange, className, ...other - } = props; + } = themeProps; const isRTL = useIsRTL(); const margin = { ...(isRTL ? defaultRTLMargin : defaultMargin), ...marginProps }; diff --git a/packages/x-charts/src/ScatterChart/ScatterChart.tsx b/packages/x-charts/src/ScatterChart/ScatterChart.tsx index 7689c17a75636..830afde6b464c 100644 --- a/packages/x-charts/src/ScatterChart/ScatterChart.tsx +++ b/packages/x-charts/src/ScatterChart/ScatterChart.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; +import { useThemeProps } from '@mui/material/styles'; import { ScatterPlot, ScatterPlotProps, @@ -119,6 +120,7 @@ export interface ScatterChartProps * - [ScatterChart API](https://mui.com/x/api/charts/scatter-chart/) */ const ScatterChart = React.forwardRef(function ScatterChart(props: ScatterChartProps, ref) { + const themeProps = useThemeProps({ props, name: 'MuiScatterChart' }); const { chartContainerProps, zAxisProps, @@ -131,7 +133,7 @@ const ScatterChart = React.forwardRef(function ScatterChart(props: ScatterChartP axisHighlightProps, tooltipProps, children, - } = useScatterChartProps(props); + } = useScatterChartProps(themeProps); return ( diff --git a/packages/x-charts/src/themeAugmentation/props.d.ts b/packages/x-charts/src/themeAugmentation/props.d.ts index 7dc62f3974005..0fe35a41d87db 100644 --- a/packages/x-charts/src/themeAugmentation/props.d.ts +++ b/packages/x-charts/src/themeAugmentation/props.d.ts @@ -1,26 +1,18 @@ import { BarLabelProps } from '../BarChart/BarLabel'; import { BarChartProps } from '../BarChart/BarChart'; -import { BarElementProps } from '../BarChart/BarElement'; -import { ChartsAxisProps } from '../ChartsAxis'; -import { ChartsAxisHighlightProps } from '../ChartsAxisHighlight'; -import { ChartsClipPathProps } from '../ChartsClipPath'; import { ChartsGridProps } from '../ChartsGrid'; import { ChartsLegendProps } from '../ChartsLegend'; import { ChartsSurfaceProps } from '../ChartsSurface'; import { ChartsTooltipProps } from '../ChartsTooltip'; -import { AreaElementProps, LineElementProps, MarkElementProps } from '../LineChart'; import { LineChartProps } from '../LineChart/LineChart'; -import { ScatterProps } from '../ScatterChart/Scatter'; import { ScatterChartProps } from '../ScatterChart/ScatterChart'; +import { PieChartProps } from '../PieChart/PieChart'; import { ChartsXAxisProps, ChartsYAxisProps } from '../models/axis'; import { ChartSeriesType } from '../models/seriesType/config'; export interface ChartsComponentsPropsList { - MuiChartsAxis: ChartsAxisProps; MuiChartsXAxis: ChartsXAxisProps; MuiChartsYAxis: ChartsYAxisProps; - MuiChartsAxisHighlight: ChartsAxisHighlightProps; - MuiChartsClipPath: ChartsClipPathProps; MuiChartsGrid: ChartsGridProps; MuiChartsLegend: ChartsLegendProps; MuiChartsTooltip: ChartsTooltipProps; @@ -28,16 +20,13 @@ export interface ChartsComponentsPropsList { // BarChart components MuiBarChart: BarChartProps; - MuiBarElement: BarElementProps; MuiBarLabel: BarLabelProps; // LineChart components MuiLineChart: LineChartProps; - MuiAreaElement: AreaElementProps; - MuiLineElement: LineElementProps; - MuiMarkElement: MarkElementProps; // ScatterChart components MuiScatterChart: ScatterChartProps; - MuiScatter: ScatterProps; + // PieChart components + MuiPieChart: PieChartProps; } declare module '@mui/material/styles' { From bdb2aa77765135445b3b6c0e44a337cc958dad2f Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 26 Aug 2024 18:32:47 +0200 Subject: [PATCH 08/13] Test default props conformance --- packages/x-charts/src/BarChart/BarChart.test.tsx | 4 ++-- packages/x-charts/src/LineChart/LineChart.test.tsx | 4 ++-- packages/x-charts/src/PieChart/PieChart.test.tsx | 4 ++-- packages/x-charts/src/ScatterChart/ScatterChart.test.tsx | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/x-charts/src/BarChart/BarChart.test.tsx b/packages/x-charts/src/BarChart/BarChart.test.tsx index 7f9dffa980691..f93e1352ca788 100644 --- a/packages/x-charts/src/BarChart/BarChart.test.tsx +++ b/packages/x-charts/src/BarChart/BarChart.test.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; -import { createRenderer, describeConformance } from '@mui/internal-test-utils'; +import { createRenderer } from '@mui/internal-test-utils/createRenderer'; +import { describeConformance } from 'test/utils/describeConformance'; import { BarChart } from '@mui/x-charts/BarChart'; describe('', () => { @@ -20,7 +21,6 @@ describe('', () => { 'slotPropsProp', 'slotPropsCallback', 'slotsProp', - 'themeDefaultProps', 'themeStyleOverrides', 'themeVariants', 'themeCustomPalette', diff --git a/packages/x-charts/src/LineChart/LineChart.test.tsx b/packages/x-charts/src/LineChart/LineChart.test.tsx index 760dc0317e61e..1ec0c3f8ac2a5 100644 --- a/packages/x-charts/src/LineChart/LineChart.test.tsx +++ b/packages/x-charts/src/LineChart/LineChart.test.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; -import { createRenderer, describeConformance } from '@mui/internal-test-utils'; +import { createRenderer } from '@mui/internal-test-utils/createRenderer'; +import { describeConformance } from 'test/utils/describeConformance'; import { LineChart } from '@mui/x-charts/LineChart'; describe('', () => { @@ -19,7 +20,6 @@ describe('', () => { 'slotPropsProp', 'slotPropsCallback', 'slotsProp', - 'themeDefaultProps', 'themeStyleOverrides', 'themeVariants', 'themeCustomPalette', diff --git a/packages/x-charts/src/PieChart/PieChart.test.tsx b/packages/x-charts/src/PieChart/PieChart.test.tsx index d77fe8f258610..d1d5c3fd55ff9 100644 --- a/packages/x-charts/src/PieChart/PieChart.test.tsx +++ b/packages/x-charts/src/PieChart/PieChart.test.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; -import { createRenderer, describeConformance } from '@mui/internal-test-utils'; +import { createRenderer } from '@mui/internal-test-utils/createRenderer'; +import { describeConformance } from 'test/utils/describeConformance'; import { PieChart } from '@mui/x-charts/PieChart'; describe('', () => { @@ -30,7 +31,6 @@ describe('', () => { 'slotPropsProp', 'slotPropsCallback', 'slotsProp', - 'themeDefaultProps', 'themeStyleOverrides', 'themeVariants', 'themeCustomPalette', diff --git a/packages/x-charts/src/ScatterChart/ScatterChart.test.tsx b/packages/x-charts/src/ScatterChart/ScatterChart.test.tsx index e96d0e0681a1c..6a0810ce8dd3e 100644 --- a/packages/x-charts/src/ScatterChart/ScatterChart.test.tsx +++ b/packages/x-charts/src/ScatterChart/ScatterChart.test.tsx @@ -1,5 +1,6 @@ import * as React from 'react'; -import { createRenderer, describeConformance } from '@mui/internal-test-utils'; +import { createRenderer } from '@mui/internal-test-utils/createRenderer'; +import { describeConformance } from 'test/utils/describeConformance'; import { ScatterChart } from '@mui/x-charts/ScatterChart'; describe('', () => { @@ -31,7 +32,6 @@ describe('', () => { 'slotPropsProp', 'slotPropsCallback', 'slotsProp', - 'themeDefaultProps', 'themeStyleOverrides', 'themeVariants', 'themeCustomPalette', From 80da419ebf179d4a85efd53ce4a448b718dbe3b8 Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 26 Aug 2024 18:33:00 +0200 Subject: [PATCH 09/13] Reduce specificity for axis --- .../src/internals/components/AxisSharedComponents.tsx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/x-charts/src/internals/components/AxisSharedComponents.tsx b/packages/x-charts/src/internals/components/AxisSharedComponents.tsx index ba6078ebe23b6..5fb7076d5455c 100644 --- a/packages/x-charts/src/internals/components/AxisSharedComponents.tsx +++ b/packages/x-charts/src/internals/components/AxisSharedComponents.tsx @@ -6,21 +6,21 @@ export const AxisRoot = styled('g', { slot: 'Root', overridesResolver: (props, styles) => styles.root, })(({ theme }) => ({ - [`& .${axisClasses.tickLabel}`]: { + [`.${axisClasses.tickLabel}`]: { ...theme.typography.caption, fill: (theme.vars || theme).palette.text.primary, }, - [`& .${axisClasses.label}`]: { + [`.${axisClasses.label}`]: { ...theme.typography.body1, fill: (theme.vars || theme).palette.text.primary, }, - [`& .${axisClasses.line}`]: { + [`.${axisClasses.line}`]: { stroke: (theme.vars || theme).palette.text.primary, shapeRendering: 'crispEdges', strokeWidth: 1, }, - [`& .${axisClasses.tick}`]: { + [`.${axisClasses.tick}`]: { stroke: (theme.vars || theme).palette.text.primary, shapeRendering: 'crispEdges', }, From 89a2c34868c5f92c9537f850548ad001ec131bad Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 26 Aug 2024 18:33:31 +0200 Subject: [PATCH 10/13] clean some of the type definition --- .../src/themeAugmentation/components.d.ts | 6 -- .../themeAugmentation.spec.ts | 14 ---- .../src/themeAugmentation/components.d.ts | 14 +--- .../src/themeAugmentation/overrides.d.ts | 9 +-- .../themeAugmentation.spec.ts | 66 ++----------------- 5 files changed, 13 insertions(+), 96 deletions(-) diff --git a/packages/x-charts-pro/src/themeAugmentation/components.d.ts b/packages/x-charts-pro/src/themeAugmentation/components.d.ts index 76d92c2e4acf4..1638a9e2a2844 100644 --- a/packages/x-charts-pro/src/themeAugmentation/components.d.ts +++ b/packages/x-charts-pro/src/themeAugmentation/components.d.ts @@ -14,12 +14,6 @@ export interface ChartsProComponents { defaultProps?: ComponentsProps['MuiHeatmap']; styleOverrides?: ComponentsOverrides['MuiHeatmap']; }; - MuiHeatmapItem?: { - defaultProps?: ComponentsProps['MuiHeatmapItem']; - }; - MuiHeatmapPlot?: { - defaultProps?: ComponentsProps['MuiHeatmapPlot']; - }; // ScatterChartPro components MuiScatterChartPro?: { defaultProps?: ComponentsProps['MuiScatterChartPro']; diff --git a/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts b/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts index caca18818c7c2..074742162da11 100644 --- a/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts +++ b/packages/x-charts-pro/src/themeAugmentation/themeAugmentation.spec.ts @@ -35,19 +35,5 @@ createTheme({ constent: { color: 'red' }, }, }, - MuiHeatmapItem: { - defaultProps: { - seriesId: 'toto', - // @ts-expect-error invalid MuiChartsAxis prop - someRandomProp: true, - }, - }, - MuiHeatmapPlot: { - defaultProps: { - slotProps: { cell: { id: 'toto' } }, - // @ts-expect-error invalid MuiChartsAxis prop - someRandomProp: true, - }, - }, }, }); diff --git a/packages/x-charts/src/themeAugmentation/components.d.ts b/packages/x-charts/src/themeAugmentation/components.d.ts index f08071da49ac3..fbb03f04b14ae 100644 --- a/packages/x-charts/src/themeAugmentation/components.d.ts +++ b/packages/x-charts/src/themeAugmentation/components.d.ts @@ -2,7 +2,6 @@ import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles'; export interface ChartsComponents { MuiChartsAxis?: { - defaultProps?: ComponentsProps['MuiChartsAxis']; styleOverrides?: ComponentsOverrides['MuiChartsAxis']; }; MuiChartsXAxis?: { @@ -12,12 +11,8 @@ export interface ChartsComponents { defaultProps?: ComponentsProps['MuiChartsYAxis']; }; MuiChartsAxisHighlight?: { - defaultProps?: ComponentsProps['MuiChartsAxisHighlight']; styleOverrides?: ComponentsOverrides['MuiChartsAxisHighlight']; }; - MuiChartsClipPath?: { - defaultProps?: ComponentsProps['MuiChartsClipPath']; - }; MuiChartsGrid?: { defaultProps?: ComponentsProps['MuiChartsGrid']; styleOverrides?: ComponentsOverrides['MuiChartsGrid']; @@ -32,12 +27,12 @@ export interface ChartsComponents { }; MuiChartsSurface?: { defaultProps?: ComponentsProps['MuiChartsSurface']; + styleOverrides?: ComponentsOverrides['MuiChartsSurface']; }; MuiBarChart?: { defaultProps?: ComponentsProps['MuiBarChart']; }; MuiBarElement?: { - defaultProps?: ComponentsProps['MuiBarElement']; styleOverrides?: ComponentsOverrides['MuiBarElement']; }; MuiBarLabel?: { @@ -48,23 +43,18 @@ export interface ChartsComponents { defaultProps?: ComponentsProps['MuiLineChart']; }; MuiAreaElement?: { - defaultProps?: ComponentsProps['MuiAreaElement']; styleOverrides?: ComponentsOverrides['MuiAreaElement']; }; MuiLineElement?: { - defaultProps?: ComponentsProps['MuiLineElement']; styleOverrides?: ComponentsOverrides['MuiLineElement']; }; MuiMarkElement?: { - defaultProps?: ComponentsProps['MuiMarkElement']; styleOverrides?: ComponentsOverrides['MuiMarkElement']; }; MuiScatterChart?: { defaultProps?: ComponentsProps['MuiScatterChart']; }; - MuiScatter?: { - defaultProps?: ComponentsProps['MuiScatter']; - }; + MuiScatter?: {}; } declare module '@mui/material/styles' { diff --git a/packages/x-charts/src/themeAugmentation/overrides.d.ts b/packages/x-charts/src/themeAugmentation/overrides.d.ts index bbf2a68b07cc6..24f6ce49c23fd 100644 --- a/packages/x-charts/src/themeAugmentation/overrides.d.ts +++ b/packages/x-charts/src/themeAugmentation/overrides.d.ts @@ -1,19 +1,20 @@ import { BarLabelClassKey } from '../BarChart'; import { BarElementClassKey } from '../BarChart/BarElement'; -import { ChartsAxisClassKey } from '../ChartsAxis'; import { ChartsAxisHighlightClassKey } from '../ChartsAxisHighlight'; import { ChartsGridClassKey } from '../ChartsGrid'; import { ChartsLegendClassKey } from '../ChartsLegend'; + import { ChartsTooltipClassKey } from '../ChartsTooltip'; import { AreaElementClassKey, LineElementClassKey, MarkElementClassKey } from '../LineChart'; -export interface PickersComponentNameToClassKey { - MuiChartsAxis: ChartsAxisClassKey; +export interface ChartsComponentNameToClassKey { + MuiChartsAxis: 'root'; // Only the root component of axes is styled MuiChartsAxisHighlight: ChartsAxisHighlightClassKey; MuiChartsGrid: ChartsGridClassKey; MuiChartsLegend: ChartsLegendClassKey; MuiChartsTooltip: ChartsTooltipClassKey; + MuiChartsSurface: 'root'; // BarChart components MuiBarElement: BarElementClassKey; MuiBarLabel: BarLabelClassKey; @@ -27,7 +28,7 @@ export interface PickersComponentNameToClassKey { } declare module '@mui/material/styles' { - interface ComponentNameToClassKey extends PickersComponentNameToClassKey {} + interface ComponentNameToClassKey extends ChartsComponentNameToClassKey {} } // disable automatic export diff --git a/packages/x-charts/src/themeAugmentation/themeAugmentation.spec.ts b/packages/x-charts/src/themeAugmentation/themeAugmentation.spec.ts index 695a934ee6edb..1c71789139c71 100644 --- a/packages/x-charts/src/themeAugmentation/themeAugmentation.spec.ts +++ b/packages/x-charts/src/themeAugmentation/themeAugmentation.spec.ts @@ -3,15 +3,10 @@ import { createTheme } from '@mui/material/styles'; createTheme({ components: { MuiChartsAxis: { - defaultProps: { - leftAxis: 'test', - // @ts-expect-error invalid MuiChartsAxis prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiChartsAxis class key - constent: { color: 'red' }, + line: { color: 'red' }, }, }, MuiChartsXAxis: { @@ -29,29 +24,12 @@ createTheme({ }, }, MuiChartsAxisHighlight: { - defaultProps: { - x: 'line', - // @ts-expect-error invalid MuiChartsAxisHighlight prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiChartsAxisHighlight class key constent: { color: 'red' }, }, }, - MuiChartsClipPath: { - defaultProps: { - id: 'test', - // @ts-expect-error invalid MuiChartsClipPath prop - someRandomProp: true, - }, - // styleOverrides: { - // root: { backgroundColor: 'red' }, - // // @ts-expect-error invalid MuiChartsClipPath class key - // constent: { color: 'red' }, - // }, - }, MuiChartsLegend: { defaultProps: { direction: 'row', @@ -82,11 +60,11 @@ createTheme({ // @ts-expect-error invalid MuiChartsSurface prop someRandomProp: true, }, - // styleOverrides: { - // root: { backgroundColor: 'red' }, - // // @ts-expect-error invalid MuiChartsSurface class key - // constent: { color: 'red' }, - // }, + styleOverrides: { + root: { backgroundColor: 'red' }, + // @ts-expect-error invalid MuiChartsSurface class key + constent: { color: 'red' }, + }, }, // BarChart components @@ -103,11 +81,6 @@ createTheme({ // }, }, MuiBarElement: { - defaultProps: { - id: 'toto', - // @ts-expect-error invalid MuiBarElement prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiBarElement class key @@ -128,11 +101,6 @@ createTheme({ // }, }, MuiAreaElement: { - defaultProps: { - id: 'toto', - // @ts-expect-error invalid MuiAreaElement prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiAreaElement class key @@ -140,11 +108,6 @@ createTheme({ }, }, MuiLineElement: { - defaultProps: { - id: 'toto', - // @ts-expect-error invalid MuiLineElement prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiLineElement class key @@ -152,11 +115,6 @@ createTheme({ }, }, MuiMarkElement: { - defaultProps: { - id: 'toto', - // @ts-expect-error invalid MuiMarkElement prop - someRandomProp: true, - }, styleOverrides: { root: { backgroundColor: 'red' }, // @ts-expect-error invalid MuiMarkElement class key @@ -176,17 +134,5 @@ createTheme({ // constent: { color: 'red' }, // }, }, - MuiScatter: { - defaultProps: { - markerSize: 10, - // @ts-expect-error invalid MuiScatter prop - someRandomProp: true, - }, - // styleOverrides: { - // root: { backgroundColor: 'red' }, - // // @ts-expect-error invalid MuiScatter class key - // constent: { color: 'red' }, - // }, - }, }, }); From 38cd7c76752f1d0f9b84f624e70d3a1dc8263514 Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 26 Aug 2024 18:44:23 +0200 Subject: [PATCH 11/13] docs:api --- docs/pages/x/api/charts/bar-chart.json | 2 +- docs/pages/x/api/charts/line-chart.json | 2 +- docs/pages/x/api/charts/pie-chart.json | 2 +- docs/pages/x/api/charts/scatter-chart.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/pages/x/api/charts/bar-chart.json b/docs/pages/x/api/charts/bar-chart.json index 98abf0ef7ad1c..4fbc846f99487 100644 --- a/docs/pages/x/api/charts/bar-chart.json +++ b/docs/pages/x/api/charts/bar-chart.json @@ -191,7 +191,7 @@ ], "classes": [], "spread": true, - "themeDefaultProps": false, + "themeDefaultProps": true, "muiName": "MuiBarChart", "forwardsRefTo": "SVGSVGElement", "filename": "/packages/x-charts/src/BarChart/BarChart.tsx", diff --git a/docs/pages/x/api/charts/line-chart.json b/docs/pages/x/api/charts/line-chart.json index bc272032eb1d7..51e2f75d22ab1 100644 --- a/docs/pages/x/api/charts/line-chart.json +++ b/docs/pages/x/api/charts/line-chart.json @@ -186,7 +186,7 @@ ], "classes": [], "spread": true, - "themeDefaultProps": false, + "themeDefaultProps": true, "muiName": "MuiLineChart", "forwardsRefTo": "SVGSVGElement", "filename": "/packages/x-charts/src/LineChart/LineChart.tsx", diff --git a/docs/pages/x/api/charts/pie-chart.json b/docs/pages/x/api/charts/pie-chart.json index 887c162a7a5c0..cc208bd3f97c9 100644 --- a/docs/pages/x/api/charts/pie-chart.json +++ b/docs/pages/x/api/charts/pie-chart.json @@ -170,7 +170,7 @@ ], "classes": [], "spread": true, - "themeDefaultProps": false, + "themeDefaultProps": true, "muiName": "MuiPieChart", "forwardsRefTo": "SVGSVGElement", "filename": "/packages/x-charts/src/PieChart/PieChart.tsx", diff --git a/docs/pages/x/api/charts/scatter-chart.json b/docs/pages/x/api/charts/scatter-chart.json index 352dfeeaad5b5..f9daa7ae5b4b4 100644 --- a/docs/pages/x/api/charts/scatter-chart.json +++ b/docs/pages/x/api/charts/scatter-chart.json @@ -176,7 +176,7 @@ ], "classes": [], "spread": true, - "themeDefaultProps": false, + "themeDefaultProps": true, "muiName": "MuiScatterChart", "forwardsRefTo": "SVGSVGElement", "filename": "/packages/x-charts/src/ScatterChart/ScatterChart.tsx", From 077502f2c198228f7f283c83741def65b552e839 Mon Sep 17 00:00:00 2001 From: Lucas Hilgert Date: Mon, 26 Aug 2024 19:54:01 +0200 Subject: [PATCH 12/13] refactor useThemeProps-hook usage --- packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx | 6 +++--- packages/x-charts-pro/src/Heatmap/Heatmap.tsx | 6 +++--- packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx | 6 +++--- .../x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx | 6 +++--- packages/x-charts/src/BarChart/BarChart.tsx | 6 +++--- packages/x-charts/src/BarChart/BarLabel/BarLabel.tsx | 6 +++--- packages/x-charts/src/ChartsGrid/ChartsGrid.tsx | 8 ++++---- packages/x-charts/src/ChartsSurface/ChartsSurface.tsx | 6 +++--- packages/x-charts/src/LineChart/LineChart.tsx | 6 +++--- packages/x-charts/src/PieChart/PieChart.tsx | 6 +++--- packages/x-charts/src/ScatterChart/ScatterChart.tsx | 6 +++--- 11 files changed, 34 insertions(+), 34 deletions(-) diff --git a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx index 853af3e5c9361..f07082ebd6281 100644 --- a/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx +++ b/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx @@ -30,9 +30,9 @@ export interface BarChartProProps extends BarChartProps, ZoomProps {} * * - [BarChart API](https://mui.com/x/api/charts/bar-chart/) */ -const BarChartPro = React.forwardRef(function BarChartPro(props: BarChartProProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiBarChartPro' }); - const { zoom, onZoomChange, ...other } = themeProps; +const BarChartPro = React.forwardRef(function BarChartPro(inProps: BarChartProProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiBarChartPro' }); + const { zoom, onZoomChange, ...other } = props; const { chartContainerProps, barPlotProps, diff --git a/packages/x-charts-pro/src/Heatmap/Heatmap.tsx b/packages/x-charts-pro/src/Heatmap/Heatmap.tsx index 8be52ac59617d..eac1180542627 100644 --- a/packages/x-charts-pro/src/Heatmap/Heatmap.tsx +++ b/packages/x-charts-pro/src/Heatmap/Heatmap.tsx @@ -105,8 +105,8 @@ const defaultColorMap = interpolateRgbBasis([ '#084081', ]); -const Heatmap = React.forwardRef(function Heatmap(props: HeatmapProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiHeatmap' }); +const Heatmap = React.forwardRef(function Heatmap(inProps: HeatmapProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiHeatmap' }); const { xAxis, yAxis, @@ -130,7 +130,7 @@ const Heatmap = React.forwardRef(function Heatmap(props: HeatmapProps, ref) { loading, highlightedItem, onHighlightChange, - } = themeProps; + } = props; const id = useId(); const clipPathId = `${id}-clip-path`; diff --git a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx index cf9d9916b9046..90782a38be2d4 100644 --- a/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx +++ b/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx @@ -37,9 +37,9 @@ export interface LineChartProProps extends LineChartProps, ZoomProps {} * * - [LineChart API](https://mui.com/x/api/charts/line-chart/) */ -const LineChartPro = React.forwardRef(function LineChartPro(props: LineChartProProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiLineChartPro' }); - const { zoom, onZoomChange, ...other } = themeProps; +const LineChartPro = React.forwardRef(function LineChartPro(inProps: LineChartProProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiLineChartPro' }); + const { zoom, onZoomChange, ...other } = props; const { chartContainerProps, axisClickHandlerProps, diff --git a/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx b/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx index 14dc0c02d3ee1..06679a1e0b2df 100644 --- a/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx +++ b/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx @@ -28,11 +28,11 @@ export interface ScatterChartProProps extends ScatterChartProps, ZoomProps {} * - [ScatterChart API](https://mui.com/x/api/charts/scatter-chart/) */ const ScatterChartPro = React.forwardRef(function ScatterChartPro( - props: ScatterChartProProps, + inProps: ScatterChartProProps, ref, ) { - const themeProps = useThemeProps({ props, name: 'MuiScatterChartPro' }); - const { zoom, onZoomChange, ...other } = themeProps; + const props = useThemeProps({ props: inProps, name: 'MuiScatterChartPro' }); + const { zoom, onZoomChange, ...other } = props; const { chartContainerProps, zAxisProps, diff --git a/packages/x-charts/src/BarChart/BarChart.tsx b/packages/x-charts/src/BarChart/BarChart.tsx index 3f2af40bb439f..7aca01261877e 100644 --- a/packages/x-charts/src/BarChart/BarChart.tsx +++ b/packages/x-charts/src/BarChart/BarChart.tsx @@ -110,8 +110,8 @@ export interface BarChartProps * * - [BarChart API](https://mui.com/x/api/charts/bar-chart/) */ -const BarChart = React.forwardRef(function BarChart(props: BarChartProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiBarChart' }); +const BarChart = React.forwardRef(function BarChart(inProps: BarChartProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiBarChart' }); const { chartContainerProps, barPlotProps, @@ -125,7 +125,7 @@ const BarChart = React.forwardRef(function BarChart(props: BarChartProps, ref) { legendProps, tooltipProps, children, - } = useBarChartProps(themeProps); + } = useBarChartProps(props); return ( diff --git a/packages/x-charts/src/BarChart/BarLabel/BarLabel.tsx b/packages/x-charts/src/BarChart/BarLabel/BarLabel.tsx index 7b18ddf9568a0..d3c9af981dee8 100644 --- a/packages/x-charts/src/BarChart/BarLabel/BarLabel.tsx +++ b/packages/x-charts/src/BarChart/BarLabel/BarLabel.tsx @@ -29,10 +29,10 @@ export const BarLabelComponent = styled(animated.text, { export type BarLabelProps = Omit, 'ref' | 'id'> & BarLabelOwnerState; -function BarLabel(props: BarLabelProps) { - const themeProps = useThemeProps({ props, name: 'MuiBarLabel' }); +function BarLabel(inProps: BarLabelProps) { + const props = useThemeProps({ props: inProps, name: 'MuiBarLabel' }); - const { seriesId, dataIndex, color, isFaded, isHighlighted, classes, ...otherProps } = themeProps; + const { seriesId, dataIndex, color, isFaded, isHighlighted, classes, ...otherProps } = props; return ; } diff --git a/packages/x-charts/src/ChartsGrid/ChartsGrid.tsx b/packages/x-charts/src/ChartsGrid/ChartsGrid.tsx index 19b880e70ed09..497d23977067c 100644 --- a/packages/x-charts/src/ChartsGrid/ChartsGrid.tsx +++ b/packages/x-charts/src/ChartsGrid/ChartsGrid.tsx @@ -66,14 +66,14 @@ export interface ChartsGridProps { * * - [ChartsGrid API](https://mui.com/x/api/charts/charts-axis/) */ -function ChartsGrid(props: ChartsGridProps) { - const themeProps = useThemeProps({ props, name: 'MuiChartsGrid' }); +function ChartsGrid(inProps: ChartsGridProps) { + const props = useThemeProps({ props: inProps, name: 'MuiChartsGrid' }); const drawingArea = useDrawingArea(); - const { vertical, horizontal, ...other } = themeProps; + const { vertical, horizontal, ...other } = props; const { xAxis, xAxisIds, yAxis, yAxisIds } = useCartesianContext(); - const classes = useUtilityClasses(themeProps); + const classes = useUtilityClasses(props); const horizontalAxisId = yAxisIds[0]; const verticalAxisId = xAxisIds[0]; diff --git a/packages/x-charts/src/ChartsSurface/ChartsSurface.tsx b/packages/x-charts/src/ChartsSurface/ChartsSurface.tsx index 153c92fcdd632..769a65fb58357 100644 --- a/packages/x-charts/src/ChartsSurface/ChartsSurface.tsx +++ b/packages/x-charts/src/ChartsSurface/ChartsSurface.tsx @@ -42,10 +42,10 @@ const ChartChartsSurfaceStyles = styled('svg', { })); const ChartsSurface = React.forwardRef(function ChartsSurface( - props: ChartsSurfaceProps, + inProps: ChartsSurfaceProps, ref, ) { - const themeProps = useThemeProps({ props, name: 'MuiChartsSurface' }); + const props = useThemeProps({ props: inProps, name: 'MuiChartsSurface' }); const { children, width, @@ -56,7 +56,7 @@ const ChartsSurface = React.forwardRef(functi title, desc, ...other - } = themeProps; + } = props; const svgView = { width, height, x: 0, y: 0, ...viewBox }; useAxisEvents(disableAxisListener); diff --git a/packages/x-charts/src/LineChart/LineChart.tsx b/packages/x-charts/src/LineChart/LineChart.tsx index 7634ca1f4d3dc..0bd258bfd715b 100644 --- a/packages/x-charts/src/LineChart/LineChart.tsx +++ b/packages/x-charts/src/LineChart/LineChart.tsx @@ -136,8 +136,8 @@ export interface LineChartProps * * - [LineChart API](https://mui.com/x/api/charts/line-chart/) */ -const LineChart = React.forwardRef(function LineChart(props: LineChartProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiLineChart' }); +const LineChart = React.forwardRef(function LineChart(inProps: LineChartProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiLineChart' }); const { chartContainerProps, axisClickHandlerProps, @@ -154,7 +154,7 @@ const LineChart = React.forwardRef(function LineChart(props: LineChartProps, ref legendProps, tooltipProps, children, - } = useLineChartProps(themeProps); + } = useLineChartProps(props); return ( diff --git a/packages/x-charts/src/PieChart/PieChart.tsx b/packages/x-charts/src/PieChart/PieChart.tsx index 20f45c261c8bb..dca99305017f5 100644 --- a/packages/x-charts/src/PieChart/PieChart.tsx +++ b/packages/x-charts/src/PieChart/PieChart.tsx @@ -124,8 +124,8 @@ const defaultRTLMargin = { top: 5, bottom: 5, left: 100, right: 5 }; * * - [PieChart API](https://mui.com/x/api/charts/pie-chart/) */ -const PieChart = React.forwardRef(function PieChart(props: PieChartProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiPieChart' }); +const PieChart = React.forwardRef(function PieChart(inProps: PieChartProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiPieChart' }); const { xAxis, yAxis, @@ -152,7 +152,7 @@ const PieChart = React.forwardRef(function PieChart(props: PieChartProps, ref) { onHighlightChange, className, ...other - } = themeProps; + } = props; const isRTL = useIsRTL(); const margin = { ...(isRTL ? defaultRTLMargin : defaultMargin), ...marginProps }; diff --git a/packages/x-charts/src/ScatterChart/ScatterChart.tsx b/packages/x-charts/src/ScatterChart/ScatterChart.tsx index 830afde6b464c..ecd3bbe6c2c3e 100644 --- a/packages/x-charts/src/ScatterChart/ScatterChart.tsx +++ b/packages/x-charts/src/ScatterChart/ScatterChart.tsx @@ -119,8 +119,8 @@ export interface ScatterChartProps * * - [ScatterChart API](https://mui.com/x/api/charts/scatter-chart/) */ -const ScatterChart = React.forwardRef(function ScatterChart(props: ScatterChartProps, ref) { - const themeProps = useThemeProps({ props, name: 'MuiScatterChart' }); +const ScatterChart = React.forwardRef(function ScatterChart(inProps: ScatterChartProps, ref) { + const props = useThemeProps({ props: inProps, name: 'MuiScatterChart' }); const { chartContainerProps, zAxisProps, @@ -133,7 +133,7 @@ const ScatterChart = React.forwardRef(function ScatterChart(props: ScatterChartP axisHighlightProps, tooltipProps, children, - } = useScatterChartProps(themeProps); + } = useScatterChartProps(props); return ( From bc59defd2a01e25e8b8293cc0afb0429d2a58cca Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 27 Aug 2024 11:13:52 +0200 Subject: [PATCH 13/13] ci