@backstage/plugin-catalog

Home > @backstage/plugin-catalog

The Backstage plugin for browsing the Backstage catalog

Classes

Class	Description
DefaultEntityPresentationApi	Default implementation of the EntityPresentationApi.
DefaultStarredEntitiesApi	Default implementation of the StarredEntitiesApi that is backed by the StorageApi.

Functions

Function	Description
AboutContent(props)
AboutField(props)
CatalogEntityPage()
CatalogIndexPage(props)
CatalogKindHeader(props)
CatalogSearchResultListItem(props)
EntityAboutCard(props)	An example About card to show at the top of entity pages.
EntityDependencyOfComponentsCard(props)
EntityDependsOnComponentsCard(props)
EntityDependsOnResourcesCard(props)
EntityHasComponentsCard(props)
EntityHasResourcesCard(props)
EntityHasSubcomponentsCard(props)
EntityHasSubdomainsCard(props)
EntityHasSystemsCard(props)
EntityLabelsCard(props)
EntityLinksCard(props)
EntityListContainer(props)
EntityOrphanWarning()	Displays a warning alert if the entity is marked as orphan with the ability to delete said entity.
EntityProcessingErrorsPanel()	Displays a list of errors from the ancestors of the current entity.
EntityRelationWarning()	Displays a warning alert if the entity has relations to other entities, which don't exist in the catalog
FilterContainer(props)
FilteredEntityLayout(props)
hasCatalogProcessingErrors(entity, context)	Returns true if the given entity has any processing errors on it.
hasLabels(entity)	Returns true if the given entity has labels annotation given by the catalog. For use by EntitySwitch
hasRelationWarnings(entity, context)	Returns true if the given entity has relations to other entities, which don't exist in the catalog
isApiType(types)	For use in EntitySwitch.Case. Matches if the entity is an API of a given spec.type.
isComponentType(types)	For use in EntitySwitch.Case. Matches if the entity is a Component of a given spec.type.
isEntityWith(predicate)	For use in EntitySwitch.Case. Matches if the entity is the specified kind and type (if present).
isKind(kinds)	For use in EntitySwitch.Case. Matches if the entity is of a given kind.
isNamespace(namespaces)	For use in EntitySwitch.Case. Matches if the entity is in a given namespace.
isOrphan(entity)	Returns true if the given entity has the orphan annotation given by the catalog.
isResourceType(types)	For use in EntitySwitch.Case. Matches if the entity is a Resource of a given spec.type.
RelatedEntitiesCard(props)

Interfaces

Interface	Description
AboutContentProps	Props for AboutContent().
AboutFieldProps	Props for AboutField().
CatalogKindHeaderProps	Props for CatalogKindHeader().
CatalogSearchResultListItemProps	Props for CatalogSearchResultListItem().
CatalogTableProps	Props for CatalogTable.
CatalogTableRow
DefaultCatalogPageProps	Props for root catalog pages.
DefaultEntityPresentationApiOptions	Options for the DefaultEntityPresentationApi.
DefaultEntityPresentationApiRenderer	A custom renderer for the DefaultEntityPresentationApi.
DependencyOfComponentsCardProps
DependsOnComponentsCardProps
DependsOnResourcesCardProps
EntityLabelsCardProps
EntityLayoutProps
EntityLinksCardProps
EntityPredicates
EntitySwitchCaseProps
EntitySwitchProps	Props for the EntitySwitch component.
HasComponentsCardProps
HasResourcesCardProps
HasSubcomponentsCardProps
HasSubdomainsCardProps
HasSystemsCardProps

Variables

Variable	Description
catalogPlugin
CatalogTable	CatalogTable is a wrapper around the Table component that is pre-configured to display catalog entities.
EntityLayout	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
EntitySwitch

Type Aliases

Type Alias	Description
AboutCardProps	Props for EntityAboutCard().
BackstageOverrides
Breakpoint
CatalogSearchResultListItemClassKey
CatalogTableColumnsFunc	Typed columns function to dynamically render columns based on entity list context.
CatalogTableToolbarClassKey
ColumnBreakpoints
EntityContextMenuClassKey
EntityLabelsEmptyStateClassKey
EntityLayoutRouteProps
EntityLinksEmptyStateClassKey
PluginCatalogComponentsNameToClassKey
RelatedEntitiesCardProps
SystemDiagramCardClassKey