Backstage
Docs
Github
Preparing search index...
@backstage/frontend-plugin-api
index
Module index
Core API used by Backstage frontend plugins.
Namespaces
ExtensionBoundary
FeatureFlagState
SessionState
Interfaces
AnalyticsContextValue
AppNode
AppNodeEdges
AppNodeInstance
AppNodeSpec
AppTree
AppTreeApi
ConfigurableExtensionDataRef
CreateFrontendFeatureLoaderOptions
CreateFrontendModuleOptions
DialogApi
DialogApiDialog
Extension
ExtensionBlueprint
ExtensionBoundaryProps
ExtensionDefinition
ExtensionInput
ExternalRouteRef
FeatureFlagsApi
FrontendFeatureLoader
FrontendModule
FrontendPlugin
FrontendPluginInfo
IconsApi
OverridableExtensionDefinition
OverridableFrontendPlugin
PluginOptions
RouteRef
RouteResolutionApi
StorageApi
SubRouteRef
SwappableComponentsApi
TranslationMessages
TranslationMessagesOptions
TranslationRef
TranslationRefOptions
TranslationResource
TranslationResourceOptions
Type Aliases
AlertApi
AlertMessage
AnalyticsApi
AnalyticsEvent
AnalyticsEventAttributes
AnalyticsImplementation
AnalyticsImplementationFactory
AnalyticsTracker
AnyApiFactory
AnyApiRef
AnyExtensionDataRef
AnyRouteRefParams
ApiFactory
ApiHolder
ApiRef
ApiRefConfig
AppLanguageApi
AppTheme
AppThemeApi
AuthProviderInfo
AuthRequestOptions
BackstageIdentityApi
BackstageIdentityResponse
BackstageUserIdentity
ConfigApi
CreateExtensionBlueprintOptions
CreateExtensionOptions
CreateSwappableComponentOptions
DiscoveryApi
ErrorApi
ErrorApiError
ErrorApiErrorContext
ErrorDisplayProps
ExtensionAttachTo
ExtensionAttachToSpec
ExtensionBlueprintDefineParams
ExtensionBlueprintParameters
ExtensionBlueprintParams
ExtensionDataContainer
ExtensionDataRef
ExtensionDataRefToValue
ExtensionDataValue
ExtensionDefinitionAttachTo
ExtensionDefinitionParameters
ExtensionFactoryMiddleware
FeatureFlag
FeatureFlagConfig
FeatureFlagsSaveOptions
FeatureFlagState
FetchApi
FrontendFeature
FrontendPluginInfoOptions
IconComponent
IdentityApi
NotFoundErrorPageProps
OAuthApi
OAuthRequestApi
OAuthRequester
OAuthRequesterOptions
OAuthScope
OpenIdConnectApi
PendingOAuthRequest
PortableSchema
ProfileInfo
ProfileInfoApi
ProgressProps
ResolvedExtensionInput
ResolvedExtensionInputs
RouteFunc
SessionApi
SessionState
StorageValueSnapshot
SwappableComponentRef
TranslationApi
TranslationFunction
TranslationSnapshot
TypesToApiRefs
Variables
alertApiRef
analyticsApiRef
AnalyticsImplementationBlueprint
ApiBlueprint
appLanguageApiRef
AppRootElementBlueprint
appThemeApiRef
appTreeApiRef
atlassianAuthApiRef
bitbucketAuthApiRef
bitbucketServerAuthApiRef
configApiRef
coreExtensionData
dialogApiRef
discoveryApiRef
errorApiRef
ErrorDisplay
featureFlagsApiRef
FeatureFlagState
fetchApiRef
githubAuthApiRef
gitlabAuthApiRef
googleAuthApiRef
iconsApiRef
identityApiRef
microsoftAuthApiRef
NavItemBlueprint
NotFoundErrorPage
oauthRequestApiRef
oktaAuthApiRef
oneloginAuthApiRef
openshiftAuthApiRef
PageBlueprint
Progress
routeResolutionApiRef
SessionState
storageApiRef
swappableComponentsApiRef
translationApiRef
vmwareCloudAuthApiRef
Functions
AnalyticsContext
createApiFactory
createApiRef
createExtension
createExtensionBlueprint
createExtensionBlueprintParams
createExtensionDataRef
createExtensionInput
createExternalRouteRef
createFrontendFeatureLoader
createFrontendModule
createFrontendPlugin
createRouteRef
createSubRouteRef
createSwappableComponent
createTranslationMessages
createTranslationRef
createTranslationResource
ExtensionBoundary
useAnalytics
useApi
useApiHolder
useAppNode
useRouteRef
useRouteRefParams
useTranslationRef
withApis
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
Extension
Boundary
Feature
Flag
State
Session
State
Interfaces
Analytics
Context
Value
App
Node
App
Node
Edges
App
Node
Instance
App
Node
Spec
App
Tree
App
Tree
Api
Configurable
Extension
Data
Ref
Create
Frontend
Feature
Loader
Options
Create
Frontend
Module
Options
Dialog
Api
Dialog
Api
Dialog
Extension
Extension
Blueprint
Extension
Boundary
Props
Extension
Definition
Extension
Input
External
Route
Ref
Feature
Flags
Api
Frontend
Feature
Loader
Frontend
Module
Frontend
Plugin
Frontend
Plugin
Info
Icons
Api
Overridable
Extension
Definition
Overridable
Frontend
Plugin
Plugin
Options
Route
Ref
Route
Resolution
Api
Storage
Api
Sub
Route
Ref
Swappable
Components
Api
Translation
Messages
Translation
Messages
Options
Translation
Ref
Translation
Ref
Options
Translation
Resource
Translation
Resource
Options
Type Aliases
Alert
Api
Alert
Message
Analytics
Api
Analytics
Event
Analytics
Event
Attributes
Analytics
Implementation
Analytics
Implementation
Factory
Analytics
Tracker
Any
Api
Factory
Any
Api
Ref
Any
Extension
Data
Ref
Any
Route
Ref
Params
Api
Factory
Api
Holder
Api
Ref
Api
Ref
Config
App
Language
Api
App
Theme
App
Theme
Api
Auth
Provider
Info
Auth
Request
Options
Backstage
Identity
Api
Backstage
Identity
Response
Backstage
User
Identity
Config
Api
Create
Extension
Blueprint
Options
Create
Extension
Options
Create
Swappable
Component
Options
Discovery
Api
Error
Api
Error
Api
Error
Error
Api
Error
Context
Error
Display
Props
Extension
Attach
To
Extension
Attach
To
Spec
Extension
Blueprint
Define
Params
Extension
Blueprint
Parameters
Extension
Blueprint
Params
Extension
Data
Container
Extension
Data
Ref
Extension
Data
Ref
To
Value
Extension
Data
Value
Extension
Definition
Attach
To
Extension
Definition
Parameters
Extension
Factory
Middleware
Feature
Flag
Feature
Flag
Config
Feature
Flags
Save
Options
Feature
Flag
State
Fetch
Api
Frontend
Feature
Frontend
Plugin
Info
Options
Icon
Component
Identity
Api
Not
Found
Error
Page
Props
O
Auth
Api
O
Auth
Request
Api
O
Auth
Requester
O
Auth
Requester
Options
O
Auth
Scope
Open
Id
Connect
Api
Pending
O
Auth
Request
Portable
Schema
Profile
Info
Profile
Info
Api
Progress
Props
Resolved
Extension
Input
Resolved
Extension
Inputs
Route
Func
Session
Api
Session
State
Storage
Value
Snapshot
Swappable
Component
Ref
Translation
Api
Translation
Function
Translation
Snapshot
Types
To
Api
Refs
Variables
alert
Api
Ref
analytics
Api
Ref
Analytics
Implementation
Blueprint
Api
Blueprint
app
Language
Api
Ref
App
Root
Element
Blueprint
app
Theme
Api
Ref
app
Tree
Api
Ref
atlassian
Auth
Api
Ref
bitbucket
Auth
Api
Ref
bitbucket
Server
Auth
Api
Ref
config
Api
Ref
core
Extension
Data
dialog
Api
Ref
discovery
Api
Ref
error
Api
Ref
Error
Display
feature
Flags
Api
Ref
Feature
Flag
State
fetch
Api
Ref
github
Auth
Api
Ref
gitlab
Auth
Api
Ref
google
Auth
Api
Ref
icons
Api
Ref
identity
Api
Ref
microsoft
Auth
Api
Ref
Nav
Item
Blueprint
Not
Found
Error
Page
oauth
Request
Api
Ref
okta
Auth
Api
Ref
onelogin
Auth
Api
Ref
openshift
Auth
Api
Ref
Page
Blueprint
Progress
route
Resolution
Api
Ref
Session
State
storage
Api
Ref
swappable
Components
Api
Ref
translation
Api
Ref
vmware
Cloud
Auth
Api
Ref
Functions
Analytics
Context
create
Api
Factory
create
Api
Ref
create
Extension
create
Extension
Blueprint
create
Extension
Blueprint
Params
create
Extension
Data
Ref
create
Extension
Input
create
External
Route
Ref
create
Frontend
Feature
Loader
create
Frontend
Module
create
Frontend
Plugin
create
Route
Ref
create
Sub
Route
Ref
create
Swappable
Component
create
Translation
Messages
create
Translation
Ref
create
Translation
Resource
Extension
Boundary
use
Analytics
use
Api
use
Api
Holder
use
App
Node
use
Route
Ref
use
Route
Ref
Params
use
Translation
Ref
with
Apis
Docs
Github
Backstage
Loading...
Core API used by Backstage frontend plugins.