Skip to main content

@backstage/plugin-catalog-react

Home > @backstage/plugin-catalog-react

A frontend library that helps other Backstage plugins interact with the catalog

Classes

ClassDescription
EntityErrorFilterFilters entities based on if it has errors or not.
EntityKindFilterFilter entities based on Kind.
EntityLifecycleFilterFilters entities on lifecycle.
EntityNamespaceFilterFilters entities to those within the given namespace(s).
EntityOrphanFilterFilters entities based if it is an orphan or not.
EntityOwnerFilter

Filter matching entities that are owned by group.

CAUTION: This class may contain both full and partial entity refs.

EntityTagFilterFilters entities based on tag.
EntityTextFilterFilters entities where the text matches spec, title or tags.
EntityTypeFilterFilters entities based on type
EntityUserFilter
MockStarredEntitiesApiAn in-memory mock implementation of the StarredEntitiesApi.
UserListFilterFilters entities based on whatever the user has starred or owns them.

Functions

FunctionDescription
defaultEntityPresentation(entityOrRef, context)This returns the default representation of an entity.
EntityAutocompletePicker(props)
EntityDisplayName(props)Shows a nice representation of a reference to an entity.
EntityRefLink(props)Shows a clickable link to an entity.
EntityRefLinks(props)Shows a list of clickable links to entities.
entityRouteParams(entity)Utility function to get suitable route params for entityRoute, given an
getEntityRelations(entity, relationType, filter)Get the related entity references.
getEntitySourceLocation(entity, scmIntegrationsApi)
humanizeEntityRef(entityRef, opts)
InspectEntityDialog(props)A dialog that lets users inspect the low level details of their entities.
MissingAnnotationEmptyState(props)Renders an empty state when an annotation is missing from an entity.
MockEntityListContextProvider(props)
useAsyncEntity()Grab the current entity from the context, provides loading state and errors, and the ability to refresh.
useEntity()Grab the current entity from the context, throws if the entity has not yet been loaded or is not available.
useEntityList()Hook for interacting with the entity list context provided by the EntityListProvider.
useEntityOwnership()Returns a function that checks whether the currently signed-in user is an owner of a given entity. When the hook is initially mounted, the loading flag will be true and the results returned from the function will always be false.
useEntityPresentation(entityOrRef, context)Returns information about how to represent an entity in the interface.
useEntityTypeFilter()A hook built on top of useEntityList for enabling selection of valid spec.type values based on the selected EntityKindFilter.
useRelatedEntities(entity, relationFilter)Fetches all entities that appear in the entity's relations, optionally filtered by relation type and kind.
useStarredEntities()
useStarredEntity(entityOrRef)

Interfaces

InterfaceDescription
AsyncEntityProviderPropsProperties for the AsyncEntityProvider component.
EntityKindPickerPropsProps for EntityKindPicker.
EntityNamespacePickerPropsProps for EntityNamespacePicker.
EntityPresentationApiAn API that decides how to visually represent entities in the interface.
EntityProviderPropsProperties for the EntityProvider component.
EntityRefPresentationThe visual presentation of an entity reference.
EntityRefPresentationSnapshotThe visual presentation of an entity reference at some point in time.
EntityTablePropsProps for EntityTable.
EntityTypePickerPropsProps for EntityTypePicker.
StarredEntitiesApiAn API to store and retrieve starred entities

Variables

VariableDescription
AsyncEntityProviderProvides a loaded entity to be picked up by the useEntity hook.
catalogApiRefThe API reference for the CatalogApi.
CatalogFilterLayout
columnFactories
DefaultFilters
EntityKindPicker
EntityLifecyclePicker
EntityListContextCreates new context for entity listing and filtering.
EntityListProviderProvides entities and filters for a catalog listing.
EntityNamespacePicker
EntityOwnerPicker
EntityPeekAheadPopoverShows an entity popover on hover of a component.
entityPresentationApiRefAn API that handles how to represent entities in the interface.
EntityProcessingStatusPicker
EntityProviderProvides an entity to be picked up by the useEntity hook.
entityRouteRef

A stable route ref that points to the catalog page for an individual entity.

This RouteRef can be imported and used directly, and does not need to be referenced via an ExternalRouteRef.

If you want to replace the EntityPage from @backstage/catalog-plugin in your app, you need to use the entityRouteRef as the mount point instead of your own.

EntitySearchBarRenders search bar for filtering the entity list.
EntityTableA general entity table component, that can be used for composing more specific entity tables.
EntityTagPicker
EntityTypePicker
FavoriteEntityIconButton for showing if a current entity is starred and adding/removing it from the favorite entities
starredEntitiesApiRefAn API to store starred entities
UnregisterEntityDialog
UserListPicker

Type Aliases

Type AliasDescription
AllowedEntityFilters
BackstageOverrides
CatalogReactComponentsNameToClassKey
CatalogReactEntityAutocompletePickerClassKey
CatalogReactEntityDisplayNameClassKeyThe available style class keys for EntityDisplayName(), under the name "CatalogReactEntityDisplayName".
CatalogReactEntityLifecyclePickerClassKey
CatalogReactEntityNamespacePickerClassKey
CatalogReactEntityOwnerPickerClassKey
CatalogReactEntityProcessingStatusPickerClassKey
CatalogReactEntitySearchBarClassKey
CatalogReactEntityTagPickerClassKey
CatalogReactUserListPickerClassKey
DefaultEntityFilters
DefaultFiltersPropsProps for default filters.
EntityAutocompletePickerProps
EntityDisplayNamePropsProps for EntityDisplayName().
EntityFilter
EntityListContextProps
EntityListProviderProps
EntityLoadingStatus
EntityOwnerPickerProps
EntityPeekAheadPopoverPropsProperties for an entity popover on hover of a component.
EntityRefLinkPropsProps for EntityRefLink().
EntityRefLinksPropsProps for EntityRefLink().
EntitySourceLocation
EntityTagPickerProps
FavoriteEntityProps
MissingAnnotationEmptyStateClassKey
UnregisterEntityDialogProps
UserListFilterKind
UserListPickerProps