Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Make the Charts margin usage more visible #12591

Merged
merged 4 commits into from Apr 4, 2024

Conversation

alexfauquette
Copy link
Member

Fix #12551

@alexfauquette alexfauquette added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Mar 28, 2024
@mui-bot
Copy link

mui-bot commented Mar 28, 2024

@alexfauquette alexfauquette marked this pull request as ready for review March 29, 2024 10:57
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition! 👏

Nitpick: Have you considered adding a toggle to the added demo to display the problem without the necessary tweaks? Basically, to allow users to better visualize what the applied changes fix. 🤔

P.S. I took the liberty to update the PR prefix to docs instead of charts as it doesn't impact the package itself. 🤔

docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
@LukasTy LukasTy changed the title [charts] Make the margin usage more visible [docs] Make the Charts margin usage more visible Apr 3, 2024
);
}

const usAirportPassengers = [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: as this package grows and the demos get more we should think about extracting demo data to a function as in the grid (useDemoData). WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's planed for real world data.

But I expect using the mui/material-ui#40901 instead of a package,

docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
docs/data/charts/axis/axis.md Outdated Show resolved Hide resolved
docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
docs/data/charts/getting-started/getting-started.md Outdated Show resolved Hide resolved
alexfauquette and others added 2 commits April 4, 2024 11:06
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Co-authored-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com>
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
@alexfauquette alexfauquette merged commit 38022a0 into mui:master Apr 4, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: charts This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[charts] Document the usage of margin in the axis page
4 participants