@backstage/plugin-catalog
Home > @backstage/plugin-catalog
The Backstage plugin for browsing the Backstage catalog
Classes
Class |
Description |
---|---|
Default implementation of the EntityPresentationApi. | |
Default implementation of the StarredEntitiesApi that is backed by the StorageApi. |
Functions
Function |
Description |
---|---|
An example About card to show at the top of entity pages. | |
Displays a warning alert if the entity is marked as orphan with the ability to delete said entity. | |
Displays a list of errors from the ancestors of the current entity. | |
Displays a warning alert if the entity has relations to other entities, which don't exist in the catalog | |
Returns true if the given entity has any processing errors on it. | |
Returns true if the given entity has labels annotation given by the catalog. For use by EntitySwitch | |
Returns true if the given entity has relations to other entities, which don't exist in the catalog | |
For use in EntitySwitch.Case. Matches if the entity is an API of a given spec.type. | |
For use in EntitySwitch.Case. Matches if the entity is a Component of a given spec.type. | |
For use in EntitySwitch.Case. Matches if the entity is the specified kind and type (if present). | |
For use in EntitySwitch.Case. Matches if the entity is of a given kind. | |
For use in EntitySwitch.Case. Matches if the entity is in a given namespace. | |
Returns true if the given entity has the orphan annotation given by the catalog. | |
For use in EntitySwitch.Case. Matches if the entity is a Resource of a given spec.type. | |
Interfaces
Interface |
Description |
---|---|
Props for EntityAboutCard(). | |
Props for AboutContent(). | |
Props for AboutField(). | |
Props for CatalogKindHeader(). | |
Props for CatalogSearchResultListItem(). | |
Props for CatalogTable. | |
Props for root catalog pages. | |
Options for the DefaultEntityPresentationApi. | |
A custom renderer for the DefaultEntityPresentationApi. | |
Props for the EntitySwitch component. | |
Variables
Variable |
Description |
---|---|
EntityLayout is a compound component, which allows you to define a layout for entities using a sub-navigation mechanism. Consists of two parts: EntityLayout and EntityLayout.Route | |
Type Aliases
Type Alias |
Description |
---|---|
Typed columns function to dynamically render columns based on entity list context. | |