Backstage
    Preparing search index...

    Interface CreateAppOptions

    Options for createApp.

    interface CreateAppOptions {
        advanced?: {
            allowUnknownExtensionConfig?: boolean;
            configLoader?: () => Promise<{ config: Config }>;
            extensionFactoryMiddleware?:
                | ExtensionFactoryMiddleware
                | ExtensionFactoryMiddleware[];
            loadingElement?: ReactNode;
            pluginInfoResolver?: FrontendPluginInfoResolver;
        };
        features?: (FrontendFeature | FrontendFeatureLoader)[];
        bindRoutes?(context: { bind: CreateAppRouteBinder }): void;
    }
    Index

    Properties

    advanced? features?

    Methods

    bindRoutes?

    Properties

    advanced?: {
        allowUnknownExtensionConfig?: boolean;
        configLoader?: () => Promise<{ config: Config }>;
        extensionFactoryMiddleware?:
            | ExtensionFactoryMiddleware
            | ExtensionFactoryMiddleware[];
        loadingElement?: ReactNode;
        pluginInfoResolver?: FrontendPluginInfoResolver;
    }

    Advanced, more rarely used options.

    Type Declaration

    • OptionalallowUnknownExtensionConfig?: boolean

      If set to true, the system will silently accept and move on if encountering config for extensions that do not exist. The default is to reject such config to help catch simple mistakes.

      This flag can be useful in some scenarios where you have a dynamic set of extensions enabled at different times, but also increases the risk of accidentally missing e.g. simple typos in your config.

    • OptionalconfigLoader?: () => Promise<{ config: Config }>

      Sets a custom config loader, replacing the builtin one.

      This can be used e.g. if you have the need to source config out of custom storages.

    • OptionalextensionFactoryMiddleware?: ExtensionFactoryMiddleware | ExtensionFactoryMiddleware[]

      Applies one or more middleware on every extension, as they are added to the application.

      This is an advanced use case for modifying extension data on the fly as it gets emitted by extensions being instantiated.

    • OptionalloadingElement?: ReactNode

      The element to render while loading the app (waiting for config, features, etc).

      This is the <Progress /> component from @backstage/core-components by default. If set to null then no loading fallback element is rendered at all.

    • OptionalpluginInfoResolver?: FrontendPluginInfoResolver

      Allows for customizing how plugin info is retrieved.

    features?: (FrontendFeature | FrontendFeatureLoader)[]

    The list of features to load.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods