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

[charts][docs] Add docs for rounded symbol #15324

Merged
merged 5 commits into from
Nov 8, 2024

Conversation

GuillaumeMeheut
Copy link
Contributor

@GuillaumeMeheut GuillaumeMeheut commented Nov 7, 2024

@GuillaumeMeheut GuillaumeMeheut changed the title add docs for rounded symbol [charts][docs] Add docs for rounded symbol Nov 7, 2024
@mui-bot
Copy link

mui-bot commented Nov 7, 2024

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

Updated pages:

Generated by 🚫 dangerJS against 52dce22

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Nov 7, 2024
Copy link

codspeed-hq bot commented Nov 7, 2024

CodSpeed Performance Report

Merging #15324 will not alter performance

Comparing GuillaumeMeheut:add-docs-rounded-symbol (52dce22) with master (10cf25d)

Summary

✅ 3 untouched benchmarks

@oliviertassinari
Copy link
Member

I was worried that this wouldn't work on Safari https://developer.mozilla.org/en-US/docs/Web/CSS/ry#values

SCR-20241107-uegq

but this is wrong, fixing that in: mdn/browser-compat-data#24991.

Comment on lines 63 to 65
### Rounded symbol

To create a rounded symbol, use the `sx` prop to style the symbol class directly. Import `legendClasses.mark` to target the symbol, and set the `ry` property to control the symbol's corner radius.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### Rounded symbol
To create a rounded symbol, use the `sx` prop to style the symbol class directly. Import `legendClasses.mark` to target the symbol, and set the `ry` property to control the symbol's corner radius.
### Rounded symbol
To create a rounded symbol, use the `legendClasses.mark` to apply CSS on marks.
Notice that SVG `rect` uses `ry` property to control the symbol's corner radius instead of `border-radius`.

I propose to be more generic, because sx is not the only way we can pass CSS to the component

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@alexfauquette alexfauquette added cherry-pick The PR was cherry-picked from the newer alpha/beta/stable branch needs cherry-pick The PR should be cherry-picked to master after merge and removed cherry-pick The PR was cherry-picked from the newer alpha/beta/stable branch labels Nov 8, 2024
@alexfauquette alexfauquette merged commit 22e7cdf into mui:master Nov 8, 2024
24 checks passed
@GuillaumeMeheut GuillaumeMeheut deleted the add-docs-rounded-symbol branch November 8, 2024 10:04
@JCQuintas JCQuintas added v7.x needs cherry-pick The PR should be cherry-picked to master after merge and removed needs cherry-pick The PR should be cherry-picked to master after merge labels Nov 8, 2024
@JCQuintas
Copy link
Member

@michelengelen might be good to add an alternative way of cherrypicking if the PR was merged with the wrong tags 🙃

I would suggest some sort of behaviour using issue_comment:created maybe? Or also target pull_request_target:labelled, which would probably be easier to implement, because you dont need to parse the comment body 😆

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 needs cherry-pick The PR should be cherry-picked to master after merge v7.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[charts][docs] Charts legend rounded symbols
6 participants