Skip to content

Commit

Permalink
[docs] Explicitly mark charts pro as not released (#13905)
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Co-authored-by: Lukas Tyla <llukas.tyla@gmail.com>
  • Loading branch information
alexfauquette and LukasTy committed Jul 22, 2024
1 parent 8534f2d commit 257f174
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 9 deletions.
7 changes: 5 additions & 2 deletions docs/data/charts/heatmap/heatmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ productId: x-charts
components: Heatmap, HeatmapPlot, HeatmapItem, DefaultHeatmapTooltip
---

# Charts - Heatmap [<span class="plan-pro"></span>](/x/introduction/licensing/#pro-plan 'Pro plan')🚧
# Charts - Heatmap [<span class="plan-pro"></span>](/x/introduction/licensing/#pro-plan 'Pro plan') 🚧

<p class="description">Heatmap charts visually represents data with color variations to highlight patterns and trends across two dimensions.</p>

:::warning
The Heatmap Chart component isn't stable. Don't hesitate to open issues to give feedback.
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
Expand Down
9 changes: 8 additions & 1 deletion docs/data/charts/zoom-and-pan/zoom-and-pan.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ components: ScatterChartPro, BarChartPro, LineChartPro

<p class="description">Enables zooming and panning on specific charts or axis.</p>

:::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**[<span class="plan-pro"></span>](/x/introduction/licensing/#pro-plan 'Pro plan') versions of the charts: `<LineChartPro />`, `<BarChartPro />`, `<ScatterChartPro />`.

## Basic usage
Expand All @@ -26,7 +33,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.

Expand Down
9 changes: 7 additions & 2 deletions docs/data/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ const pages: MuiPage[] = [
pathname: '/x/react-charts/heatmap',
title: 'Heatmap',
plan: 'pro',
unstable: true,
planned: true,
},
{
pathname: '/x/react-charts/common-features',
Expand All @@ -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',
planned: true,
},
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/default-heatmap-tooltip.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@
"muiName": "MuiDefaultHeatmapTooltip",
"filename": "/packages/x-charts-pro/src/Heatmap/DefaultHeatmapTooltip.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a>🚧</a></li></ul>",
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a> 🚧</a></li></ul>",
"cssComponent": false
}
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/heatmap-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@
"muiName": "MuiHeatmapItem",
"filename": "/packages/x-charts-pro/src/Heatmap/HeatmapItem.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a>🚧</a></li></ul>",
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a> 🚧</a></li></ul>",
"cssComponent": false
}
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/heatmap-plot.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"muiName": "MuiHeatmapPlot",
"filename": "/packages/x-charts-pro/src/Heatmap/HeatmapPlot.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a>🚧</a></li></ul>",
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a> 🚧</a></li></ul>",
"cssComponent": false
}
2 changes: 1 addition & 1 deletion docs/pages/x/api/charts/heatmap.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,6 @@
"muiName": "MuiHeatmap",
"filename": "/packages/x-charts-pro/src/Heatmap/Heatmap.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a>🚧</a></li></ul>",
"demos": "<ul><li><a href=\"/x/react-charts/heatmap/\">Charts - Heatmap <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a> 🚧</a></li></ul>",
"cssComponent": false
}

0 comments on commit 257f174

Please sign in to comment.