React Router API Reference
    Preparing search index...

    Module react-router

    react-router is the primary package in the React Router project.

    npm i react-router

    Components

    Form
    Await
    Meta
    Outlet
    Route
    Routes
    Scripts
    ScrollRestoration

    Data Routers

    DOMRouterOpts
    MemoryRouterOpts
    createBrowserRouter
    createHashRouter
    createMemoryRouter
    createStaticHandler
    createStaticRouter
    RouterProvider
    StaticRouterProvider

    Declarative Routers

    BrowserRouter
    HashRouter
    MemoryRouter
    Router
    StaticRouter
    unstable_HistoryRouter

    Framework Routers

    ServerRouter

    Hooks

    UNSAFE_useScrollRestoration
    unstable_usePrompt
    useActionData
    useAsyncError
    useAsyncValue
    useBeforeUnload
    useBlocker
    useFetcher
    useFetchers
    useFormAction
    useHref
    useInRouterContext
    useLinkClickHandler
    useLoaderData
    useLocation
    useMatch
    useMatches
    useNavigate
    useNavigation
    useNavigationType
    useOutlet
    useOutletContext
    useParams
    useResolvedPath
    useRevalidator
    useRouteError
    useRouteLoaderData
    useRoutes
    useSearchParams
    useSubmit
    useViewTransitionState

    Other

    dom
    UNSAFE_ServerMode
    UNSAFE_ErrorResponseImpl
    UNSAFE_RemixErrorBoundary
    ActionFunction
    ActionFunctionArgs
    AppLoadContext
    ClientOnErrorFunction
    CookieParseOptions
    CookieSerializeOptions
    CookieSignatureOptions
    DataRouteMatch
    DataRouter
    DataStrategyFunction
    DataStrategyFunctionArgs
    DataStrategyMatch
    DataStrategyResult
    EntryContext
    FetcherSubmitFunction
    FetcherSubmitOptions
    Future
    GetScrollPositionFunction
    GetScrollRestorationKeyFunction
    HandleDataRequestFunction
    HandleDocumentRequestFunction
    HandleErrorFunction
    HeadersFunction
    IndexRouteObject
    LazyRouteFunction
    LinksFunction
    LoaderFunctionArgs
    Location
    MetaArgs
    MetaFunction
    NonIndexRouteObject
    PageLinkDescriptor
    Path
    PathMatch
    PathPattern
    Register
    RouteMatch
    RouterContext
    RouterInit
    RouterState
    RouterSubscriber
    RoutesTestStubProps
    ServerBuild
    ServerEntryModule
    Session
    SessionData
    SessionIdStorageStrategy
    SessionStorage
    ShouldRevalidateFunction
    ShouldRevalidateFunctionArgs
    StaticHandler
    StaticHandlerContext
    SubmitFunction
    SubmitOptions
    UIMatch
    UNSAFE_AssetsManifest
    UNSAFE_DataWithResponseInit
    UNSAFE_RouteModules
    Blocker
    BlockerFunction
    ClientActionFunction
    ClientActionFunctionArgs
    ClientLoaderFunction
    ClientLoaderFunctionArgs
    CookieOptions
    CreateRequestHandlerFunction
    DataRouteObject
    DiscoverBehavior
    ErrorResponse
    Fetcher
    FetcherWithComponents
    FlashSessionData
    FormEncType
    FormMethod
    HeadersArgs
    HTMLFormMethod
    HtmlLinkDescriptor
    HydrationState
    InitialEntry
    IsCookieFunction
    IsSessionFunction
    LinkDescriptor
    LoaderFunction
    MetaDescriptor
    MiddlewareFunction
    ParamKeyValuePair
    ParamParseKey
    Params
    PatchRoutesOnNavigationFunction
    PatchRoutesOnNavigationFunctionArgs
    PathParam
    PrefetchBehavior
    RedirectFunction
    RelativeRoutingType
    RequestHandler
    RevalidationState
    RouteObject
    RouteProps
    RouterFetchOptions
    RouterNavigateOptions
    ScrollRestorationProps
    SetURLSearchParams
    SubmitTarget
    To
    UNSAFE_MiddlewareEnabled
    unstable_BrowserCreateFromReadableStreamFunction
    unstable_ClientInstrumentation
    unstable_DecodeActionFunction
    unstable_DecodeFormStateFunction
    unstable_DecodeReplyFunction
    unstable_EncodeReplyFunction
    unstable_InstrumentationHandlerResult
    unstable_InstrumentRequestHandlerFunction
    unstable_InstrumentRouteFunction
    unstable_InstrumentRouterFunction
    unstable_LoadServerActionFunction
    unstable_RSCManifestPayload
    unstable_RSCMatch
    unstable_RSCPayload
    unstable_RSCRenderPayload
    unstable_RSCRouteConfig
    unstable_RSCRouteConfigEntry
    unstable_RSCRouteManifest
    unstable_RSCRouteMatch
    unstable_SerializesTo
    unstable_ServerInstrumentation
    unstable_SSRCreateFromReadableStreamFunction
    URLSearchParamsInit
    createRequestHandler
    createSession
    IDLE_BLOCKER
    IDLE_FETCHER
    IDLE_NAVIGATION
    isCookie
    isSession
    UNSAFE_DataRouterContext
    UNSAFE_DataRouterStateContext
    UNSAFE_FetchersContext
    UNSAFE_FrameworkContext
    UNSAFE_hydrationRouteProperties
    UNSAFE_LocationContext
    UNSAFE_NavigationContext
    UNSAFE_RouteContext
    UNSAFE_SingleFetchRedirectSymbol
    UNSAFE_ViewTransitionContext
    unstable_matchRSCServerRequest
    createCookie
    createCookieSessionStorage
    createMemorySessionStorage
    createSessionStorage
    href
    UNSAFE_AwaitContextProvider
    UNSAFE_createBrowserHistory
    UNSAFE_createClientRoutes
    UNSAFE_createClientRoutesWithHMRRevalidationOptOut
    UNSAFE_createHashHistory
    UNSAFE_createMemoryHistory
    UNSAFE_createRouter
    UNSAFE_decodeViaTurboStream
    UNSAFE_deserializeErrors
    UNSAFE_getHydrationData
    UNSAFE_getPatchRoutesOnNavigationFunction
    UNSAFE_getTurboStreamSingleFetchDataStrategy
    UNSAFE_mapRouteProperties
    UNSAFE_RSCDefaultRootErrorBoundary
    UNSAFE_shouldHydrateRouteLoader
    UNSAFE_useFogOFWarDiscovery
    UNSAFE_withComponentProps
    UNSAFE_WithComponentProps
    UNSAFE_withErrorBoundaryProps
    UNSAFE_WithErrorBoundaryProps
    UNSAFE_withHydrateFallbackProps
    UNSAFE_WithHydrateFallbackProps
    unstable_setDevServerHooks
    unstable_useRoute

    RSC

    unstable_routeRSCServerRequest
    unstable_RSCStaticRouter

    Types

    AwaitProps
    BrowserRouterProps
    FetcherFormProps
    FormProps
    HashRouterProps
    HistoryRouterProps
    IndexRouteProps
    LayoutRouteProps
    LinkProps
    LinksProps
    MemoryRouterProps
    OutletProps
    PathRouteProps
    RouterProps
    RouterProviderProps
    RoutesProps
    ServerRouterProps
    StaticRouterProps
    StaticRouterProviderProps
    unstable_RSCHydratedRouterProps
    unstable_RSCStaticRouterProps
    ScriptsProps

    Utils

    RouterContextProvider
    createRoutesFromElements
    redirect
    redirectDocument
    replace
    createContext
    createPath
    createRoutesFromChildren
    createRoutesStub
    createSearchParams
    data
    generatePath
    isRouteErrorResponse
    matchPath
    matchRoutes
    parsePath
    renderMatches
    resolvePath

    Settings

    Member Visibility

    On This Page

    Installation
    Components
    Data Routers
    Declarative Routers
    Framework Routers
    Hooks
    Other
    domNavigationTypeUNSAFE_ServerModeUNSAFE_ErrorResponseImplUNSAFE_RemixErrorBoundaryActionFunctionActionFunctionArgsAppLoadContextClientOnErrorFunctionCookieCookieParseOptionsCookieSerializeOptionsCookieSignatureOptionsDataRouteMatchDataRouterDataStrategyFunctionDataStrategyFunctionArgsDataStrategyMatchDataStrategyResultEntryContextFetcherSubmitFunctionFetcherSubmitOptionsFutureGetScrollPositionFunctionGetScrollRestorationKeyFunctionHandleDataRequestFunctionHandleDocumentRequestFunctionHandleErrorFunctionHeadersFunctionIndexRouteObjectLazyRouteFunctionLinksFunctionLoaderFunctionArgsLocationMetaArgsMetaFunctionNavigateFunctionNavigateOptionsNavigatorNonIndexRouteObjectPageLinkDescriptorPathPathMatchPathPatternRegisterRouteMatchRouterContextRouterInitRouterStateRouterSubscriberRoutesTestStubPropsServerBuildServerEntryModuleSessionSessionDataSessionIdStorageStrategySessionStorageShouldRevalidateFunctionShouldRevalidateFunctionArgsStaticHandlerStaticHandlerContextSubmitFunctionSubmitOptionsUIMatchUNSAFE_AssetsManifestUNSAFE_DataWithResponseInitUNSAFE_RouteModulesBlockerBlockerFunctionClientActionFunctionClientActionFunctionArgsClientLoaderFunctionClientLoaderFunctionArgsCookieOptionsCreateRequestHandlerFunctionDataRouteObjectDiscoverBehaviorErrorResponseFetcherFetcherWithComponentsFlashSessionDataFormEncTypeFormMethodHeadersArgsHTMLFormMethodHtmlLinkDescriptorHydrationStateInitialEntryIsCookieFunctionIsSessionFunctionLinkDescriptorLoaderFunctionMetaDescriptorMiddlewareFunctionNavigationNavigationStatesNavLinkRenderPropsParamKeyValuePairParamParseKeyParamsPatchRoutesOnNavigationFunctionPatchRoutesOnNavigationFunctionArgsPathParamPrefetchBehaviorRedirectFunctionRelativeRoutingTypeRequestHandlerRevalidationStateRouteObjectRoutePropsRouterFetchOptionsRouterNavigateOptionsScrollRestorationPropsSetURLSearchParamsSubmitTargetToUNSAFE_MiddlewareEnabledunstable_BrowserCreateFromReadableStreamFunctionunstable_ClientInstrumentationunstable_DecodeActionFunctionunstable_DecodeFormStateFunctionunstable_DecodeReplyFunctionunstable_EncodeReplyFunctionunstable_InstrumentationHandlerResultunstable_InstrumentRequestHandlerFunctionunstable_InstrumentRouteFunctionunstable_InstrumentRouterFunctionunstable_LoadServerActionFunctionunstable_RSCManifestPayloadunstable_RSCMatchunstable_RSCPayloadunstable_RSCRenderPayloadunstable_RSCRouteConfigunstable_RSCRouteConfigEntryunstable_RSCRouteManifestunstable_RSCRouteMatchunstable_SerializesTounstable_ServerInstrumentationunstable_SSRCreateFromReadableStreamFunctionURLSearchParamsInitcreateRequestHandlercreateSessionIDLE_BLOCKERIDLE_FETCHERIDLE_NAVIGATIONisCookieisSessionUNSAFE_DataRouterContextUNSAFE_DataRouterStateContextUNSAFE_FetchersContextUNSAFE_FrameworkContextUNSAFE_hydrationRoutePropertiesUNSAFE_LocationContextUNSAFE_NavigationContextUNSAFE_RouteContextUNSAFE_SingleFetchRedirectSymbolUNSAFE_ViewTransitionContextunstable_matchRSCServerRequestcreateCookiecreateCookieSessionStoragecreateMemorySessionStoragecreateSessionStoragehrefUNSAFE_AwaitContextProviderUNSAFE_createBrowserHistoryUNSAFE_createClientRoutesUNSAFE_createClientRoutesWithHMRRevalidationOptOutUNSAFE_createHashHistoryUNSAFE_createMemoryHistoryUNSAFE_createRouterUNSAFE_decodeViaTurboStreamUNSAFE_deserializeErrorsUNSAFE_getHydrationDataUNSAFE_getPatchRoutesOnNavigationFunctionUNSAFE_getTurboStreamSingleFetchDataStrategyUNSAFE_mapRoutePropertiesUNSAFE_RSCDefaultRootErrorBoundaryUNSAFE_shouldHydrateRouteLoaderUNSAFE_useFogOFWarDiscoveryUNSAFE_withComponentPropsUNSAFE_WithComponentPropsUNSAFE_withErrorBoundaryPropsUNSAFE_WithErrorBoundaryPropsUNSAFE_withHydrateFallbackPropsUNSAFE_WithHydrateFallbackPropsunstable_setDevServerHooksunstable_useRoute
    RSC
    Types
    Utils