From 51856359bffff8a45212feaea55160c7613d062f Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 4 Mar 2022 11:41:27 +0100 Subject: [PATCH 1/2] catalog: Remove AboutCard Signed-off-by: Johan Haals --- .changeset/brown-points-impress.md | 5 +++++ plugins/catalog/api-report.md | 3 --- plugins/catalog/src/components/AboutCard/AboutCard.tsx | 3 +-- plugins/catalog/src/index.ts | 7 ++++++- 4 files changed, 12 insertions(+), 6 deletions(-) create mode 100644 .changeset/brown-points-impress.md diff --git a/.changeset/brown-points-impress.md b/.changeset/brown-points-impress.md new file mode 100644 index 0000000000..74d5e1019d --- /dev/null +++ b/.changeset/brown-points-impress.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog': minor +--- + +**BREAKING**: Removed the `AboutCard` component which has been replaced by `EntityAboutCard`. diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md index 97a36ad020..7cfa8a581f 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.md @@ -26,9 +26,6 @@ import { TableProps } from '@backstage/core-components'; import { TabProps } from '@material-ui/core'; import { UserListFilterKind } from '@backstage/plugin-catalog-react'; -// @public @deprecated (undocumented) -export function AboutCard(props: AboutCardProps): JSX.Element; - // @public export interface AboutCardProps { // (undocumented) diff --git a/plugins/catalog/src/components/AboutCard/AboutCard.tsx b/plugins/catalog/src/components/AboutCard/AboutCard.tsx index 55cef5a5bd..b634c999f9 100644 --- a/plugins/catalog/src/components/AboutCard/AboutCard.tsx +++ b/plugins/catalog/src/components/AboutCard/AboutCard.tsx @@ -72,7 +72,7 @@ const useStyles = makeStyles({ }); /** - * Props for {@link AboutCard}. + * Props for {@link EntityAboutCard}. * * @public */ @@ -82,7 +82,6 @@ export interface AboutCardProps { /** * @public - * @deprecated Please use EntityAboutCard instead */ export function AboutCard(props: AboutCardProps) { const { variant } = props; diff --git a/plugins/catalog/src/index.ts b/plugins/catalog/src/index.ts index 662a920f8b..cfe4851d09 100644 --- a/plugins/catalog/src/index.ts +++ b/plugins/catalog/src/index.ts @@ -22,7 +22,12 @@ export * from './apis'; -export * from './components/AboutCard'; +export type { + AboutCardProps, + AboutContentProps, + AboutFieldProps, +} from './components/AboutCard'; +export { AboutContent, AboutField } from './components/AboutCard'; export * from './components/CatalogKindHeader'; export * from './components/CatalogSearchResultListItem'; export * from './components/CatalogTable'; From 1549c4be2e98f475cc8157ca01fba0a27de4103f Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 4 Mar 2022 11:51:22 +0100 Subject: [PATCH 2/2] update comment Signed-off-by: Johan Haals --- plugins/catalog/src/components/AboutCard/AboutCard.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/catalog/src/components/AboutCard/AboutCard.tsx b/plugins/catalog/src/components/AboutCard/AboutCard.tsx index b634c999f9..b7ccd49b31 100644 --- a/plugins/catalog/src/components/AboutCard/AboutCard.tsx +++ b/plugins/catalog/src/components/AboutCard/AboutCard.tsx @@ -81,7 +81,7 @@ export interface AboutCardProps { } /** - * @public + * Exported publicly via the EntityAboutCard */ export function AboutCard(props: AboutCardProps) { const { variant } = props;