vapor-chamber API reference - v1.16.0
    Preparing search index...

    Type Alias RouteRecord

    One route row, as emitted by a route generator against this schema.

    type RouteRecord = {
        name: string;
        path: string;
        parent?: string | null;
        component?: string | null;
        blade?: boolean;
        load?: string | null;
        params?: Record<string, ParamType>;
        query?: Record<string, QueryParamDef>;
        meta?: Record<string, unknown>;
    }
    Index
    name path parent? component? blade? load? params? query? meta?
    name: string
    path: string

    Pattern relative to the router base. :param, :param(regex), :param?, trailing * splat (→ params.pathMatch).

    parent?: string | null
    component?: string | null

    Key into the client component map. null/absent + !blade = group record: contributes to the layout chain, never matches a URL, renders nothing.

    blade?: boolean

    Hybrid row: fetch the server-rendered HTML for the URL and swap it into the outlet (hydrate/dehydrate hooks fire).

    load?: string | null

    Server-declared data loader: a URL template fetched on navigation with {placeholders} filled from path params, then typed query params. "/api/vc/products?page={page}&sort={sort}" Fetched with an AbortController — a newer navigation aborts it. The response (house envelope or bare JSON) lands on snapshot.data atomically with the commit; useRouteData() reads it.

    params?: Record<string, ParamType>
    query?: Record<string, QueryParamDef>
    meta?: Record<string, unknown>

    Server data: permissions, titles, preheat flag, …

    Settings
    Member Visibility

    On This Page
    Properties