Skip to main content

ExternalRouteRef

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

Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.

Signature:

export type ExternalRouteRef<Params extends AnyParams = any, Optional extends boolean = any> = {
    $$routeRefType: 'external';
    params: ParamKeys<Params>;
    optional?: Optional;
};

References: AnyParams, ParamKeys

Remarks​

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