SubRouteRef

Home > @backstage/core-plugin-api > SubRouteRef

Descriptor of a route relative to an absolute RouteRef.

Signature:

export type SubRouteRef<Params extends AnyParams = any> = {
    $$routeRefType: 'sub';
    parent: RouteRef;
    path: string;
    params: ParamKeys<Params>;
};

References: AnyParams, RouteRef, ParamKeys

Remarks

See https://backstage.io/docs/plugins/composability#routing-system.