Plumile JS API
    Preparing search index...

    Type Alias RouteRenderOpts<TContext, TPrepared, TVariables, TQueryShape>

    Options passed to a route render function.

    type RouteRenderOpts<
        TContext,
        TPrepared extends PrepareResult,
        TVariables extends ParamData = ParamData,
        TQueryShape extends UnknownQueryShape = UnknownQueryShape,
    > = {
        children: ReactNode;
        Component?: RouteReactComponent;
        context: TContext;
        leafSegment: PreparedRouteSegment<TContext>;
        prepared: TPrepared | undefined;
        preparedRoute: PreparedRouteSegment<
            TContext,
            TPrepared,
            TVariables,
            TQueryShape,
        >;
        preparedSegment: PreparedRouteSegment<
            TContext,
            TPrepared,
            TVariables,
            TQueryShape,
        >;
        preparedSegments: PreparedRouteSegments<TContext>;
        query: TQueryShape;
        rawQuery: RawQuery;
        route: FlatRoute<TVariables> | null;
        segmentIndex: number;
    }

    Type Parameters

    • TContext
    • TPrepared extends PrepareResult

      The type of prepared data returned by the route's prepare function

    • TVariables extends ParamData = ParamData

      Route parameter types extracted from the URL path

    • TQueryShape extends UnknownQueryShape = UnknownQueryShape
    Index

    Properties

    children Component? context leafSegment prepared preparedRoute preparedSegment preparedSegments query rawQuery route segmentIndex

    Properties

    children: ReactNode

    Child components to render within this route

    Component?: RouteReactComponent

    Optional component to render (from ResourcePage)

    context: TContext

    Router-level context

    leafSegment: PreparedRouteSegment<TContext>

    The leaf segment of the prepared chain

    prepared: TPrepared | undefined

    Data prepared by the route's prepare function

    preparedRoute: PreparedRouteSegment<
        TContext,
        TPrepared,
        TVariables,
        TQueryShape,
    >

    Alias kept for migration compatibility

    preparedSegment: PreparedRouteSegment<
        TContext,
        TPrepared,
        TVariables,
        TQueryShape,
    >

    The prepared segment that is being rendered

    preparedSegments: PreparedRouteSegments<TContext>

    The full prepared chain for the current match

    query: TQueryShape

    Typed query object (Phase 3). Falls back to rawQuery if no schema

    rawQuery: RawQuery

    Raw query object (Phase 2 generic parsing)

    route: FlatRoute<TVariables> | null

    The matched route or null if no match

    segmentIndex: number

    Index of the current segment in the prepared chain

    Settings

    Member Visibility

    On This Page

    Properties