Skip to main content
Version: Next

CatalogTable

Home > @backstage/plugin-catalog > CatalogTable

CatalogTable is a wrapper around the Table component that is pre-configured to display catalog entities.

Signature:

CatalogTable: {
(props: CatalogTableProps): React.JSX.Element;
columns: Readonly<{
createNameColumn(options?: {
defaultKind?: string | undefined;
} | undefined): TableColumn<CatalogTableRow>;
createSystemColumn(): TableColumn<CatalogTableRow>;
createOwnerColumn(): TableColumn<CatalogTableRow>;
createSpecTargetsColumn(): TableColumn<CatalogTableRow>;
createSpecTypeColumn(options?: {
hidden: boolean;
}): TableColumn<CatalogTableRow>;
createSpecLifecycleColumn(): TableColumn<CatalogTableRow>;
createMetadataDescriptionColumn(): TableColumn<CatalogTableRow>;
createTagsColumn(): TableColumn<CatalogTableRow>;
createTitleColumn(options?: {
hidden?: boolean | undefined;
} | undefined): TableColumn<CatalogTableRow>;
createLabelColumn(key: string, options?: {
title?: string | undefined;
defaultValue?: string | undefined;
} | undefined): TableColumn<CatalogTableRow>;
createNamespaceColumn(): TableColumn<CatalogTableRow>;
}>;
defaultColumnsFunc: CatalogTableColumnsFunc;
}

Remarks

See https://backstage.io/docs/features/software-catalog/catalog-customization