Interface RouteChildrenContext<T, R, C>

Represents the context that is accessible from the route children callback. It is the a RouteContext without the 'next' property.

Deprecated

The route children callback is deprecated and will be removed in the next major version.

interface RouteChildrenContext<T, R, C> {
    chain?: RouteContext<T, R, C>["chain"];
    hash?: RouteContext<T, R, C>["hash"];
    params: RouteContext<T, R, C>["params"];
    pathname: RouteContext<T, R, C>["pathname"];
    redirectFrom?: RouteContext<T, R, C>["redirectFrom"];
    resolver?: RouteContext<T, R, C>["resolver"];
    result?: RouteContext<T, R, C>["result"];
    route: RouteContext<T, R, C>["route"];
    search?: RouteContext<T, R, C>["search"];
}

Type Parameters

  • T

    The type of the route parameters.

  • R extends object = EmptyObject

    The type of the route's resolved data. Defaults to EmptyObject.

  • C extends object = EmptyObject

    The type of the route's context. Defaults to EmptyObject.

Properties

chain? hash? params pathname redirectFrom? resolver? result? route search?

Properties

Optional Readonlychain

chain?: RouteContext<T, R, C>["chain"]

The sequence of the resolved route items, so said the path from the root route to the current route.

Optional Readonlyhash

hash?: RouteContext<T, R, C>["hash"]

The hash fragment of the URL.

Readonlyparams

params: RouteContext<T, R, C>["params"]

The parameters resolved from the current URL.

Readonlypathname

pathname: RouteContext<T, R, C>["pathname"]

The current location.

Optional ReadonlyredirectFrom

redirectFrom?: RouteContext<T, R, C>["redirectFrom"]

The URL from which a redirect occurred.

Optional Readonlyresolver

resolver?: RouteContext<T, R, C>["resolver"]

The resolver instance.

Optionalresult

result?: RouteContext<T, R, C>["result"]

The result of the route resolution. It could be either a value produced by the Route.action or a new context to continue the resolution process.

Readonlyroute

route: RouteContext<T, R, C>["route"]

The current route.

Optional Readonlysearch

search?: RouteContext<T, R, C>["search"]

The search query string of the URL.

Settings

Member Visibility

On This Page

Properties