Package detail

@backstage/plugin-app

backstage368.8kApache-2.00.3.1

null

readme

Backstage

English | 한국어 | 中文版 | Français

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

software-catalog

Out of the box, Backstage includes:

Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

Community

To engage with our community, you can use the following resources:

Discord chatroom - Get support or discuss the project
Contributing to Backstage - Start here if you want to contribute
RFCs - Help shape the technical direction
FAQ - Frequently Asked Questions
Code of Conduct - This is how we roll
Adopters - Companies already using Backstage
Blog - Announcements and updates
Newsletter - Subscribe to our email newsletter
Backstage Community Sessions - Join monthly meetups and explore Backstage community
Give us a star ⭐️ - If you are using Backstage or think it is an interesting project, we would love a star ❤️

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

changelog

@backstage/plugin-app

0.3.1

Patch Changes

ae1dad0: Fixed an issue that caused the NotFound page to not render correctly when a Page was mounted at /.
Updated dependencies

0.3.1-next.2

Patch Changes

Updated dependencies
- @backstage/core-components@0.18.2-next.2
- @backstage/theme@0.6.9-next.0

0.3.1-next.1

Patch Changes

Updated dependencies

0.3.1-next.0

Patch Changes

Updated dependencies

0.3.0

Minor Changes

99790db: Add implementation of OpenShift authentication provider.

Patch Changes

Updated dependencies

0.2.1-next.0

Patch Changes

Updated dependencies

0.2.0

Minor Changes

fda1bbc: BREAKING: The componentsApi implementation has been removed from the plugin and replaced with the new SwappableComponentsApi instead.

If you were overriding the componentsApi implementation, you can now use the new SwappableComponentsApi instead.
```
// old
appPlugin.getExtension('api:app/components').override(...)

// new
appPlugin.getExtension('api:app/swappable-components').override(...)
```
29786f6: Updated the app/nav extension to use the new NavContentBlueprint, and removed support for extensions created with the now removed NavLogoBlueprint.
121899a: BREAKING: The app-root-element extension now only accepts JSX.Element in its element param, meaning overrides need to be updated.

Patch Changes

91cbdf4: Log a warning when SwappableComponent extensions are installed outside of using the app plugin
fda1bbc: Default implementations of core components are now provided by this package.

A backwards compatible componentsApi implementation is also provided from this package which uses the SwappableComponentsApi as the implementation. This backwards compatible wrapper will be removed in the future.
f2f133c: Internal update to use the new variant of ApiBlueprint.
a08f95f: Added a new module for implementing public sign-in apps, exported as appModulePublicSignIn via the /alpha sub-path export. This replaces the createPublicSignInApp export from @backstage/frontend-defaults, which is now deprecated.
5d31d66: Updated the usage of the RouterBlueprint and AppRootWrapperBlueprint to use the lowercase component parameter
93b5e38: The default implementation of the Analytics API now collects and instantiates analytics implementations exposed via AnalyticsImplementationBlueprint extensions. If no such extensions are discovered, the API continues to do nothing with analytics events fired within Backstage. If multiple such extensions are discovered, every discovered implementation automatically receives analytics events.
9831f4e: Adjusted the dialog API types to have more sensible defaults
Updated dependencies

0.2.0-next.2

Minor Changes

fda1bbc: BREAKING: The componentsApi implementation has been removed from the plugin and replaced with the new SwappableComponentsApi instead.

If you were overriding the componentsApi implementation, you can now use the new SwappableComponentsApi instead.
```
// old
appPlugin.getExtension('api:app/components').override(...)

// new
appPlugin.getExtension('api:app/swappable-components').override(...)
```

Patch Changes

91cbdf4: Log a warning when SwappableComponent extensions are installed outside of using the app plugin
fda1bbc: Default implementations of core components are now provided by this package.

A backwards compatible componentsApi implementation is also provided from this package which uses the SwappableComponentsApi as the implementation. This backwards compatible wrapper will be removed in the future.
9831f4e: Adjusted the dialog API types to have more sensible defaults
Updated dependencies
- @backstage/frontend-plugin-api@0.11.0-next.2
- @backstage/core-components@0.17.5-next.2

0.2.0-next.1

Minor Changes

121899a: BREAKING: The app-root-element extension now only accepts JSX.Element in its element param, meaning overrides need to be updated.

Patch Changes

a08f95f: Added a new module for implementing public sign-in apps, exported as appModulePublicSignIn via the /alpha sub-path export. This replaces the createPublicSignInApp export from @backstage/frontend-defaults, which is now deprecated.
5d31d66: Updated the usage of the RouterBlueprint and AppRootWrapperBlueprint to use the lowercase component parameter
93b5e38: The default implementation of the Analytics API now collects and instantiates analytics implementations exposed via AnalyticsImplementationBlueprint extensions. If no such extensions are discovered, the API continues to do nothing with analytics events fired within Backstage. If multiple such extensions are discovered, every discovered implementation automatically receives analytics events.
Updated dependencies

0.2.0-next.0

Minor Changes

29786f6: Updated the app/nav extension to use the new NavContentBlueprint, and removed support for extensions created with the now removed NavLogoBlueprint.

Patch Changes

f2f133c: Internal update to use the new variant of ApiBlueprint.
Updated dependencies

0.1.11

Patch Changes

09f5e36: Remove trailing slashes in the AppRoutes extension to ensure any nested routing behaves correctly.
Updated dependencies

0.1.11-next.1

Patch Changes

Updated dependencies

0.1.11-next.0

Patch Changes

Updated dependencies

0.1.10

Patch Changes

18c64e9: Added the info.packageJson option to the plugin instance for the new frontend system.
Updated dependencies

0.1.10-next.1

Patch Changes

Updated dependencies

0.1.10-next.0

