From d7b1062c178f428a0f583c1a8b962cd3dd3ab755 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 16 Jul 2024 14:17:32 +0200 Subject: [PATCH 01/18] update changelog script --- scripts/releaseChangelog.mjs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/scripts/releaseChangelog.mjs b/scripts/releaseChangelog.mjs index 7c2867817cc91..18cf5e6de2536 100644 --- a/scripts/releaseChangelog.mjs +++ b/scripts/releaseChangelog.mjs @@ -157,6 +157,7 @@ async function main(argv) { const pickersCommits = []; const pickersProCommits = []; const chartsCommits = []; + const chartsProCommits = []; const treeViewCommits = []; const coreCommits = []; const docsCommits = []; @@ -189,6 +190,9 @@ async function main(argv) { case 'DateTimeRangePicker': pickersProCommits.push(commitItem); break; + case 'charts-pro': + chartsProCommits.push(commitItem); + break; case 'charts': chartsCommits.push(commitItem); break; @@ -312,6 +316,11 @@ ${logChangelogSection(pickersProCommits)} ${logChangelogSection(chartsCommits)} +#### \`@mui/x-date-charts-pro@__VERSION-ALPHA__\` [![pro](https://mui.com/r/x-pro-svg)](https://mui.com/r/x-pro-svg-link 'Pro plan') + +Same changes as in \`@mui/x-charts@__VERSION__\`${chartsProCommits.length > 0 ? ', plus:\n' : '.'} +${logChangelogSection(chartsProCommits)} + ### Tree View #### \`@mui/x-tree-view@__VERSION__\` From ff0b19eaa69cfa3866834b50c567fc361de67053 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 16 Jul 2024 14:18:13 +0200 Subject: [PATCH 02/18] make package public --- packages/x-charts-pro/package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/x-charts-pro/package.json b/packages/x-charts-pro/package.json index bea9b74d15649..6eff5c8654b9f 100644 --- a/packages/x-charts-pro/package.json +++ b/packages/x-charts-pro/package.json @@ -1,7 +1,6 @@ { "name": "@mui/x-charts-pro", "version": "7.7.0", - "private": true, "description": "The Pro plan edition of the Charts components (MUI X).", "author": "MUI Team", "main": "./src/index.ts", From 8e3a869675ec211cc31a04a7fc03ef35d6612d85 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 16 Jul 2024 14:18:56 +0200 Subject: [PATCH 03/18] set alpha version for charts pro --- docs/src/modules/components/ChartComponentsGrid.js | 1 - packages/x-charts-pro/package.json | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/src/modules/components/ChartComponentsGrid.js b/docs/src/modules/components/ChartComponentsGrid.js index 8752ad0ec1fc0..21fed83ce16d1 100644 --- a/docs/src/modules/components/ChartComponentsGrid.js +++ b/docs/src/modules/components/ChartComponentsGrid.js @@ -65,7 +65,6 @@ function getComponents() { srcLight: '/static/x/component-illustrations/heatmap-light.png', srcDark: '/static/x/component-illustrations/heatmap-dark.png', href: '/x/react-charts/heatmap/', - planned: true, pro: true, }, { diff --git a/packages/x-charts-pro/package.json b/packages/x-charts-pro/package.json index 6eff5c8654b9f..d18df45346237 100644 --- a/packages/x-charts-pro/package.json +++ b/packages/x-charts-pro/package.json @@ -1,6 +1,6 @@ { "name": "@mui/x-charts-pro", - "version": "7.7.0", + "version": "7.0.0-alpha.0", "description": "The Pro plan edition of the Charts components (MUI X).", "author": "MUI Team", "main": "./src/index.ts", From f8f731c7810d655fb273021399eb2198b15e61b8 Mon Sep 17 00:00:00 2001 From: alexandre Date: Wed, 17 Jul 2024 13:36:06 +0200 Subject: [PATCH 04/18] update instruction --- .../charts/getting-started/getting-started.md | 17 ++--------------- .../ChartsInstallationInstructions.js | 13 +++++++++++++ 2 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 docs/src/modules/components/ChartsInstallationInstructions.js diff --git a/docs/data/charts/getting-started/getting-started.md b/docs/data/charts/getting-started/getting-started.md index 7eea0dda7d14d..99ebe39d73aff 100644 --- a/docs/data/charts/getting-started/getting-started.md +++ b/docs/data/charts/getting-started/getting-started.md @@ -10,24 +10,11 @@ packageName: '@mui/x-charts' ## Installation -Run one of the following commands to add the MUI X Charts to your project: +Using your favorite package manager, install `@mui/x-charts-pro` for the commercial version, or `@mui/x-charts` for the free community version. - -```bash npm -npm install @mui/x-charts -``` - -```bash yarn -yarn add @mui/x-charts -``` - -```bash pnpm -pnpm add @mui/x-charts -``` - - +{{"component": "modules/components/ChartsInstallationInstructions.js"}} The Charts package has a peer dependency on `@mui/material`. If you are not already using it in your project, you can install it with: diff --git a/docs/src/modules/components/ChartsInstallationInstructions.js b/docs/src/modules/components/ChartsInstallationInstructions.js new file mode 100644 index 0000000000000..b11fd2a211354 --- /dev/null +++ b/docs/src/modules/components/ChartsInstallationInstructions.js @@ -0,0 +1,13 @@ +import * as React from 'react'; +import InstallationInstructions from './InstallationInstructions'; + +// #default-branch-switch + +const packages = { + Community: '@mui/x-charts', + Pro: '@mui/x-charts-pro', +}; + +export default function DataGridInstallationInstructions() { + return ; +} From a62f32e60d510ca180830cb5dcdea31fd95a7bbf Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 09:19:14 +0200 Subject: [PATCH 05/18] remove unstable in docs demo --- docs/data/charts/heatmap/BasicHeatmap.js | 4 ++-- docs/data/charts/heatmap/BasicHeatmap.tsx | 4 ++-- docs/data/charts/heatmap/BasicHeatmap.tsx.preview | 2 +- docs/data/charts/heatmap/ColorConfig.js | 4 ++-- docs/data/charts/heatmap/ColorConfig.tsx | 4 ++-- docs/data/charts/heatmap/CustomItem.js | 4 ++-- docs/data/charts/heatmap/CustomItem.tsx | 4 ++-- docs/data/charts/heatmap/CustomItem.tsx.preview | 2 +- docs/data/charts/heatmap/HighlightClasses.js | 4 ++-- docs/data/charts/heatmap/HighlightClasses.tsx | 4 ++-- docs/data/charts/heatmap/HighlightHeatmap.js | 4 ++-- docs/data/charts/heatmap/HighlightHeatmap.tsx | 4 ++-- docs/data/charts/heatmap/HighlightHeatmap.tsx.preview | 2 +- packages/x-charts-pro/src/Heatmap/index.ts | 4 ++-- 14 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/data/charts/heatmap/BasicHeatmap.js b/docs/data/charts/heatmap/BasicHeatmap.js index 1f3410543e9b6..c8f6bb82978ed 100644 --- a/docs/data/charts/heatmap/BasicHeatmap.js +++ b/docs/data/charts/heatmap/BasicHeatmap.js @@ -1,13 +1,13 @@ import * as React from 'react'; import Box from '@mui/material/Box'; import '@mui/x-charts-pro/typeOverloads'; -import { UnstableHeatmap } from '@mui/x-charts-pro/Heatmap'; +import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; export default function BasicHeatmap() { return ( - - month); export default function ColorConfig() { return ( - month); export default function ColorConfig() { return ( - - - - - - - Date: Thu, 18 Jul 2024 09:37:58 +0200 Subject: [PATCH 06/18] Remove the need of type overload in demos --- docs/data/charts/heatmap/BasicHeatmap.js | 1 - docs/data/charts/heatmap/BasicHeatmap.tsx | 1 - docs/data/charts/heatmap/ColorConfig.js | 1 - docs/data/charts/heatmap/ColorConfig.tsx | 1 - docs/data/charts/heatmap/CustomItem.js | 1 - docs/data/charts/heatmap/CustomItem.tsx | 1 - docs/data/charts/heatmap/HighlightClasses.js | 1 - docs/data/charts/heatmap/HighlightClasses.tsx | 1 - docs/data/charts/heatmap/HighlightHeatmap.js | 1 - docs/data/charts/heatmap/HighlightHeatmap.tsx | 1 - packages/x-charts-pro/src/Heatmap/index.ts | 6 ++++-- 11 files changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/data/charts/heatmap/BasicHeatmap.js b/docs/data/charts/heatmap/BasicHeatmap.js index c8f6bb82978ed..38f200e412b9b 100644 --- a/docs/data/charts/heatmap/BasicHeatmap.js +++ b/docs/data/charts/heatmap/BasicHeatmap.js @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/BasicHeatmap.tsx b/docs/data/charts/heatmap/BasicHeatmap.tsx index c8f6bb82978ed..38f200e412b9b 100644 --- a/docs/data/charts/heatmap/BasicHeatmap.tsx +++ b/docs/data/charts/heatmap/BasicHeatmap.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/ColorConfig.js b/docs/data/charts/heatmap/ColorConfig.js index 55a8402f9a850..b20e75a7a1181 100644 --- a/docs/data/charts/heatmap/ColorConfig.js +++ b/docs/data/charts/heatmap/ColorConfig.js @@ -1,6 +1,5 @@ import * as React from 'react'; import { interpolateBlues } from 'd3-scale-chromatic'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; const dataset = [ diff --git a/docs/data/charts/heatmap/ColorConfig.tsx b/docs/data/charts/heatmap/ColorConfig.tsx index abcbca1cd00a9..ee09304de139d 100644 --- a/docs/data/charts/heatmap/ColorConfig.tsx +++ b/docs/data/charts/heatmap/ColorConfig.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; import { interpolateBlues } from 'd3-scale-chromatic'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { HeatmapValueType } from '@mui/x-charts-pro/models'; diff --git a/docs/data/charts/heatmap/CustomItem.js b/docs/data/charts/heatmap/CustomItem.js index 71f0cabfce04e..62233cd7feb1b 100644 --- a/docs/data/charts/heatmap/CustomItem.js +++ b/docs/data/charts/heatmap/CustomItem.js @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/CustomItem.tsx b/docs/data/charts/heatmap/CustomItem.tsx index 9dd103db3c4f1..dd0dbff5ef823 100644 --- a/docs/data/charts/heatmap/CustomItem.tsx +++ b/docs/data/charts/heatmap/CustomItem.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/HighlightClasses.js b/docs/data/charts/heatmap/HighlightClasses.js index e55c6b195f5b8..d8dfef304f661 100644 --- a/docs/data/charts/heatmap/HighlightClasses.js +++ b/docs/data/charts/heatmap/HighlightClasses.js @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap, heatmapClasses } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/HighlightClasses.tsx b/docs/data/charts/heatmap/HighlightClasses.tsx index e55c6b195f5b8..d8dfef304f661 100644 --- a/docs/data/charts/heatmap/HighlightClasses.tsx +++ b/docs/data/charts/heatmap/HighlightClasses.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap, heatmapClasses } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/HighlightHeatmap.js b/docs/data/charts/heatmap/HighlightHeatmap.js index abdbd1b89f480..d122adfd2b0aa 100644 --- a/docs/data/charts/heatmap/HighlightHeatmap.js +++ b/docs/data/charts/heatmap/HighlightHeatmap.js @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/docs/data/charts/heatmap/HighlightHeatmap.tsx b/docs/data/charts/heatmap/HighlightHeatmap.tsx index abdbd1b89f480..d122adfd2b0aa 100644 --- a/docs/data/charts/heatmap/HighlightHeatmap.tsx +++ b/docs/data/charts/heatmap/HighlightHeatmap.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; import Box from '@mui/material/Box'; -import '@mui/x-charts-pro/typeOverloads'; import { Heatmap } from '@mui/x-charts-pro/Heatmap'; import { data } from './dumbData'; diff --git a/packages/x-charts-pro/src/Heatmap/index.ts b/packages/x-charts-pro/src/Heatmap/index.ts index 806918ba22ebe..ceba96993d01f 100644 --- a/packages/x-charts-pro/src/Heatmap/index.ts +++ b/packages/x-charts-pro/src/Heatmap/index.ts @@ -1,4 +1,6 @@ -export { Heatmap as Heatmap } from './Heatmap'; -export { HeatmapPlot as HeatmapPlot } from './HeatmapPlot'; +import type {} from '../typeOverloads'; + +export { Heatmap } from './Heatmap'; +export { HeatmapPlot } from './HeatmapPlot'; export * from './DefaultHeatmapTooltip'; export * from './heatmapClasses'; From 4fc797be45e112280ef1865085b1f00e880535a0 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 09:39:36 +0200 Subject: [PATCH 07/18] mark zoom as unstable --- docs/data/pages.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/data/pages.ts b/docs/data/pages.ts index 12a8c186dfc8d..2eeb4d5da2bb8 100644 --- a/docs/data/pages.ts +++ b/docs/data/pages.ts @@ -442,7 +442,12 @@ const pages: MuiPage[] = [ { pathname: '/x/react-charts/stacking' }, { pathname: '/x/react-charts/styling' }, { pathname: '/x/react-charts/tooltip', title: 'Tooltip & Highlights' }, - { pathname: '/x/react-charts/zoom-and-pan', title: 'Zoom & Pan', plan: 'pro' }, + { + pathname: '/x/react-charts/zoom-and-pan', + title: 'Zoom & Pan', + plan: 'pro', + unstable: true, + }, ], }, { From 4918bd902ce7f9c4e5d340791e1697b468459094 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 09:40:07 +0200 Subject: [PATCH 08/18] add charts top pro packages list --- docs/data/introduction/licensing/licensing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/data/introduction/licensing/licensing.md b/docs/data/introduction/licensing/licensing.md index d5740d8df4974..fdb53165a57f1 100644 --- a/docs/data/introduction/licensing/licensing.md +++ b/docs/data/introduction/licensing/licensing.md @@ -43,6 +43,7 @@ These are the Pro npm packages: - [`@mui/x-data-grid-pro`](https://www.npmjs.com/package/@mui/x-data-grid-pro) - [`@mui/x-date-pickers-pro`](https://www.npmjs.com/package/@mui/x-date-pickers-pro) +- [`@mui/x-charts-pro`](https://www.npmjs.com/package/@mui/x-charts-pro) ### Premium plan From 7b4c6ffa70bbd4cfbca545137f4393d9f222ac84 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 09:51:00 +0200 Subject: [PATCH 09/18] disable ads --- docs/pages/x/react-charts/heatmap.js | 2 +- docs/pages/x/react-charts/zoom-and-pan.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/x/react-charts/heatmap.js b/docs/pages/x/react-charts/heatmap.js index 64f12f23f6eaa..0afdda688028f 100644 --- a/docs/pages/x/react-charts/heatmap.js +++ b/docs/pages/x/react-charts/heatmap.js @@ -3,5 +3,5 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; import * as pageProps from 'docsx/data/charts/heatmap/heatmap.md?muiMarkdown'; export default function Page() { - return ; + return ; } diff --git a/docs/pages/x/react-charts/zoom-and-pan.js b/docs/pages/x/react-charts/zoom-and-pan.js index 4a2393ba8b38e..f66861bb5a5d4 100644 --- a/docs/pages/x/react-charts/zoom-and-pan.js +++ b/docs/pages/x/react-charts/zoom-and-pan.js @@ -3,5 +3,5 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; import * as pageProps from 'docsx/data/charts/zoom-and-pan/zoom-and-pan.md?muiMarkdown'; export default function Page() { - return ; + return ; } From 5675d51145f96f35ab7fd9e5f8e47bb7484d7780 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 10:06:04 +0200 Subject: [PATCH 10/18] title case --- docs/data/charts/zoom-and-pan/zoom-and-pan.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/data/charts/zoom-and-pan/zoom-and-pan.md b/docs/data/charts/zoom-and-pan/zoom-and-pan.md index d0ef87f92662f..ccebfae2917d6 100644 --- a/docs/data/charts/zoom-and-pan/zoom-and-pan.md +++ b/docs/data/charts/zoom-and-pan/zoom-and-pan.md @@ -26,7 +26,7 @@ The following actions are supported: {{"demo": "ZoomBarChart.js"}} {{"demo": "ZoomLineChart.js"}} -## Zooming Options +## Zooming options You can customize the zooming behavior by setting the `zoomOptions` prop. From dc1da1617b2eaa679c01b103beb97c9ef3605dec Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 10:30:54 +0200 Subject: [PATCH 11/18] Mark HeatmapItem as internal --- docs/data/charts-component-api-pages.ts | 5 -- docs/data/charts/heatmap/heatmap.md | 2 +- docs/pages/x/api/charts/heatmap.json | 60 ++----------------- .../charts/heatmap-item/heatmap-item.json | 9 --- .../api-docs/charts/heatmap/heatmap.json | 12 +--- .../x-charts-pro/src/Heatmap/HeatmapItem.tsx | 3 + scripts/x-charts-pro.exports.json | 9 --- 7 files changed, 10 insertions(+), 90 deletions(-) delete mode 100644 docs/translations/api-docs/charts/heatmap-item/heatmap-item.json diff --git a/docs/data/charts-component-api-pages.ts b/docs/data/charts-component-api-pages.ts index 4619cc2c0ffa6..aaaa09657dbea 100644 --- a/docs/data/charts-component-api-pages.ts +++ b/docs/data/charts-component-api-pages.ts @@ -133,11 +133,6 @@ const apiPages: MuiPage[] = [ title: 'Heatmap', plan: 'pro', }, - { - pathname: '/x/api/charts/heatmap-item', - title: 'HeatmapItem', - plan: 'pro', - }, { pathname: '/x/api/charts/heatmap-plot', title: 'HeatmapPlot', diff --git a/docs/data/charts/heatmap/heatmap.md b/docs/data/charts/heatmap/heatmap.md index fd5a059db04c5..6dd30e516e001 100644 --- a/docs/data/charts/heatmap/heatmap.md +++ b/docs/data/charts/heatmap/heatmap.md @@ -1,7 +1,7 @@ --- title: React Heatmap chart productId: x-charts -components: Heatmap, HeatmapPlot, HeatmapItem, DefaultHeatmapTooltip +components: Heatmap, HeatmapPlot, DefaultHeatmapTooltip --- # Charts - Heatmap [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧 diff --git a/docs/pages/x/api/charts/heatmap.json b/docs/pages/x/api/charts/heatmap.json index 5cc4ec4b7c5a8..faf58d7706422 100644 --- a/docs/pages/x/api/charts/heatmap.json +++ b/docs/pages/x/api/charts/heatmap.json @@ -95,63 +95,13 @@ "import { Heatmap } from '@mui/x-charts-pro/Heatmap';", "import { Heatmap } from '@mui/x-charts-pro';" ], - "slots": [ - { - "name": "axisLabel", - "description": "Custom component for axis label.", - "default": "ChartsText", - "class": null - }, - { - "name": "axisLine", - "description": "Custom component for the axis main line.", - "default": "'line'", - "class": null - }, - { - "name": "axisTick", - "description": "Custom component for the axis tick.", - "default": "'line'", - "class": null - }, - { - "name": "axisTickLabel", - "description": "Custom component for tick label.", - "default": "ChartsText", - "class": null - }, - { - "name": "cell", - "description": "The component that renders the heatmap cell.", - "default": "HeatmapCell", - "class": "MuiHeatmap-cell" - }, - { - "name": "itemContent", - "description": "Custom component for displaying tooltip content when triggered by item event.", - "default": "DefaultChartsItemTooltipContent", - "class": null - }, - { - "name": "loadingOverlay", - "description": "Overlay component rendered when the chart is in a loading state.", - "default": "ChartsLoadingOverlay", - "class": null - }, + "classes": [ { - "name": "noDataOverlay", - "description": "Overlay component rendered when the chart has no data to display.", - "default": "ChartsNoDataOverlay", - "class": null + "key": "cell", + "className": "MuiHeatmap-cell", + "description": "Styles applied to the heatmap cells.", + "isGlobal": false }, - { - "name": "popper", - "description": "Custom component for the tooltip popper.", - "default": "ChartsTooltipRoot", - "class": null - } - ], - "classes": [ { "key": "faded", "className": "MuiHeatmap-faded", diff --git a/docs/translations/api-docs/charts/heatmap-item/heatmap-item.json b/docs/translations/api-docs/charts/heatmap-item/heatmap-item.json deleted file mode 100644 index e14233d823404..0000000000000 --- a/docs/translations/api-docs/charts/heatmap-item/heatmap-item.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "componentDescription": "", - "propDescriptions": { - "slotProps": { "description": "The props used for each component slot." }, - "slots": { "description": "Overridable component slots." } - }, - "classDescriptions": {}, - "slotDescriptions": { "cell": "The component that renders the heatmap cell." } -} diff --git a/docs/translations/api-docs/charts/heatmap/heatmap.json b/docs/translations/api-docs/charts/heatmap/heatmap.json index f5ad8fd40997a..8db3fec541fc5 100644 --- a/docs/translations/api-docs/charts/heatmap/heatmap.json +++ b/docs/translations/api-docs/charts/heatmap/heatmap.json @@ -62,6 +62,7 @@ "zAxis": { "description": "The configuration of the z-axes." } }, "classDescriptions": { + "cell": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the heatmap cells" }, "faded": { "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the cell element", @@ -72,16 +73,5 @@ "nodeName": "the cell element", "conditions": "highlighted" } - }, - "slotDescriptions": { - "axisLabel": "Custom component for axis label.", - "axisLine": "Custom component for the axis main line.", - "axisTick": "Custom component for the axis tick.", - "axisTickLabel": "Custom component for tick label.", - "cell": "The component that renders the heatmap cell.", - "itemContent": "Custom component for displaying tooltip content when triggered by item event.", - "loadingOverlay": "Overlay component rendered when the chart is in a loading state.", - "noDataOverlay": "Overlay component rendered when the chart has no data to display.", - "popper": "Custom component for the tooltip popper." } } diff --git a/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx b/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx index ef38071bbf358..5973d972eca92 100644 --- a/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx +++ b/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx @@ -70,6 +70,9 @@ const useUtilityClasses = (ownerState: HeatmapItemOwnerState) => { return composeClasses(slots, getHeatmapUtilityClass, classes); }; +/** + * @ignore - internal component. + */ function HeatmapItem(props: HeatmapItemProps) { const { seriesId, dataIndex, color, value, slotProps = {}, slots = {}, ...other } = props; diff --git a/scripts/x-charts-pro.exports.json b/scripts/x-charts-pro.exports.json index bec72c5ad30ab..23628aa41ab38 100644 --- a/scripts/x-charts-pro.exports.json +++ b/scripts/x-charts-pro.exports.json @@ -177,16 +177,7 @@ { "name": "heatmapClasses", "kind": "Variable" }, { "name": "HeatmapClasses", "kind": "Interface" }, { "name": "HeatmapClassKey", "kind": "TypeAlias" }, - { "name": "HeatmapItem", "kind": "Function" }, - { "name": "HeatmapItemOwnerState", "kind": "Interface" }, - { "name": "HeatmapItemProps", "kind": "Interface" }, - { "name": "HeatmapItemSlotProps", "kind": "Interface" }, - { "name": "HeatmapItemSlots", "kind": "Interface" }, { "name": "HeatmapPlot", "kind": "Function" }, - { "name": "HeatmapPlotProps", "kind": "Interface" }, - { "name": "HeatmapProps", "kind": "Interface" }, - { "name": "HeatmapSlotProps", "kind": "Interface" }, - { "name": "HeatmapSlots", "kind": "Interface" }, { "name": "HighlightedContext", "kind": "Variable" }, { "name": "HighlightedProvider", "kind": "Function" }, { "name": "HighlightedProviderProps", "kind": "TypeAlias" }, From 28dbbc7bb5c75e1bc3ddcee09bba3f05a6adfc4c Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 18 Jul 2024 10:55:02 +0200 Subject: [PATCH 12/18] clean --- docs/pages/x/api/charts/heatmap-item.js | 23 ------------------ docs/pages/x/api/charts/heatmap-item.json | 29 ----------------------- 2 files changed, 52 deletions(-) delete mode 100644 docs/pages/x/api/charts/heatmap-item.js delete mode 100644 docs/pages/x/api/charts/heatmap-item.json diff --git a/docs/pages/x/api/charts/heatmap-item.js b/docs/pages/x/api/charts/heatmap-item.js deleted file mode 100644 index 208c470c11395..0000000000000 --- a/docs/pages/x/api/charts/heatmap-item.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docs/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './heatmap-item.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/charts/heatmap-item', - false, - /\.\/heatmap-item.*.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/x/api/charts/heatmap-item.json b/docs/pages/x/api/charts/heatmap-item.json deleted file mode 100644 index a924c31e0f10d..0000000000000 --- a/docs/pages/x/api/charts/heatmap-item.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "props": { - "slotProps": { "type": { "name": "object" }, "default": "{}" }, - "slots": { - "type": { "name": "object" }, - "default": "{}", - "additionalInfo": { "slotsApi": true } - } - }, - "name": "HeatmapItem", - "imports": [ - "import { HeatmapItem } from '@mui/x-charts-pro/Heatmap';", - "import { HeatmapItem } from '@mui/x-charts-pro';" - ], - "slots": [ - { - "name": "cell", - "description": "The component that renders the heatmap cell.", - "default": "HeatmapCell", - "class": null - } - ], - "classes": [], - "muiName": "MuiHeatmapItem", - "filename": "/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx", - "inheritance": null, - "demos": "", - "cssComponent": false -} From ee39c3a3e7093b866b87e630abcf63832f0e5b18 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 2 Aug 2024 10:56:56 +0200 Subject: [PATCH 13/18] remove "not released" warnings --- docs/data/charts/heatmap/heatmap.md | 9 +-------- docs/data/charts/zoom-and-pan/zoom-and-pan.md | 9 +-------- 2 files changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/data/charts/heatmap/heatmap.md b/docs/data/charts/heatmap/heatmap.md index 94952e4f07c8e..f33f20a988aab 100644 --- a/docs/data/charts/heatmap/heatmap.md +++ b/docs/data/charts/heatmap/heatmap.md @@ -4,17 +4,10 @@ productId: x-charts components: Heatmap, HeatmapPlot, DefaultHeatmapTooltip --- -# Charts - Heatmap [](/x/introduction/licensing/#pro-plan 'Pro plan') 🚧 +# Charts - Heatmap [](/x/introduction/licensing/#pro-plan 'Pro plan')

Heatmap charts visually represents data with color variations to highlight patterns and trends across two dimensions.

-:::warning -The Heatmap Chart component is part of the pro package which is **not yet** released. - -You can test demos. -Don't hesitate to open issues to give feedback. -::: - ## Basics The Heatmap requires two axes with `data` properties. diff --git a/docs/data/charts/zoom-and-pan/zoom-and-pan.md b/docs/data/charts/zoom-and-pan/zoom-and-pan.md index 389b055de0999..4c2c5082cc153 100644 --- a/docs/data/charts/zoom-and-pan/zoom-and-pan.md +++ b/docs/data/charts/zoom-and-pan/zoom-and-pan.md @@ -4,17 +4,10 @@ productId: x-charts components: ScatterChartPro, BarChartPro, LineChartPro --- -# Zoom & Pan [](/x/introduction/licensing/#pro-plan 'Pro plan') 🚧 +# Zoom & Pan [](/x/introduction/licensing/#pro-plan 'Pro plan')

Enables zooming and panning on specific charts or axis.

-:::warning -The zoom feature is part of the pro package which is **not yet** released. - -You can test demos. -Don't hesitate to open issues to give feedback. -::: - Zooming is possible on the **Pro**[](/x/introduction/licensing/#pro-plan 'Pro plan') versions of the charts: ``, ``, ``. ## Basic usage From 4ef0e17014c7b367d60b4158a19a517ed726a491 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 2 Aug 2024 11:28:56 +0200 Subject: [PATCH 14/18] docs-api --- docs/pages/x/api/charts/bar-chart-pro.json | 2 +- docs/pages/x/api/charts/default-heatmap-tooltip.json | 2 +- docs/pages/x/api/charts/heatmap-plot.json | 2 +- docs/pages/x/api/charts/heatmap.json | 2 +- docs/pages/x/api/charts/line-chart-pro.json | 2 +- docs/pages/x/api/charts/scatter-chart-pro.json | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/pages/x/api/charts/bar-chart-pro.json b/docs/pages/x/api/charts/bar-chart-pro.json index 56b7b863b87c9..141bd308bd168 100644 --- a/docs/pages/x/api/charts/bar-chart-pro.json +++ b/docs/pages/x/api/charts/bar-chart-pro.json @@ -118,6 +118,6 @@ "muiName": "MuiBarChartPro", "filename": "/packages/x-charts-pro/src/BarChartPro/BarChartPro.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } diff --git a/docs/pages/x/api/charts/default-heatmap-tooltip.json b/docs/pages/x/api/charts/default-heatmap-tooltip.json index fc5ce2bb3c837..caa6575ad64ce 100644 --- a/docs/pages/x/api/charts/default-heatmap-tooltip.json +++ b/docs/pages/x/api/charts/default-heatmap-tooltip.json @@ -81,6 +81,6 @@ "muiName": "MuiDefaultHeatmapTooltip", "filename": "/packages/x-charts-pro/src/Heatmap/DefaultHeatmapTooltip.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } diff --git a/docs/pages/x/api/charts/heatmap-plot.json b/docs/pages/x/api/charts/heatmap-plot.json index 63eddc26e7d7a..e4f2afd00d550 100644 --- a/docs/pages/x/api/charts/heatmap-plot.json +++ b/docs/pages/x/api/charts/heatmap-plot.json @@ -16,6 +16,6 @@ "muiName": "MuiHeatmapPlot", "filename": "/packages/x-charts-pro/src/Heatmap/HeatmapPlot.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } diff --git a/docs/pages/x/api/charts/heatmap.json b/docs/pages/x/api/charts/heatmap.json index f75e599461c65..a80558e101165 100644 --- a/docs/pages/x/api/charts/heatmap.json +++ b/docs/pages/x/api/charts/heatmap.json @@ -118,6 +118,6 @@ "muiName": "MuiHeatmap", "filename": "/packages/x-charts-pro/src/Heatmap/Heatmap.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } diff --git a/docs/pages/x/api/charts/line-chart-pro.json b/docs/pages/x/api/charts/line-chart-pro.json index 112114368dc47..6b2c4e32e0460 100644 --- a/docs/pages/x/api/charts/line-chart-pro.json +++ b/docs/pages/x/api/charts/line-chart-pro.json @@ -111,6 +111,6 @@ "muiName": "MuiLineChartPro", "filename": "/packages/x-charts-pro/src/LineChartPro/LineChartPro.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } diff --git a/docs/pages/x/api/charts/scatter-chart-pro.json b/docs/pages/x/api/charts/scatter-chart-pro.json index 17da9ca377a69..f1b2cc769bf90 100644 --- a/docs/pages/x/api/charts/scatter-chart-pro.json +++ b/docs/pages/x/api/charts/scatter-chart-pro.json @@ -127,6 +127,6 @@ "muiName": "MuiScatterChartPro", "filename": "/packages/x-charts-pro/src/ScatterChartPro/ScatterChartPro.tsx", "inheritance": null, - "demos": "", + "demos": "", "cssComponent": false } From abe0b83e2bfe5e2ec192bfe135ce90e99b3f8085 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 2 Aug 2024 14:01:14 +0200 Subject: [PATCH 15/18] remove esm export from pro package.json --- packages/x-charts-pro/package.json | 14 +------------- packages/x-charts/package.json | 2 +- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/packages/x-charts-pro/package.json b/packages/x-charts-pro/package.json index 33a2818d2446c..28536720a38f9 100644 --- a/packages/x-charts-pro/package.json +++ b/packages/x-charts-pro/package.json @@ -3,7 +3,7 @@ "version": "7.0.0-alpha.0", "description": "The Pro plan edition of the Charts components (MUI X).", "author": "MUI Team", - "main": "./src/index.ts", + "main": "src/index.ts", "license": "SEE LICENSE IN LICENSE", "bugs": { "url": "https://github.com/mui/mui-x/issues" @@ -72,18 +72,6 @@ "csstype": "^3.1.3", "rimraf": "^5.0.9" }, - "exports": { - ".": { - "types": "./index.d.ts", - "import": "./esm/index.js", - "default": "./esm/index.js" - }, - "./*": { - "types": "./*/index.d.ts", - "import": "./esm/*/index.js", - "default": "./esm/*/index.js" - } - }, "engines": { "node": ">=14.0.0" } diff --git a/packages/x-charts/package.json b/packages/x-charts/package.json index 7ee9390fb6d0b..c6e011cbc4f23 100644 --- a/packages/x-charts/package.json +++ b/packages/x-charts/package.json @@ -3,7 +3,7 @@ "version": "7.12.0", "description": "The community edition of the Charts components (MUI X).", "author": "MUI Team", - "main": "./src/index.js", + "main": "src/index.js", "license": "MIT", "bugs": { "url": "https://github.com/mui/mui-x/issues" From 1283b6583fc9a6ce20de9dfd10fff0c088d20a93 Mon Sep 17 00:00:00 2001 From: Jose Quintas Date: Mon, 5 Aug 2024 16:05:52 +0200 Subject: [PATCH 16/18] Try increasing max-old-space-size --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ad0c4abefdf59..ebeb8d75a9402 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "typescript": "lerna run --no-bail --parallel typescript", "typescript:ci": "lerna run --concurrency 3 --no-bail --no-sort typescript", "use-react-version": "node scripts/useReactVersion.mjs", - "build:codesandbox": "pnpm release:build", + "build:codesandbox": "NODE_OPTIONS=--max-old-space-size=4096 pnpm release:build", "install:codesandbox": "pnpm install --no-frozen-lockfile", "release:changelog": "node scripts/releaseChangelog.mjs", "release:version": "lerna version --exact --no-changelog --no-push --no-git-tag-version --no-private", From 9e4e20cce6f436242276ecf35bd6139e0bc21cef Mon Sep 17 00:00:00 2001 From: Jose Quintas Date: Mon, 5 Aug 2024 16:14:09 +0200 Subject: [PATCH 17/18] Try codesandbox concurrency --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ebeb8d75a9402..b32ec0adcddb5 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "typescript": "lerna run --no-bail --parallel typescript", "typescript:ci": "lerna run --concurrency 3 --no-bail --no-sort typescript", "use-react-version": "node scripts/useReactVersion.mjs", - "build:codesandbox": "NODE_OPTIONS=--max-old-space-size=4096 pnpm release:build", + "build:codesandbox": "pnpm release:build --concurrency 3", "install:codesandbox": "pnpm install --no-frozen-lockfile", "release:changelog": "node scripts/releaseChangelog.mjs", "release:version": "lerna version --exact --no-changelog --no-push --no-git-tag-version --no-private", From 8b9ed6a3531cd91fa5f4110d1969d55b0cafceef Mon Sep 17 00:00:00 2001 From: Jose Quintas Date: Mon, 5 Aug 2024 16:27:45 +0200 Subject: [PATCH 18/18] actually use concurrency --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b32ec0adcddb5..8d00c1f5be0df 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "typescript": "lerna run --no-bail --parallel typescript", "typescript:ci": "lerna run --concurrency 3 --no-bail --no-sort typescript", "use-react-version": "node scripts/useReactVersion.mjs", - "build:codesandbox": "pnpm release:build --concurrency 3", + "build:codesandbox": "lerna run --concurrency 3 --no-private --scope \"@mui/*\" build", "install:codesandbox": "pnpm install --no-frozen-lockfile", "release:changelog": "node scripts/releaseChangelog.mjs", "release:version": "lerna version --exact --no-changelog --no-push --no-git-tag-version --no-private",