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

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

apedroferreira
Copy link
Member

@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" core Infrastructure work going on behind the scenes enhancement This is not a bug, nor 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
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes enhancement This is not a bug, nor a new feature scope: toolpad-core Abbreviated to "core"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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