javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: document IonReactRouter usage with BrowserRouter

Browse Source
This commit is contained in:
Sean Perkins
2023-06-30 16:11:43 -04:00
parent 7236dabdce
commit 7d8204a0a7
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/react-router/src/ReactRouter/IonReactRouter.tsx
View File

@@ -9,9 +9,11 @@ import { IonRouter } from './IonRouter';
* Wrapper around react-router-dom's BrowserRouter that provides a context for IonRouterOutlet.
* Ionic developers should use IonReactRouter instead of BrowserRouter when using React Router.
*/
export function IonReactRouter({ children, ...props }: PropsWithChildren<BrowserRouterProps>) {
export function IonReactRouter({ children }: PropsWithChildren<BrowserRouterProps>) {
// BrowserRouter is used so that the route state is kept in sync with the browser history.
// This reflects the current route in the URL.
return (
<BrowserRouter {...props}>
<BrowserRouter>
<IonRouter>{children}</IonRouter>
</BrowserRouter>
);