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] Remove export of context providers #12123

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Feb 18, 2024

Per

skipComponent(filename) {
if (filename.includes('/context/')) {
return true;
}

I assume we didn't want to export them.


Off-topic. On that mui-x/scripts/buildApiDocs/chartsSettings/index.ts file, I suspect we could have default values provided by docs-infra.

Changelog

Breaking changes

Those components are not longer exported by @mui/x-charts:

  • CartesianContextProvider
  • DrawingProvider

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Feb 18, 2024
@mui-bot
Copy link

mui-bot commented Feb 18, 2024

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

Updated pages:

Generated by 🚫 dangerJS against f631197

@alexfauquette
Copy link
Member

I assume we didn't want to export them.

Yes, at the beginning I had this question about how fine should we allow users to pick what they want. But appears do not be usefull

@alexfauquette alexfauquette merged commit 63fca91 into mui:next Feb 20, 2024
17 checks passed
@LukasTy
Copy link
Member

LukasTy commented Feb 20, 2024

Nitpick: IMHO, it would make sense to highlight this BC in the changelog. 😉

@oliviertassinari oliviertassinari deleted the remove-export-context-provider-api branch February 20, 2024 12:30
@alexfauquette
Copy link
Member

Nitpick: IMHO, it would make sense to highlight this BC in the changelog. 😉

In the changelog maybe. But probably not in the migration guide, it would be more confusing than helpfull

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change bug 🐛 Something doesn't work component: charts This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation v7.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants