[docs] Add charts migration guide #15276
Conversation
alexfauquette
added
docs
|
Deploy preview: https://deploy-preview-15276--material-ui-x.netlify.app/ Updated pages: |
CodSpeed Performance ReportMerging #15276 will not alter performanceComparing Summary
|
| Some properties got deprecated in v7 in favor of a more consistent naming convention. | ||
| Those deprecated properties got removed in v8. | ||
|
|
||
| The impacted properties are: | ||
|
|
||
| - The `xAxisKey`, `yAxisKey`, and `zAxisKey` are renamed `xAxisId`, `yAxisId`, and `zAxisId`. | ||
| - The `highlighted` and `faded` properties of `series.highlightScope` are renamed `highlight` and `fade`. |
There was a problem hiding this comment.
There is no codemod for this yet right?
There was a problem hiding this comment.
Yes, because I assume few people do
<LineChart
series={[{ data: [ ... ], xAxisKey: 'axis1', highlightScope: { highlight: 'series' } }]}
/>In our realistic demo we always move those information in distinct part, like
const highlightScope = { highlight: 'series' };
<LineChart
series={[{ data: [ ... ], xAxisKey: 'axis1', highlightScope }]}
/>
// or even
const series= [
{ ...}
].map(...)
<LineChart
series={series}
{ /* ... */ }
/>
| ## Remove Pie Chart axes | ||
|
|
||
| The `<PieChart />` got by error the code to render axes. | ||
| This code is removed in v8, which implies removing the following props: `axisHighlight`, `topAxis`, `rightAxis`, `bottomAxis`, and `leftAxis`. |
There was a problem hiding this comment.
Yes, for this one I assume nobody used those
|
Should @samuelsycamore review these? 🤔 |
Yes, but we could merge before the release such that use get the information everywhere (the changelog and migration docs) This page will evolve a lot in the coming month since every breaking change PR will add something. |
Document
legendprops #15081xAxisKey,yAxisKey, andzAxisKey#15192