React Router API Reference
    Preparing search index...

    Interface RouterProps

    interface RouterProps {
        basename?: string;
        children?: ReactNode;
        location: string | Partial<Location<any>>;
        navigationType?: NavigationType;
        navigator: Navigator;
        static?: boolean;
        unstable_useTransitions?: boolean;
    }
    Index

    Properties

    basename?: string

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

    children?: 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.

    navigationType?: NavigationType

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

    navigator: Navigator

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

    static?: boolean

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

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