@vaadin/router
    Preparing search index...

    Interface RouteChildrenContext<R, C>

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

    interface RouteChildrenContext<
        R extends object = EmptyObject,
        C extends object = EmptyObject,
    > {
        chain?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["chain"];
        hash?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["hash"];
        params: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["params"];
        pathname: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["pathname"];
        redirectFrom?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["redirectFrom"];
        resolver?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["resolver"];
        result?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["result"];
        route: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["route"];
        search?: RouteContext<
            ActionValue,
            RouteExtension<R, C>,
            ContextExtension<R, C>,
        >["search"];
    }

    Type Parameters

    • R extends object = EmptyObject

      The type of the route parameters.

    • C extends object = EmptyObject

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

    Index

    Properties

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

    Properties

    chain?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["chain"]

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

    hash?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["hash"]

    The hash fragment of the URL.

    params: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["params"]

    The parameters resolved from the current URL.

    pathname: RouteContext<
        ActionValue,
        RouteExtension<R, C>,
        ContextExtension<R, C>,
    >["pathname"]

    The current location.

    redirectFrom?: RouteContext<
        ActionValue,
        RouteExtension<R, C>,
        ContextExtension<R, C>,
    >["redirectFrom"]

    The URL from which a redirect occurred.

    resolver?: RouteContext<
        ActionValue,
        RouteExtension<R, C>,
        ContextExtension<R, C>,
    >["resolver"]

    The resolver instance.

    result?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<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.

    route: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["route"]

    The current route.

    search?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["search"]

    The search query string of the URL.

    Settings

    Member Visibility

    On This Page

    Properties