@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). |
| 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 |
| 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 |
|---|---|
| EntityAutocompletePicker(props) | |
| 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. |
| 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. |
| 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
| Interface | Description |
|---|---|
| AsyncEntityProviderProps | Properties for the AsyncEntityProvider component. |
| EntityKindPickerProps | Props for EntityKindPicker. |
| EntityProviderProps | Properties for the EntityProvider component. |
| EntityTableProps | Props for EntityTable. |
| EntityTypePickerProps | Props for EntityTypePicker. |
| StarredEntitiesApi | An API to store and retrieve starred entities |
Variables
| Variable | Description |
|---|---|
| AsyncEntityProvider | Provides a loaded entity to be picked up by the useEntity hook. |
| catalogApiRef | The API reference for the CatalogApi. |
| CatalogFilterLayout | |
| columnFactories | |
| EntityKindPicker | |
| EntityLifecyclePicker | |
| EntityListContext | Creates new context for entity listing and filtering. |
| EntityListProvider | Provides entities and filters for a catalog listing. |
| EntityNamespacePicker | |
| EntityOwnerPicker | |
| EntityPeekAheadPopover | Shows an entity popover on hover of a component. |
| EntityProcessingStatusPicker | |
| EntityProvider | Provides 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 If you want to replace the |
| EntitySearchBar | Renders search bar for filtering the entity list. |
| EntityTable | A general entity table component, that can be used for composing more specific entity tables. |
| EntityTagPicker | |
| EntityTypePicker | |
| FavoriteEntity | IconButton for showing if a current entity is starred and adding/removing it from the favorite entities |
| starredEntitiesApiRef | An API to store starred entities |
| UnregisterEntityDialog | |
| UserListPicker |