From c6c2942daa1eab026362853afa9bf82363a6c536 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 25 Oct 2021 19:11:14 +0200 Subject: [PATCH] address review comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/unlucky-hotels-roll.md | 5 +++++ packages/core-components/api-report.md | 3 +++ .../src/components/DismissableBanner/DismissableBanner.tsx | 6 ++++++ .../src/components/DismissableBanner/index.ts | 5 ++++- 4 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .changeset/unlucky-hotels-roll.md diff --git a/.changeset/unlucky-hotels-roll.md b/.changeset/unlucky-hotels-roll.md new file mode 100644 index 0000000000..0ba616c2c3 --- /dev/null +++ b/.changeset/unlucky-hotels-roll.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-components': patch +--- + +Deprecated `DismissbleBannerClassKey` and fixed the typo to make `DismissableBannerClassKey` diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 62db9d93fd..cc884c9e8f 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -294,6 +294,9 @@ export type DismissableBannerClassKey = | 'info' | 'error'; +// @public @deprecated (undocumented) +export type DismissbleBannerClassKey = DismissableBannerClassKey; + // @public (undocumented) export function DocsIcon(props: IconComponentProps): JSX.Element; diff --git a/packages/core-components/src/components/DismissableBanner/DismissableBanner.tsx b/packages/core-components/src/components/DismissableBanner/DismissableBanner.tsx index f922689ef4..1213111c9d 100644 --- a/packages/core-components/src/components/DismissableBanner/DismissableBanner.tsx +++ b/packages/core-components/src/components/DismissableBanner/DismissableBanner.tsx @@ -35,6 +35,12 @@ export type DismissableBannerClassKey = | 'info' | 'error'; +/** + * @public + * @deprecated This type contained a typo, please use DismissableBannerClassKey instead + */ +export type DismissbleBannerClassKey = DismissableBannerClassKey; + const useStyles = makeStyles( (theme: BackstageTheme) => ({ root: { diff --git a/packages/core-components/src/components/DismissableBanner/index.ts b/packages/core-components/src/components/DismissableBanner/index.ts index b760c4d8ce..2c1660ec31 100644 --- a/packages/core-components/src/components/DismissableBanner/index.ts +++ b/packages/core-components/src/components/DismissableBanner/index.ts @@ -15,4 +15,7 @@ */ export { DismissableBanner } from './DismissableBanner'; -export type { DismissableBannerClassKey } from './DismissableBanner'; +export type { + DismissableBannerClassKey, + DismissbleBannerClassKey, +} from './DismissableBanner';