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] Add reference links to shared/misc chart components #10660

Merged
merged 9 commits into from
Oct 27, 2023

Conversation

michelengelen
Copy link
Member


This adds Demo and API links to the component annotation for ...

  • CartesianContextProvider
  • ChartsAxis
  • ChartsXAxis
  • ChartsYAxis
  • DrawingProvider
  • ChartsTooltip
  • ChartsClipPath
  • ChartsAxisHighlight
    ... components

It's part of a series to solve #9226

@michelengelen michelengelen added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Oct 12, 2023
@michelengelen michelengelen requested a review from a team October 12, 2023 14:21
@michelengelen michelengelen self-assigned this Oct 12, 2023
@mui-bot
Copy link

mui-bot commented Oct 12, 2023

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

Generated by 🚫 dangerJS against ec830bd

@michelengelen michelengelen changed the title [docs] Add reference links to shared/misc picker components [charts] Add reference links to shared/misc chart components Oct 13, 2023
Comment on lines 91 to 94
* - [Bars demonstration](https://mui.com/x/react-charts/bar-demo/)
* - [Lines demonstration](https://mui.com/x/react-charts/line-demo/)
* - [Area demonstration](https://mui.com/x/react-charts/area-demo/)
* - [Pie demonstration](https://mui.com/x/react-charts/pie-demo/)
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
* - [Bars demonstration](https://mui.com/x/react-charts/bar-demo/)
* - [Lines demonstration](https://mui.com/x/react-charts/line-demo/)
* - [Area demonstration](https://mui.com/x/react-charts/area-demo/)
* - [Pie demonstration](https://mui.com/x/react-charts/pie-demo/)
* - [Bars demonstration](https://mui.com/x/react-charts/bars/)
* - [Lines demonstration](https://mui.com/x/react-charts/lines/)
* - [Pie demonstration](https://mui.com/x/react-charts/pie/)

Copy link
Member

Choose a reason for hiding this comment

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

I tend to think it's better to link people chare their is some explanation. But might be wrong

/**
* API:
*
* - [DrawingProvider API](https://mui.com/x/api/charts/drawing-provider/)
Copy link
Member

Choose a reason for hiding this comment

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

Why not, but there is a lot to do for those pages to be readable 🫣

Copy link
Member Author

Choose a reason for hiding this comment

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

I know ... but we have it in place once its ready, aye? 🏴‍☠️

Copy link
Member

Choose a reason for hiding this comment

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

Ho yes, I agree with putting them. it was more to be sure you're also aware about it :)

@alexfauquette alexfauquette merged commit 5c00016 into mui:master Oct 27, 2023
18 checks passed
alexfauquette pushed a commit to alexfauquette/mui-x that referenced this pull request Nov 6, 2023
@michelengelen michelengelen deleted the 9226/charts-shared branch November 9, 2023 14:50
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.

None yet

3 participants