Patch Changes

18c64e9: Added the info.packageJson option to the plugin instance for the new frontend system.
Updated dependencies
- @backstage/frontend-plugin-api@0.10.3-next.0
- @backstage/integration-react@1.2.7

0.1.9

Patch Changes

fb58f20: Internal update to use the new pluginId option of createFrontendPlugin.
Updated dependencies

0.1.9-next.3

Patch Changes

Updated dependencies

0.1.9-next.2

Patch Changes

Updated dependencies

0.1.9-next.1

Patch Changes

fb58f20: Internal update to use the new pluginId option of createFrontendPlugin.
Updated dependencies

0.1.9-next.0

Patch Changes

Updated dependencies

0.1.8

Patch Changes

a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.

https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
Updated dependencies

0.1.8-next.1

Patch Changes

a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.

https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
Updated dependencies

0.1.8-next.0

Patch Changes

Updated dependencies

0.1.7

Patch Changes

583fc54: Fixed extra app elements not being rendered as part of apps without a sign-in page.
0aa9d82: Added implementation of the new DialogApi.
Updated dependencies

0.1.7-next.2

Patch Changes

0aa9d82: Added implementation of the new DialogApi.
Updated dependencies

0.1.7-next.1

Patch Changes

583fc54: Fixed extra app elements not being rendered as part of apps without a sign-in page.
Updated dependencies

0.1.7-next.0

Patch Changes

Updated dependencies
- @backstage/frontend-plugin-api@0.9.6-next.0
- @backstage/integration-react@1.2.4

0.1.6

Patch Changes

58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
Updated dependencies

0.1.6-next.3

Patch Changes

Updated dependencies

0.1.6-next.2

Patch Changes

Updated dependencies

0.1.6-next.1

Patch Changes

58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
Updated dependencies

0.1.6-next.0

Patch Changes

Updated dependencies

0.1.5

Patch Changes

Updated dependencies

0.1.5-next.0

Patch Changes

Updated dependencies

0.1.4

Patch Changes

e5fa018: The OAuth 2 client implementations will now attempt to refresh the session when the existing session doesn't have the required scopes. The previous behavior was to only try to refresh the session of it was missing, and otherwise directly request a new session. This fixes an issue where some auth providers will not return access tokens with certain scopes unless explicitly requested, leading to an auth popup even if the underlying session already had been granted the requested scopes.
5f04976: Fixed a bug that caused missing code in published packages.
Updated dependencies

0.1.4-next.2

Patch Changes

Updated dependencies

0.1.4-next.1

Patch Changes

Updated dependencies

0.1.4-next.0

Patch Changes

e5fa018: The OAuth 2 client implementations will now attempt to refresh the session when the existing session doesn't have the required scopes. The previous behavior was to only try to refresh the session of it was missing, and otherwise directly request a new session. This fixes an issue where some auth providers will not return access tokens with certain scopes unless explicitly requested, leading to an auth popup even if the underlying session already had been granted the requested scopes.
5f04976: Fixed a bug that caused missing code in published packages.
Updated dependencies

0.1.2

Patch Changes

Updated dependencies

0.1.2-next.2

Patch Changes

Updated dependencies

0.1.2-next.1

Patch Changes

Updated dependencies

0.1.2-next.0

Patch Changes

Updated dependencies

0.1.1

Patch Changes

b36be7a: Added missing default SignInPageExtension which by default uses guest auth, missing ApiExtensions for scmAuth
Updated dependencies

0.1.1-next.2

Patch Changes

Updated dependencies

0.1.1-next.1

Patch Changes

Updated dependencies

0.1.1-next.0

Patch Changes

Updated dependencies

0.1.0

Minor Changes

2bb9517: Introduce the @backstage/plugin-app package to hold all of the built-in extensions for easy consumption and overriding.

Patch Changes

52f9c5a: Deprecated the namespace option for createExtensionBlueprint and createExtension, these are no longer required and will default to the pluginId instead.

You can migrate some of your extensions that use createExtensionOverrides to using createFrontendModule instead and providing a pluginId there.

// Before
createExtensionOverrides({
  extensions: [
    createExtension({
      name: 'my-extension',
      namespace: 'my-namespace',
      kind: 'test',
      ...
    })
  ],
});

// After
createFrontendModule({
  pluginId: 'my-namespace',
  extensions: [
    createExtension({
      name: 'my-extension',
      kind: 'test',
      ...
    })
  ],
});

57bf6ae: Fix issue with AlertDisplay and other components defined with AppRootElementBlueprint not being rendered when at the SignInWrapper
836127c: Updated dependency @testing-library/react to ^16.0.0.
Updated dependencies

0.1.0-next.2

Patch Changes

57bf6ae: Fix issue with AlertDisplay and other components defined with AppRootElementBlueprint not being rendered when at the SignInWrapper
836127c: Updated dependency @testing-library/react to ^16.0.0.
Updated dependencies

0.1.0-next.1

Patch Changes

52f9c5a: Deprecated the namespace option for createExtensionBlueprint and createExtension, these are no longer required and will default to the pluginId instead.

You can migrate some of your extensions that use createExtensionOverrides to using createFrontendModule instead and providing a pluginId there.

// Before
createExtensionOverrides({
  extensions: [
    createExtension({
      name: 'my-extension',
      namespace: 'my-namespace',
      kind: 'test',
      ...
    })
  ],
});

// After
createFrontendModule({
  pluginId: 'my-namespace',
  extensions: [
    createExtension({
      name: 'my-extension',
      kind: 'test',
      ...
    })
  ],
});

Updated dependencies

0.1.0-next.0

Minor Changes

2bb9517: Introduce the @backstage/plugin-app package to hold all of the built-in extensions for easy consumption and overriding.

Patch Changes

Updated dependencies