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] Explain how to clip plots with composition #12679

Merged
merged 5 commits into from Apr 5, 2024

Conversation

alexfauquette
Copy link
Member

Fix #12506

@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 Apr 4, 2024
@mui-bot
Copy link

mui-bot commented Apr 4, 2024

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

Updated pages:

Generated by 🚫 dangerJS against 166fcdc

Copy link
Member

@michelengelen michelengelen left a comment

Choose a reason for hiding this comment

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

please feel free to ignore my suggestions. I noticed that I basically rewrote the whole text! 😵 🙇🏼

docs/data/charts/composition/composition.md Outdated Show resolved Hide resolved
docs/data/charts/composition/composition.md Outdated Show resolved Hide resolved
docs/data/charts/composition/composition.md Outdated Show resolved Hide resolved
alexfauquette and others added 2 commits April 4, 2024 16:43
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Co-authored-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com>
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Co-authored-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
@@ -105,6 +105,41 @@ The order of elements in composition is the only way to define how they overlap.

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

### Clipping

To ensure chart elements stay confined to the designated drawing area, leverage the `ChartsClipPath` component.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe that's just me, but leverage is not a super common word and we don't use it a lot.
Since we target an international audience, sticking to simple (boring 😆 ) words when they don't loose any subtlety to the sentence might be better.

I would stick to the good old "you can use" here.

Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
@alexfauquette alexfauquette enabled auto-merge (squash) April 5, 2024 11:50
@alexfauquette alexfauquette merged commit 00b0415 into mui:master Apr 5, 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] How to avoid component overflow when using composition
5 participants