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

    Type Alias RouterOptions

    type RouterOptions = {
        base?: string;
        routes: RoutesSource;
        components?: ComponentMap;
        loaders?: LoaderHandlers;
        history?: RouterHistory;
        http?: HttpClient;
        links?: boolean;
        linksRoot?: string;
        hydrate?: (el: Element) => unknown;
        dehydrate?: (el: Element) => unknown;
        fetchBlade?: (href: string) => Promise<string>;
        bladeRoot?: string;
        onError?: (error: unknown, to: RouteLocation) => void;
        scroll?: boolean;
    }
    Index
    base? routes components? loaders? history? http? links? linksRoot? hydrate? dehydrate? fetchBlade? bladeRoot? onError? scroll?
    base?: string

    Mount base, e.g. '/admin'. Falls back to the payload's base, then ''.

    routes: RoutesSource
    components?: ComponentMap

    component key → component | () => import(...)

    loaders?: LoaderHandlers

    Loader preset resolving load values — vapor-chamber/router-fetch (in-box) or your own LoaderHandlers. Routes without load never need this.

    history?: RouterHistory

    Override history (createMemoryHistory for tests/SSR). Default: web.

    http?: HttpClient

    Override the http client (tests). Default: chamber client with X-Vapor-Router marker.

    links?: boolean

    Document-level link interception + active stamping + hover preheat. Default: true in the browser.

    linksRoot?: string

    Selector scoping data-active stamping (e.g. the admin shell) — stamping walks only this subtree instead of the whole document. Interception stays document-level.

    hydrate?: (el: Element) => unknown

    Island hooks for blade rows — app conventions injected, never assumed.

    dehydrate?: (el: Element) => unknown
    fetchBlade?: (href: string) => Promise<string>

    Fetch server HTML for blade rows. Default: http client + bladeRoot.

    bladeRoot?: string

    Selector extracted from fetched blade HTML. Default: 'main'.

    onError?: (error: unknown, to: RouteLocation) => void

    Terminal error handler. Default: hard-navigate on HARD_NAV_CODES, log the rest.

    scroll?: boolean

    Scroll to top after committed push navigations. Default: true.

    Settings
    Member Visibility

    On This Page
    Properties