Back to React Router

MemoryRouter

docs/api/declarative-routers/MemoryRouter.md

7.6.21.7 KB
Original Source

MemoryRouter

<!-- ⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ Thank you for helping improve our documentation! This file is auto-generated from the JSDoc comments in the source code, so please edit the JSDoc comments in the file below and this file will be re-generated once those changes are merged. https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx -->

[MODES: declarative]

Summary

Reference Documentation ↗

A declarative <Router> that stores all entries in memory.

Signature

tsx
function MemoryRouter({
  basename,
  children,
  initialEntries,
  initialIndex,
  unstable_useTransitions,
}: MemoryRouterProps): React.ReactElement

Props

basename

Application basename

children

Nested Route elements describing the route tree

initialEntries

Initial entries in the in-memory history stack

initialIndex

Index of initialEntries the application should initialize to

unstable_useTransitions

Control whether router state updates are internally wrapped in React.startTransition.

  • When left undefined, all router state updates are wrapped in React.startTransition
  • When set to true, Link and Form navigations will be wrapped in React.startTransition and all router state updates are wrapped in React.startTransition
  • When set to false, the router will not leverage React.startTransition on any navigations or state changes.

For more information, please see the docs.