Interface DOMRouterOpts

interface DOMRouterOpts {
    basename?: string;
    dataStrategy?: DataStrategyFunction<any>;
    future?: Partial<FutureConfig>;
    hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
    patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
    unstable_getContext?: (() => MaybePromise<unstable_InitialContext>);
    window?: Window;
}

Properties

basename? dataStrategy? future? hydrationData? patchRoutesOnNavigation? unstable_getContext? window?

Properties

Optionalbasename

basename?: string

Basename path for the application.

OptionaldataStrategy

dataStrategy?: DataStrategyFunction<any>

Override the default data strategy of loading in parallel. Only intended for advanced usage.

Optionalfuture

future?: Partial<FutureConfig>

Future flags to enable for the router.

OptionalhydrationData

hydrationData?: Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>

Hydration data to initialize the router with if you have already performed data loading on the server.

OptionalpatchRoutesOnNavigation

patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction

Lazily define portions of the route tree on navigations.

Optionalunstable_getContext

unstable_getContext?: (() => MaybePromise<unstable_InitialContext>)

Function to provide the initial context values for all client side navigations/fetches

Optionalwindow

window?: Window

Window object override - defaults to the global window instance.

Settings

Member Visibility

On This Page

Properties