React Router API Reference
Preparing search index...
react-router
RouterInit
Interface RouterInit
Initialization options for createRouter
interface
RouterInit
{
basename
?:
string
;
dataStrategy
?:
DataStrategyFunction
<
any
>
;
future
?:
Partial
<
FutureConfig
>
;
getContext
?:
()
=>
MaybePromise
<
RouterContextProvider
>
;
history
:
History
;
hydrationData
?:
Partial
<
Pick
<
RouterState
,
"loaderData"
|
"actionData"
|
"errors"
>
,
>
;
hydrationRouteProperties
?:
string
[]
;
mapRouteProperties
?:
MapRoutePropertiesFunction
;
patchRoutesOnNavigation
?:
AgnosticPatchRoutesOnNavigationFunction
;
routes
:
AgnosticRouteObject
[]
;
unstable_instrumentations
?:
unstable_ClientInstrumentation
[]
;
window
?:
Window
;
}
Index
Properties
basename?
data
Strategy?
future?
get
Context?
history
hydration
Data?
hydration
Route
Properties?
map
Route
Properties?
patch
Routes
On
Navigation?
routes
unstable_
instrumentations?
window?
Properties
Optional
basename
basename
?:
string
Optional
data
Strategy
dataStrategy
?:
DataStrategyFunction
<
any
>
Optional
future
future
?:
Partial
<
FutureConfig
>
Optional
get
Context
getContext
?:
()
=>
MaybePromise
<
RouterContextProvider
>
history
history
:
History
Optional
hydration
Data
hydrationData
?:
Partial
<
Pick
<
RouterState
,
"loaderData"
|
"actionData"
|
"errors"
>
,
>
Optional
hydration
Route
Properties
hydrationRouteProperties
?:
string
[]
Optional
map
Route
Properties
mapRouteProperties
?:
MapRoutePropertiesFunction
Optional
patch
Routes
On
Navigation
patchRoutesOnNavigation
?:
AgnosticPatchRoutesOnNavigationFunction
routes
routes
:
AgnosticRouteObject
[]
Optional
unstable_
instrumentations
unstable_instrumentations
?:
unstable_ClientInstrumentation
[]
Optional
window
window
?:
Window
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
basename
data
Strategy
future
get
Context
history
hydration
Data
hydration
Route
Properties
map
Route
Properties
patch
Routes
On
Navigation
routes
unstable_
instrumentations
window
React Router API Reference
Loading...
Initialization options for createRouter