@backstage/plugin-catalog-react
Home > @backstage/plugin-catalog-react
A frontend library that helps other Backstage plugins interact with the catalog
Classes
Class |
Description |
---|---|
Filters entities based on if it has errors or not. | |
Filter entities based on Kind. | |
Filters entities on lifecycle. | |
Filters entities to those within the given namespace(s). | |
Filters entities based if it is an orphan or not. | |
Filter matching entities that are owned by group. CAUTION: This class may contain both full and partial entity refs. | |
Filters entities based on tag. | |
Filters entities where the text matches spec, title or tags. | |
Filters entities based on type | |
An in-memory mock implementation of the StarredEntitiesApi. | |
Filters entities based on whatever the user has starred or owns them. |
Functions
Function |
Description |
---|---|
Provides a loaded entity to be picked up by the | |
This returns the default representation of an entity. | |
Shows a nice representation of a reference to an entity. | |
Provides entities and filters for a catalog listing. | |
Shows an entity popover on hover of a component. | |
Provides an entity to be picked up by the | |
Shows a clickable link to an entity. | |
Shows a list of clickable links to entities. | |
Utility function to get suitable route params for entityRoute, given an | |
Renders search bar for filtering the entity list. | |
IconButton for showing if a current entity is starred and adding/removing it from the favorite entities | |
Get the related entity references. | |
A dialog that lets users inspect the low level details of their entities. | |
Renders an empty state when an annotation is missing from an entity. | |
Grab the current entity from the context, provides loading state and errors, and the ability to refresh. | |
Grab the current entity from the context, throws if the entity has not yet been loaded or is not available. | |
Hook for interacting with the entity list context provided by the EntityListProvider(). | |
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. | |
Returns information about how to represent an entity in the interface. | |
A hook built on top of | |
Fetches all entities that appear in the entity's relations, optionally filtered by relation type and kind. | |
Interfaces
Interface |
Description |
---|---|
Properties for the AsyncEntityProvider component. | |
Props for EntityKindPicker(). | |
Props for EntityNamespacePicker(). | |
An API that decides how to visually represent entities in the interface. | |
Properties for the EntityProvider component. | |
The visual presentation of an entity reference. | |
The visual presentation of an entity reference at some point in time. | |
Props for EntityTable. | |
Props for EntityTypePicker(). | |
An API to store and retrieve starred entities |
Variables
Variable |
Description |
---|---|
The API reference for the CatalogApi. | |
Creates new context for entity listing and filtering. | |
An API that handles how to represent entities in the interface. | |
A stable route ref that points to the catalog page for an individual entity. This If you want to replace the | |
A general entity table component, that can be used for composing more specific entity tables. | |
An API to store starred entities |
Type Aliases
Type Alias |
Description |
---|---|
The available style class keys for EntityDisplayName(), under the name "CatalogReactEntityDisplayName". | |
Props for default filters. | |
Props for EntityDisplayName(). | |
Properties for an entity popover on hover of a component. | |
Props for EntityRefLink(). | |
Props for EntityRefLink(). | |