en
Branches
latest (6.27.0)
dev
Versions
6.27.0
v4/5.x
v3.x
Light
Dark
System
BrowserRouterProps
react-router
Select a package
react-router
@react-router/dev
@react-router/express
@react-router/fs-routes
@react-router/node
@react-router/remix-config-routes-adapter
Routers
createBrowserRouter
createHashRouter
createMemoryRouter
createStaticRouter
Router Components
BrowserRouter
HashRouter
MemoryRouter
StaticRouter
StaticRouterProvider
HistoryRouter
Components
Await
Form
Link
Links
Meta
NavLink
Navigate
Outlet
PrefetchPageLinks
Route
Router
Routes
Scripts
ScrollRestoration
ServerRouter
Hooks
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
Utils
createPath
createRoutesFromChildren
createRoutesStub
createSearchParams
createStaticHandler
data
generatePath
isRouteErrorResponse
json
matchPath
matchRoutes
parsePath
redirect
redirectDocument
renderMatches
replace
resolvePath
Types
AwaitProps
BrowserRouterProps
FetcherFormProps
FormProps
HashRouterProps
HistoryRouterProps
IndexRouteProps
LayoutRouteProps
LinkProps
MemoryRouterProps
NavLinkProps
NavigateProps
OutletProps
PathRouteProps
RouterProps
RoutesProps
ScriptsProps
Other
createRoutesFromElements
ActionFunction
ActionFunctionArgs
AppLoadContext
Cookie
CookieParseOptions
CookieSerializeOptions
CookieSignatureOptions
DataRouteMatch
DataStrategyFunction
DataStrategyFunctionArgs
DataStrategyMatch
DataStrategyResult
EntryContext
FetcherSubmitFunction
FetcherSubmitOptions
GetScrollPositionFunction
GetScrollRestorationKeyFunction
HandleDataRequestFunction
HandleDocumentRequestFunction
HandleErrorFunction
HeadersFunction
IndexRouteObject
LazyRouteFunction
LinksFunction
LoaderFunctionArgs
Location
MetaArgs
MetaFunction
NavigateFunction
NavigateOptions
Navigator
NonIndexRouteObject
PageLinkDescriptor
Path
PathMatch
PathPattern
Router
RouteMatch
RouterInit
RouterProviderProps
RouterState
RouterSubscriber
RoutesTestStubProps
ServerBuild
ServerEntryModule
ServerRouterProps
Session
SessionData
SessionIdStorageStrategy
SessionStorage
ShouldRevalidateFunction
ShouldRevalidateFunctionArgs
StaticHandler
StaticHandlerContext
StaticRouterProps
StaticRouterProviderProps
SubmitFunction
SubmitOptions
UIMatch
Blocker
BlockerFunction
ClientActionFunction
ClientActionFunctionArgs
ClientLoaderFunction
ClientLoaderFunctionArgs
CookieOptions
CreateRequestHandlerFunction
DataFunctionArgs
DataRouteObject
ErrorResponse
Fetcher
FetcherWithComponents
FlashSessionData
FormEncType
FormMethod
HTMLFormMethod
HeadersArgs
HtmlLinkDescriptor
HydrationState
InitialEntry
IsCookieFunction
IsSessionFunction
JsonFunction
LinkDescriptor
LoaderFunction
MetaDescriptor
NavLinkRenderProps
Navigation
NavigationStates
ParamKeyValuePair
ParamParseKey
Params
PatchRoutesOnNavigationFunction
PatchRoutesOnNavigationFunctionArgs
PathParam
RedirectFunction
RelativeRoutingType
RequestHandler
RevalidationState
RouteObject
RouteProps
RouterFetchOptions
RouterNavigateOptions
ScrollRestorationProps
SetURLSearchParams
SubmitTarget
To
TypedResponse
URLSearchParamsInit
IDLE_BLOCKER
IDLE_FETCHER
IDLE_NAVIGATION
RouterProvider
createCookie
createCookieSessionStorage
createMemorySessionStorage
createRequestHandler
createSession
createSessionStorage
isCookie
isSession
setDevServerHooks
react-router
Select a package
react-router
@react-router/dev
@react-router/express
@react-router/fs-routes
@react-router/node
@react-router/remix-config-routes-adapter
Routers
createBrowserRouter
createHashRouter
createMemoryRouter
createStaticRouter
Router Components
BrowserRouter
HashRouter
MemoryRouter
StaticRouter
StaticRouterProvider
HistoryRouter
Components
Await
Form
Link
Links
Meta
NavLink
Navigate
Outlet
PrefetchPageLinks
Route
Router
Routes
Scripts
ScrollRestoration
ServerRouter
Hooks
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
Utils
createPath
createRoutesFromChildren
createRoutesStub
createSearchParams
createStaticHandler
data
generatePath
isRouteErrorResponse
json
matchPath
matchRoutes
parsePath
redirect
redirectDocument
renderMatches
replace
resolvePath
Types
AwaitProps
BrowserRouterProps
FetcherFormProps
FormProps
HashRouterProps
HistoryRouterProps
IndexRouteProps
LayoutRouteProps
LinkProps
MemoryRouterProps
NavLinkProps
NavigateProps
OutletProps
PathRouteProps
RouterProps
RoutesProps
ScriptsProps
Other
createRoutesFromElements
ActionFunction
ActionFunctionArgs
AppLoadContext
Cookie
CookieParseOptions
CookieSerializeOptions
CookieSignatureOptions
DataRouteMatch
DataStrategyFunction
DataStrategyFunctionArgs
DataStrategyMatch
DataStrategyResult
EntryContext
FetcherSubmitFunction
FetcherSubmitOptions
GetScrollPositionFunction
GetScrollRestorationKeyFunction
HandleDataRequestFunction
HandleDocumentRequestFunction
HandleErrorFunction
HeadersFunction
IndexRouteObject
LazyRouteFunction
LinksFunction
LoaderFunctionArgs
Location
MetaArgs
MetaFunction
NavigateFunction
NavigateOptions
Navigator
NonIndexRouteObject
PageLinkDescriptor
Path
PathMatch
PathPattern
Router
RouteMatch
RouterInit
RouterProviderProps
RouterState
RouterSubscriber
RoutesTestStubProps
ServerBuild
ServerEntryModule
ServerRouterProps
Session
SessionData
SessionIdStorageStrategy
SessionStorage
ShouldRevalidateFunction
ShouldRevalidateFunctionArgs
StaticHandler
StaticHandlerContext
StaticRouterProps
StaticRouterProviderProps
SubmitFunction
SubmitOptions
UIMatch
Blocker
BlockerFunction
ClientActionFunction
ClientActionFunctionArgs
ClientLoaderFunction
ClientLoaderFunctionArgs
CookieOptions
CreateRequestHandlerFunction
DataFunctionArgs
DataRouteObject
ErrorResponse
Fetcher
FetcherWithComponents
FlashSessionData
FormEncType
FormMethod
HTMLFormMethod
HeadersArgs
HtmlLinkDescriptor
HydrationState
InitialEntry
IsCookieFunction
IsSessionFunction
JsonFunction
LinkDescriptor
LoaderFunction
MetaDescriptor
NavLinkRenderProps
Navigation
NavigationStates
ParamKeyValuePair
ParamParseKey
Params
PatchRoutesOnNavigationFunction
PatchRoutesOnNavigationFunctionArgs
PathParam
RedirectFunction
RelativeRoutingType
RequestHandler
RevalidationState
RouteObject
RouteProps
RouterFetchOptions
RouterNavigateOptions
ScrollRestorationProps
SetURLSearchParams
SubmitTarget
To
TypedResponse
URLSearchParamsInit
IDLE_BLOCKER
IDLE_FETCHER
IDLE_NAVIGATION
RouterProvider
createCookie
createCookieSessionStorage
createMemorySessionStorage
createRequestHandler
createSession
createSessionStorage
isCookie
isSession
setDevServerHooks
BrowserRouterProps
interface
Properties
basename
Type:
string
children
Type:
ReactNode
window
Type:
Window
Brand Assets
•
Docs and examples
CC 4.0