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

[docs] Full documentation for React Router integration #4185

Merged

Conversation

apedroferreira
Copy link
Member

@apedroferreira apedroferreira commented Oct 4, 2024

Closes #4045
Closes #4149

Supporting Vite starter in create-toolpad-app will be done as a separate issue: #4235 (planned for v0.9.0)

@apedroferreira apedroferreira added the docs Improvements or additions to the documentation label Oct 4, 2024
@apedroferreira apedroferreira self-assigned this Oct 4, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 5, 2024
@Itamaram
Copy link

Itamaram commented Oct 6, 2024

While this is much needed and very appreciated, I believe this example would be more useful if it showcased integration with the new data api routers.

@apedroferreira
Copy link
Member Author

While this is much needed and very appreciated, I believe this example would be more useful if it showcased integration with the new data api routers.

Didn't know about those, thanks a lot! Will definitely use those instead in the examples.

@apedroferreira apedroferreira force-pushed the document-react-router-integration branch from db3b554 to 20166a5 Compare October 10, 2024 12:54
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 10, 2024
@apedroferreira apedroferreira marked this pull request as ready for review October 10, 2024 16:32
@apedroferreira apedroferreira requested a review from a team October 10, 2024 16:32
@apedroferreira apedroferreira changed the title Full documentation for React Router integration [docs] Full documentation for React Router integration Oct 10, 2024
@prakhargupta1
Copy link
Member

prakhargupta1 commented Oct 11, 2024

@Janpot
Copy link
Member

Janpot commented Oct 11, 2024

We could add a working example on the page? Should just work in an iframe with the browser router.

@apedroferreira

This comment was marked as outdated.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 13, 2024
@apedroferreira
Copy link
Member Author

apedroferreira commented Oct 14, 2024

We could add a working example on the page? Should just work in an iframe with the browser router.

I've been trying to do this with the Browser Router but our demo iframes have no src set which means they default to about:blank, there is no way to set an src unless we modify the Material UI repo component, and there seems to be no way to make the React Router work with about:blank as far as I've tried and looked.

So I guess we can just have an image instead of a live demo and users can just try out the Vite + React Router example themselves?

Or i guess we can try making src configurable in docs/src/modules/components/Demo.js... that might help be able to do this.

@Janpot
Copy link
Member

Janpot commented Oct 14, 2024

we could use the memory router?

@apedroferreira
Copy link
Member Author

we could use the memory router?

ok that should work

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 15, 2024
@apedroferreira
Copy link
Member Author

  • Added link to Vite example in examples grid
  • Fixed all Vite app examples as router configuration was not 100% correct
  • Updated docs and integration guide instructions to fit this configuration + use live example of Vite app instead of an image, as close as possible to the actual example app

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 16, 2024
@apedroferreira apedroferreira requested a review from Janpot October 16, 2024 12:42
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 16, 2024
@apedroferreira apedroferreira merged commit b0132c4 into mui:master Oct 16, 2024
14 checks passed
@apedroferreira apedroferreira deleted the document-react-router-integration branch October 16, 2024 14:13
@Gaen
Copy link

Gaen commented Oct 21, 2024

This is really helpful, thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation/Example for Vite and ReactRouter [docs] DashboardLayout add extended demo
6 participants