@backstage/plugin-catalog-react

Home > @backstage/plugin-catalog-react

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

Classes

Class	Description
EntityErrorFilter	Filters entities based on if it has errors or not.
EntityKindFilter	Filter entities based on Kind.
EntityLifecycleFilter	Filters entities on lifecycle.
EntityNamespaceFilter	Filters entities to those within the given namespace(s).
EntityOrderFilter	Sort entities by a given field/column.
EntityOrphanFilter	Filters 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.
EntityTagFilter	Filters entities based on tag.
EntityTextFilter	Filters entities where the text matches spec, title or tags.
EntityTypeFilter	Filters entities based on type
EntityUserFilter
MockStarredEntitiesApi	An in-memory mock implementation of the StarredEntitiesApi.
UserListFilter	Filters entities based on whatever the user has starred or owns them.

Functions

Function	Description
AsyncEntityProvider(props)	Provides a loaded entity to be picked up by the useEntity hook.
CatalogAutocomplete(props)
defaultEntityPresentation(entityOrRef, context)	This returns the default representation of an entity.
DefaultFilters(props)
EntityAutocompletePicker(props)
EntityDisplayName(props)	Shows a nice representation of a reference to an entity.
EntityKindPicker(props)
EntityLifecyclePicker(props)
EntityListProvider(props)	Provides entities and filters for a catalog listing.
EntityNamespacePicker(props)
EntityOwnerPicker(props)
EntityPeekAheadPopover(props)	Shows an entity popover on hover of a component.
EntityProcessingStatusPicker()
EntityProvider(props)	Provides an entity to be picked up by the useEntity hook.
EntityRefLink(props)	Shows a clickable link to an entity.
EntityRefLinks(props)	Shows a list of clickable links to entities.
entityRouteParams(entityOrRef, options)	Utility function to get suitable route params for entityRoute, given an
EntitySearchBar()	Renders search bar for filtering the entity list.
EntityTagPicker(props)
EntityTypePicker(props)
FavoriteEntity(props)	IconButton for showing if a current entity is starred and adding/removing it from the favorite entities
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)
UnregisterEntityDialog(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.
UserListPicker(props)
useStarredEntities()
useStarredEntity(entityOrRef)

Interfaces

Interface	Description
AsyncEntityProviderProps	Properties for the AsyncEntityProvider component.
EntityKindPickerProps	Props for EntityKindPicker().
EntityNamespacePickerProps	Props for EntityNamespacePicker().
EntityPresentationApi	An API that decides how to visually represent entities in the interface.
EntityProviderProps	Properties for the EntityProvider component.
EntityRefPresentation	The visual presentation of an entity reference.
EntityRefPresentationSnapshot	The visual presentation of an entity reference at some point in time.
EntityTableProps	Props for EntityTable.
EntityTypePickerProps	Props for EntityTypePicker().
StarredEntitiesApi	An API to store and retrieve starred entities

Variables

Variable	Description
catalogApiRef	The API reference for the CatalogApi.
CatalogFilterLayout
columnFactories
EntityListContext	Creates new context for entity listing and filtering.
entityPresentationApiRef	An API that handles how to represent entities in the interface.
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.
EntityTable	A general entity table component, that can be used for composing more specific entity tables.
starredEntitiesApiRef	An API to store starred entities

Type Aliases

Type Alias	Description
AllowedEntityFilters
BackstageOverrides
CatalogAutocompleteProps	Props for CatalogAutocomplete()
CatalogReactComponentsNameToClassKey
CatalogReactEntityAutocompletePickerClassKey
CatalogReactEntityDisplayNameClassKey	The available style class keys for EntityDisplayName(), under the name "CatalogReactEntityDisplayName".
CatalogReactEntityLifecyclePickerClassKey
CatalogReactEntityNamespacePickerClassKey
CatalogReactEntityOwnerPickerClassKey
CatalogReactEntityProcessingStatusPickerClassKey
CatalogReactEntitySearchBarClassKey
CatalogReactEntityTagPickerClassKey
CatalogReactUserListPickerClassKey
DefaultEntityFilters
DefaultFiltersProps	Props for default filters.
EntityAutocompletePickerProps
EntityDisplayNameProps	Props for EntityDisplayName().
EntityFilter
EntityListContextProps
EntityListPagination
EntityListProviderProps
EntityLoadingStatus
EntityOwnerPickerProps
EntityPeekAheadPopoverProps	Properties for an entity popover on hover of a component.
EntityRefLinkProps	Props for EntityRefLink().
EntityRefLinksProps	Props for EntityRefLink().
EntityRouteParamsOptions	Configurable options for entityRouteParams
EntitySourceLocation
EntityTagPickerProps
FavoriteEntityProps
FixedWidthFormControlLabelClassKey
MissingAnnotationEmptyStateClassKey
PaginationMode
UnregisterEntityDialogProps
UserListFilterKind
UserListPickerProps