[charts] Document plugins for internal use #16504
Merged
Conversation
This file contains 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
JCQuintas
added
enhancement
JCQuintas
requested review from
flaviendelangle,
LukasTy,
bernardobelchior,
alexfauquette and
noraleonte
|
Deploy preview: https://deploy-preview-16504--material-ui-x.netlify.app/ |
CodSpeed Performance ReportMerging #16504 will not alter performanceComparing Summary
|
| @@ -5,12 +5,34 @@ import { ChartStore } from '../utils/ChartStore'; | |||
| import { ChartSeriesConfig } from './seriesConfig'; | |||
|
|
|||
| export interface ChartPluginOptions<TSignature extends ChartAnyPluginSignature> { | |||
| /** | |||
There was a problem hiding this comment.
If you can add those to the tree view after this PR is approved it would be awesome 🙏
LukasTy
approved these changes
Feb 10, 2025
alexfauquette
approved these changes
Feb 10, 2025
Co-authored-by: Alexandre Fauquette <[email protected]> Co-authored-by: Lukas Tyla <[email protected]> Signed-off-by: Jose C Quintas Jr <[email protected]>
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.
Hi @mui/explore,
I've added some docs to the charts
pluginsystem to be easier to understand.The goal is that we can leverage the types to understand what each property does.
@alexfauquette mentioned you might be interested in fact-checking and paste-copying it to other libs where the plugin is used.
Best regards,
Jose & The X-Charts.