[charts][do not merge] Document how plugins can be used #19343
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview: https://deploy-preview-19343--material-ui-x.netlify.app/ Updated pages: Bundle size report
|
CodSpeed Performance ReportMerging #19343 will not alter performanceComparing Summary
|
JCQuintas
reviewed
Aug 26, 2025
| ``` | ||
|
|
||
| :::info | ||
| The code defines `noAxis` for the x and y-axes to override the default axes created by the `<ChartDataProvider />`. | ||
| This ensures that the pie is centered. | ||
| The `<ChartDataProvider />` get a prop [`plugins`](/x/react-charts/plugins). |
There was a problem hiding this comment.
Suggested change
| The `<ChartDataProvider />` get a prop [`plugins`](/x/react-charts/plugins). | |
| The `<ChartDataProvider />` accepts a [`plugins`](/x/react-charts/plugins) prop. |
|
|
||
| # Charts - Plugins | ||
|
|
||
| <p class="description">The library relies on two system to perform data processing: the plugins and the series config.</p> |
There was a problem hiding this comment.
Suggested change
| <p class="description">The library relies on two system to perform data processing: the plugins and the series config.</p> | |
| <p class="description">The library relies on two systems to perform data processing: the plugins and the series config.</p> |
Comment on lines
+12
to
+13
| Those information are for advanced use-cases. | ||
| The large majority of charts should not require touching either to the plugins or the series configuration. |
There was a problem hiding this comment.
Suggested change
| Those information are for advanced use-cases. | |
| The large majority of charts should not require touching either to the plugins or the series configuration. | |
| This information is for advanced use-cases. | |
| Most charts should not require changes to either the plugins or the series configuration. |
|
|
||
| ## Plugins | ||
|
|
||
| Plugins are function used to add features to the chart. |
There was a problem hiding this comment.
Suggested change
| Plugins are function used to add features to the chart. | |
| Plugins are functions used to add features to the chart. |
| ## Plugins | ||
|
|
||
| Plugins are function used to add features to the chart. | ||
| They can process data, add internal state, and listen to some event. |
There was a problem hiding this comment.
Suggested change
| They can process data, add internal state, and listen to some event. | |
| They can process data, add internal state, or listen to events. |
| Plugins can be passed to the `<ChartContainer />` or the `<ChartDataProvider />` with the `plugins` props. | ||
|
|
||
| :::info | ||
| Notice that `myChartPlugins` is defined of the component. |
There was a problem hiding this comment.
Suggested change
| Notice that `myChartPlugins` is defined of the component. | |
| Notice that `myChartPlugins` is defined outside of the component. |
|
|
||
| You can import plugins individually from `@mui/x-charts/plugins`. | ||
|
|
||
| When creating your custom array of plugins, be aware that some plugins have |
There was a problem hiding this comment.
Suggested change
| When creating your custom array of plugins, be aware that some plugins have | |
| When creating your custom array of plugins, be aware that some plugins have dependencies. |
Comment on lines
+76
to
+79
| ### Custom plugins | ||
|
|
||
| We discourage you from creating custom plugins. | ||
| To simplify further development, we consider their implementation as internal, allowing ourself to break their interfaces to add or improve features. |
There was a problem hiding this comment.
This paragraph doesn't make a lot of sense to me, what do we consider internal? Why are plugins discouraged?
Maybe put it in a warn block?
Suggested change
| ### Custom plugins | |
| We discourage you from creating custom plugins. | |
| To simplify further development, we consider their implementation as internal, allowing ourself to break their interfaces to add or improve features. | |
| ### Custom plugins | |
| :::warn | |
| Creating custom plugins is not encouraged. | |
| ::: | |
| The plugin's internal implementation is not considered stable. | |
| It can break at any time without a breaking change. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #18538
This is the documentation PR for