Backstage
    Preparing search index...

    Function createExternalRouteRef

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

      Type Parameters

      • TParams extends { [param in string]: string } | undefined = undefined
      • TParamKeys extends string = string

      Parameters

      • Optionalconfig: {
            defaultTarget?: string;
            params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[];
        }
        • OptionaldefaultTarget?: string

          The route (typically in another plugin) that this should map to by default.

          The string is expected to be on the standard <plugin id>.<route id> form, for example techdocs.docRoot.

        • Optional Readonlyparams?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]

          The parameters that will be provided to the external route reference.

      Returns ExternalRouteRef<
          keyof TParams extends never
              ? undefined
              : string extends TParamKeys ? TParams : { [param in string]: string },
      >

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

    Settings

    Member Visibility