Skip to content

[AppProvider] Use unique names for framework specific AppProviders#4553

Merged
apedroferreira merged 15 commits intomui:masterfrom
apedroferreira:different-app-provider-names
Jan 7, 2025
Merged

[AppProvider] Use unique names for framework specific AppProviders#4553
apedroferreira merged 15 commits intomui:masterfrom
apedroferreira:different-app-provider-names

Conversation

@apedroferreira
Copy link
Collaborator

@apedroferreira apedroferreira commented Dec 23, 2024

Closes #4319 and #4508

  • Rename framework specific AppProvider components to NextAppProvider and ReactRouterAppProvider (important breaking changes).
  • Update usage of react-router-dom to the latest version of react-router.
  • Update docs and scripts according to these changes.

https://deploy-preview-4553--mui-toolpad-docs.netlify.app/toolpad/core/react-app-provider/
https://deploy-preview-4553--mui-toolpad-docs.netlify.app/toolpad/core/api/app-provider/

@apedroferreira apedroferreira self-assigned this Dec 23, 2024
@apedroferreira apedroferreira added scope: toolpad-core Abbreviated to "core" internal Behind-the-scenes enhancement. Formerly called “core”. type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature. labels Dec 23, 2024
@apedroferreira apedroferreira marked this pull request as ready for review December 23, 2024 17:35
@apedroferreira apedroferreira changed the title Use unique names for integration-specific app providers [AppProvider] Use unique names for framework specific AppProviders Dec 23, 2024
Copy link
Collaborator

@bharatkashyap bharatkashyap left a comment

Choose a reason for hiding this comment

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

Looks good! Vale warnings/errors need fixing.

Suggestions:

  1. Should we change the AppProvider imports on the Integration docs to be the framework specific AppProviders?: https://mui.com/toolpad/core/integrations/nextjs-approuter/

  2. Do we need some callouts on the docs talking about this breaking change? A warning callout on the app-provider.md page talking about this change could be useful to link if someone runs into this issue with existing apps.

@apedroferreira
Copy link
Collaborator Author

apedroferreira commented Jan 6, 2025

This was already in the changes I think.
I've added deprecation warnings as we discussed + addressed the Vale warnings!

@mui-bot
Copy link

mui-bot commented Jan 6, 2025

Netlify deploy preview

https://deploy-preview-4553--mui-toolpad-docs.netlify.app/

Generated by 🚫 dangerJS against c30a0ae

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Jan 6, 2025
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Jan 7, 2025
@apedroferreira apedroferreira merged commit 47e55ed into mui:master Jan 7, 2025
@apedroferreira apedroferreira deleted the different-app-provider-names branch January 7, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Behind-the-scenes enhancement. Formerly called “core”. scope: toolpad-core Abbreviated to "core" type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RFC] Rename AppProvider export for Next.js and react-router integrations

3 participants