React Router API Reference
    Preparing search index...

    Function Router

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

      Parameters

      • props: RouterProps

        Props

        • Optionalbasename?: string

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

        • Optionalchildren?: ReactNode

          Nested Route elements describing the route tree

        • location: string | Partial<Location<any>>

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

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

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

        • Optionalstatic?: boolean

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

        • Optionalunstable_useTransitions?: boolean

          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.

      Returns null | ReactElement<any, string | JSXElementConstructor<any>>

      React element for the rendered router or null if the location does not match the props.basename

      declarative