@resistdesign/voltra
    Preparing search index...

    Type Alias RouteProps<ParamsType>

    Configure the Route.

    type RouteProps<ParamsType extends Record<string, any>> = {
        adapter?: RouteAdapter;
        exact?: boolean;
        ingress?: UniversalRouteIngress;
        initialPath?: string;
        onParamsChange?: (params: ParamsType) => void;
        path?: string | (string | RoutePathConfig)[];
        runtimeIntegration?: RouteRuntimeIntegration;
    }

    Type Parameters

    • ParamsType extends Record<string, any>
    Index

    Properties

    adapter? exact? ingress? initialPath? onParamsChange? path? runtimeIntegration?

    Properties

    adapter?: RouteAdapter

    Optional adapter override for root provider mode only.

    exact?: boolean

    Require an exact match for the route path.

    ingress?: UniversalRouteIngress

    Optional external URL ingress for root provider mode only.

    initialPath?: string

    Optional initial path override for root provider mode only.

    onParamsChange?: (params: ParamsType) => void

    Callback when params update for this route.

    Type Declaration

    path?: string | (string | RoutePathConfig)[]

    Route path pattern(s), using : for params.

    runtimeIntegration?: RouteRuntimeIntegration

    Optional runtime integration hook for root provider mode only.

    Settings

    Member Visibility

    On This Page

    Properties