From c534ef2242b2f4baf400f3f7a870586400b81986 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 4 Jan 2022 11:03:45 +0100 Subject: [PATCH] core-plugin-api: deprecate OldIconComponent Signed-off-by: Patrik Oldsberg --- .changeset/late-stingrays-invite.md | 5 +++++ packages/core-plugin-api/api-report.md | 2 +- packages/core-plugin-api/src/icons/types.ts | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .changeset/late-stingrays-invite.md diff --git a/.changeset/late-stingrays-invite.md b/.changeset/late-stingrays-invite.md new file mode 100644 index 0000000000..2efecf246d --- /dev/null +++ b/.changeset/late-stingrays-invite.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-plugin-api': patch +--- + +Deprecated `OldIconComponent`. Existing usage should be replaced with `IconComponent`. diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index 928a90cee5..3a4c7580b2 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -623,7 +623,7 @@ export const oktaAuthApiRef: ApiRef< SessionApi >; -// @public +// @public @deprecated export type OldIconComponent = ComponentType; // @alpha diff --git a/packages/core-plugin-api/src/icons/types.ts b/packages/core-plugin-api/src/icons/types.ts index 5648261f3c..849561f9c0 100644 --- a/packages/core-plugin-api/src/icons/types.ts +++ b/packages/core-plugin-api/src/icons/types.ts @@ -43,5 +43,6 @@ export type IconComponent = ComponentType<{ * migration, but it is not exported. * * @public + * @deprecated This type will be removed, use {@link IconComponent} instead. */ export type OldIconComponent = ComponentType;