Router

Declarative

Summary

Reference Documentation ↗

Provides location context for the rest of the app.

Note: You usually won't render a <Router> directly. Instead, you'll render a router that is more specific to your environment such as a BrowserRouter in web browsers or a ServerRouter for server rendering.

Signature

function Router({
  basename: basenameProp = "/",
  children = null,
  location: locationProp,
  navigationType = NavigationType.Pop,
  navigator,
  static: staticProp = false,
  useTransitions,
}: RouterProps): React.ReactElement | null

Props

basename

The base path for the application. This is prepended to all locations

children

Nested Route elements describing the route tree

location

The location to match against. Defaults to the current location. This can be a string or a Location object.

navigationType

The type of navigation that triggered this location change. Defaults to NavigationType.Pop.

navigator

The navigator to use for navigation. This is usually a history object or a custom navigator that implements the Navigator interface.

static

Whether this router is static or not (used for SSR). If true, the router will not be reactive to location changes.

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.