From 5394a94efa772bfba3ded5e79528427529cf9bf0 Mon Sep 17 00:00:00 2001 From: Joe Van Alstyne Date: Tue, 4 Jun 2024 17:09:45 +0900 Subject: [PATCH 1/4] Add columns prop to ConsumingComponentsCard and ProvidingComponentsCard Signed-off-by: Joe Van Alstyne --- .../components/ComponentsCards/ConsumingComponentsCard.tsx | 7 +++++-- .../components/ComponentsCards/ProvidingComponentsCard.tsx | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.tsx b/plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.tsx index 5feb1c96e4..8e461bb08a 100644 --- a/plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.tsx +++ b/plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.tsx @@ -31,6 +31,7 @@ import { InfoCardVariants, Link, Progress, + TableColumn, WarningPanel, } from '@backstage/core-components'; @@ -39,8 +40,10 @@ import { */ export const ConsumingComponentsCard = (props: { variant?: InfoCardVariants; + columns?: TableColumn[]; }) => { - const { variant = 'gridItem' } = props; + const { variant = 'gridItem', columns = EntityTable.componentEntityColumns } = + props; const { entity } = useEntity(); const { entities, loading, error } = useRelatedEntities(entity, { type: RELATION_API_CONSUMED_BY, @@ -82,7 +85,7 @@ export const ConsumingComponentsCard = (props: { } - columns={EntityTable.componentEntityColumns} + columns={columns} entities={entities as ComponentEntity[]} /> ); diff --git a/plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.tsx b/plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.tsx index ef7f2e1071..33dc7217d4 100644 --- a/plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.tsx +++ b/plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.tsx @@ -31,14 +31,17 @@ import { InfoCardVariants, Link, Progress, + TableColumn, WarningPanel, } from '@backstage/core-components'; /** @public */ export const ProvidingComponentsCard = (props: { variant?: InfoCardVariants; + columns?: TableColumn[]; }) => { - const { variant = 'gridItem' } = props; + const { variant = 'gridItem', columns = EntityTable.componentEntityColumns } = + props; const { entity } = useEntity(); const { entities, loading, error } = useRelatedEntities(entity, { type: RELATION_API_PROVIDED_BY, @@ -80,7 +83,7 @@ export const ProvidingComponentsCard = (props: { } - columns={EntityTable.componentEntityColumns} + columns={columns} entities={entities as ComponentEntity[]} /> ); From 770ba02d32c0ca365b360b516ddbd298142b55f7 Mon Sep 17 00:00:00 2001 From: Joe Van Alstyne Date: Tue, 4 Jun 2024 17:17:21 +0900 Subject: [PATCH 2/4] Add changeset Signed-off-by: Joe Van Alstyne --- .changeset/forty-geckos-change.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/forty-geckos-change.md diff --git a/.changeset/forty-geckos-change.md b/.changeset/forty-geckos-change.md new file mode 100644 index 0000000000..e7ac112f57 --- /dev/null +++ b/.changeset/forty-geckos-change.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-api-docs': patch +--- + +Custom columns can now be optionally provided to ConsumingComponentsCard and ProvidingComponentsCard From 74c0e7712e803c8fcdf22ab59a725a22394e3dbe Mon Sep 17 00:00:00 2001 From: Joe Van Alstyne Date: Tue, 4 Jun 2024 17:20:09 +0900 Subject: [PATCH 3/4] Update api-report.md Signed-off-by: Joe Van Alstyne --- plugins/api-docs/api-report.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index 2fc852777b..65cc421b78 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -9,6 +9,7 @@ import { ApiEntity } from '@backstage/catalog-model'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CatalogTableRow } from '@backstage/plugin-catalog'; +import { ComponentEntity } from '@backstage/catalog-model'; import { EntityOwnerPickerProps } from '@backstage/plugin-catalog-react'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { InfoCardVariants } from '@backstage/core-components'; @@ -94,6 +95,7 @@ export const ConsumedApisCard: (props: { // @public (undocumented) export const ConsumingComponentsCard: (props: { variant?: InfoCardVariants; + columns?: TableColumn[]; }) => React_2.JSX.Element; // @public @@ -124,6 +126,7 @@ export const EntityConsumedApisCard: (props: { // @public (undocumented) export const EntityConsumingComponentsCard: (props: { variant?: InfoCardVariants | undefined; + columns?: TableColumn[] | undefined; }) => JSX_2.Element; // @public (undocumented) @@ -141,6 +144,7 @@ export const EntityProvidedApisCard: (props: { // @public (undocumented) export const EntityProvidingComponentsCard: (props: { variant?: InfoCardVariants | undefined; + columns?: TableColumn[] | undefined; }) => JSX_2.Element; // @public (undocumented) @@ -191,6 +195,7 @@ export const ProvidedApisCard: (props: { // @public (undocumented) export const ProvidingComponentsCard: (props: { variant?: InfoCardVariants; + columns?: TableColumn[]; }) => React_2.JSX.Element; // @public (undocumented) From 2881a03ebb35cb9e2becf199b90f252d0dedef59 Mon Sep 17 00:00:00 2001 From: Joe Van Alstyne Date: Tue, 4 Jun 2024 17:32:31 +0900 Subject: [PATCH 4/4] Update changeset Signed-off-by: Joe Van Alstyne --- .changeset/forty-geckos-change.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/forty-geckos-change.md b/.changeset/forty-geckos-change.md index e7ac112f57..484a485670 100644 --- a/.changeset/forty-geckos-change.md +++ b/.changeset/forty-geckos-change.md @@ -2,4 +2,4 @@ '@backstage/plugin-api-docs': patch --- -Custom columns can now be optionally provided to ConsumingComponentsCard and ProvidingComponentsCard +`ConsumingComponentsCard` and `ProvidingComponentsCard` will now optionally accept `columns` to override which table columns are displayed