Skip to main content
Version: Next

FrontendPluginInfo

Home > @backstage/frontend-plugin-api > FrontendPluginInfo

Information about the plugin.

Signature:

export interface FrontendPluginInfo 

Remarks

This interface is intended to be extended via [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html\#module-augmentation) in order to add fields that are specific to each project.

For example, one might add a slackChannel field that is read from the opaque manifest file.

See the options for createApp for more information about how to customize the parsing of manifest files.

Properties

Property

Modifiers

Type

Description

description?

string

(Optional) As short description of the plugin, typically the description field in package.json.

links?

Array<{ title: string; url: string; }>

(Optional) Links related to the plugin.

ownerEntityRefs?

string[]

(Optional) The owner entity references of the plugin.

packageName?

string

(Optional) The name of the package that implements the plugin.

version?

string

(Optional) The version of the plugin, typically the version of the package.json file.