Type Alias RouteComponentProps<TVariables, S, TQueryShape>

Props passed to RouteComponent instances.

type RouteComponentProps<
    TVariables extends ParamData,
    S extends Schema | undefined = Schema | undefined,
    TQueryShape extends UnknownQueryShape = UnknownQueryShape,
> = {
    children: ReactElement;
    route: Route<unknown, unknown, ParamData, UnknownQueryShape, S>;
    routerContext: RoutingContextType<TVariables, S, TQueryShape>;
}

Type Parameters

TVariables extends ParamData
Route parameter types extracted from the URL path
S extends Schema | undefined = Schema | undefined
TQueryShape extends UnknownQueryShape = UnknownQueryShape

Index

Properties

children route routerContext

Properties

children

children: ReactElement

Child components to render

route

route: Route<unknown, unknown, ParamData, UnknownQueryShape, S>

The route configuration

routerContext

routerContext: RoutingContextType<TVariables, S, TQueryShape>

Router context containing navigation and state