[docs] Revise the Charts Custom Components doc #19793

mapache-salvaje · 2025-10-02T14:40:10Z

No description provided.

mui-bot · 2025-10-02T14:41:56Z

Deploy preview: https://deploy-preview-19793--material-ui-x.netlify.app/

Updated pages:

Bundle size report

Bundle	Parsed size	Gzip size
@mui/x-data-grid	0B^(0.00%)	0B^(0.00%)
@mui/x-data-grid-pro	0B^(0.00%)	0B^(0.00%)
@mui/x-data-grid-premium	0B^(0.00%)	0B^(0.00%)
@mui/x-charts	0B^(0.00%)	0B^(0.00%)
@mui/x-charts-pro	0B^(0.00%)	0B^(0.00%)
@mui/x-charts-premium	0B^(0.00%)	0B^(0.00%)
@mui/x-date-pickers	0B^(0.00%)	0B^(0.00%)
@mui/x-date-pickers-pro	0B^(0.00%)	0B^(0.00%)
@mui/x-tree-view	0B^(0.00%)	0B^(0.00%)
@mui/x-tree-view-pro	0B^(0.00%)	0B^(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against 9c74f51

codspeed-hq · 2025-10-02T14:56:18Z

CodSpeed Performance Report

Merging #19793 will not alter performance

_{Comparing mapache-salvaje:feature/dx-45-revise-the-charts-custom-components-doc (4c8a5d3) with master (75b09d6)}

Summary

✅ 13 untouched

alexfauquette

I took advantage of this PR to spot few sentences we forgot to updat efrom one major to another 🫣

docs/data/charts/components/components.md

Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>

…ponents-doc

alexfauquette · 2025-10-21T07:16:35Z

docs/data/charts/components/components.md


- `height` and `width` for the `<svg />` size. If not provided, those values are derived from the container.
- `margin` for adding space between the `<svg />` border and the **drawing area**.
+- `height` and `width` for the SVG size; if not provided, these values are derived from the container


Maybe easier by avoiding details

Suggested change

- `height` and `width` for the SVG size; if not provided, these values are derived from the container

- `height` and `width` for the SVG size

docs/data/charts/components/components.md

JCQuintas · 2025-10-22T11:04:31Z

docs/data/charts/components/components.md


-Series information is accessible through the `useSeries` hook for all series types, and `useXxxSeries` hook for a specific series type.
-These hooks return the order of the series and their configuration, including data points, color, among others.
+Series information is accessible through the `useSeries()` hook for all series types, and the `useXxxSeries()` hook for a specific series type.


@mui/xcharts I believe we started using use*Series from the discussion here: #19334 (comment)

Suggested change

Series information is accessible through the `useSeries()` hook for all series types, and the `useXxxSeries()` hook for a specific series type.

Series information is accessible through the `useSeries()` hook for all series types, and the `use*Series()` hook for a specific series type.

I missed this comment. For me use*Series() is not intuitive. It looks more like a typo than a place to fill with other values.

The page below adds context to what this is though, in that use-case at least 🤔
In the current use case we might want to add like useBarSeries for example

That's maybe cultural, but for me stars are for stuff like sx, f**k, sht, ...

I would prefer one of those options.

use***Series() to specify "there are multiple characters missing"

useXxxSeries() to specify "there are a caml case word"

use[Type]Series() to specify the mining of the missing world

Whatever the one we pick, we should modify

mui-x/docs/data/charts/composition/composition.md

Line 172 in 292e5f5

To display data, you have components named `<XxxPlot />` such as `<LinePlot />`, `<AreaPlot />`, `<MarkPlot />`, `<BarPlot />`, etc.

mui-x/docs/data/migration/migration-charts-v7/migration-charts-v7.md

Line 382 in 292e5f5

## Stabilize `useSeries` and `useXxxSeries` hooks ✅

mui-x/docs/data/charts/components/components.md

Line 82 in 292e5f5

Series information is accessible through the `useSeries` hook for all series types, and `useXxxSeries` hook for a specific series type.

mui-x/docs/data/charts/hooks/use-series.md

Line 10 in 292e5f5

The `use*Series` hooks provide access to specific series data for a particular chart type.

use[Type]Series() - I think I like this one best because it seems most obvious to me that the text in brackets needs to be replaced. What about use[Chart]Series() instead? In my mind, that makes it immediately clear to me that I can sub in Bar, Line, etc. there.

I'm also fine with adding a parenthetical on first mention: "...the use[Chart]Series() hook (for example, useBarSeries())..."

Wouldn't use[Chart]Series cause confusion? We have a lot of useChart stuff 😆

Fair point - let's go with use[Type]Series() then

Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>

github-actions · 2025-11-30T15:07:05Z

This pull request has been inactive for 30 days. Please remove the stale label or leave a comment to keep it open. Otherwise, it will be closed in 15 days.

alexfauquette

@JCQuintas Can I let you check the few remaining suggestion I left.

Other than that it looks good to me.

I updated the page to folow the new naming convention Component instead of <Component> or <Component />

docs/data/charts/components/components.md

…ponents-doc

mapache-salvaje · 2025-12-04T15:26:28Z

Thanks for reviving this @alexfauquette ! I just did one final pass and I'm happy with it now. 👍

Signed-off-by: mapache-salvaje <[email protected]> Co-authored-by: Alexandre Fauquette <[email protected]> Co-authored-by: alex <[email protected]>

mapache-salvaje added 2 commits October 2, 2025 07:39

initializing

10ce31c

componenenents

9ecb3df

mapache-salvaje added docs Improvements or additions to the documentation. type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature. scope: charts Changes related to the charts. labels Oct 2, 2025

first pass

ba0da9e

alexfauquette reviewed Oct 9, 2025

View reviewed changes

docs/data/charts/components/components.md Outdated Show resolved Hide resolved

docs/data/charts/components/components.md Outdated Show resolved Hide resolved

mapache-salvaje and others added 4 commits October 20, 2025 07:00

Apply suggestions from code review

2964895

Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>

Merge branch 'master' into feature/dx-45-revise-the-charts-custom-com…

d2d1eb2

…ponents-doc

full pass

afc8890

Merge branch 'master' into feature/dx-45-revise-the-charts-custom-com…

dc3b62e

…ponents-doc

mapache-salvaje marked this pull request as ready for review October 20, 2025 14:37

mapache-salvaje requested review from JCQuintas, bernardobelchior and prakhargupta1 as code owners October 20, 2025 14:37

alexfauquette reviewed Oct 21, 2025

View reviewed changes

JCQuintas reviewed Oct 22, 2025

View reviewed changes

Update docs/data/charts/components/components.md

bdcf41a

Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>

github-actions bot added the stale Inactive for 7 days (issues) or 30 days (PRs); closed after 5 or 15 more days if no update. label Nov 30, 2025

updates

917d0a8

alexfauquette approved these changes Dec 1, 2025

View reviewed changes

docs/data/charts/components/components.md Outdated Show resolved Hide resolved

refinements

8377aa6

github-actions bot removed the stale Inactive for 7 days (issues) or 30 days (PRs); closed after 5 or 15 more days if no update. label Dec 1, 2025

mapache-salvaje and others added 2 commits December 4, 2025 07:25

one more pass

4c8a5d3

Merge branch 'master' into feature/dx-45-revise-the-charts-custom-com…

9c74f51

…ponents-doc

alexfauquette enabled auto-merge (squash) December 4, 2025 15:35

alexfauquette merged commit 5405d77 into mui:master Dec 4, 2025
22 checks passed

	- `height` and `width` for the SVG size; if not provided, these values are derived from the container
	- `height` and `width` for the SVG size

	Series information is accessible through the `useSeries()` hook for all series types, and the `useXxxSeries()` hook for a specific series type.
	Series information is accessible through the `useSeries()` hook for all series types, and the `use*Series()` hook for a specific series type.

Uh oh!

[docs] Revise the Charts Custom Components doc #19793

[docs] Revise the Charts Custom Components doc #19793

Uh oh!

Conversation

mapache-salvaje commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mui-bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle size report

Uh oh!

codspeed-hq bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging #19793 will not alter performance

Summary

Uh oh!

alexfauquette left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 30, 2025

Uh oh!

alexfauquette left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mapache-salvaje commented Dec 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mapache-salvaje commented Oct 2, 2025 •

edited

Loading

mui-bot commented Oct 2, 2025 •

edited

Loading

codspeed-hq bot commented Oct 2, 2025 •

edited

Loading