From 1680a1c5ac061e58a0d1146310d4de10a00f33d1 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Tue, 14 Dec 2021 15:09:32 +0700 Subject: [PATCH 1/3] Add Missing Overridable Components Type for SidebarSpace, SidebarSpacer, and SidebarDivider Components Signed-off-by: Dede Hamzah --- .changeset/stupid-mice-dream.md | 5 +++++ packages/core-components/src/layout/Sidebar/Items.tsx | 6 ++++++ packages/core-components/src/layout/Sidebar/index.ts | 7 ++++++- packages/core-components/src/overridableComponents.ts | 6 ++++++ 4 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 .changeset/stupid-mice-dream.md diff --git a/.changeset/stupid-mice-dream.md b/.changeset/stupid-mice-dream.md new file mode 100644 index 0000000000..17d2609585 --- /dev/null +++ b/.changeset/stupid-mice-dream.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-components': patch +--- + +Add Missing Overridable Components Type for SidebarSpace, SidebarSpacer, and SidebarDivider Components. diff --git a/packages/core-components/src/layout/Sidebar/Items.tsx b/packages/core-components/src/layout/Sidebar/Items.tsx index c8c6db13a2..dac35bd3a7 100644 --- a/packages/core-components/src/layout/Sidebar/Items.tsx +++ b/packages/core-components/src/layout/Sidebar/Items.tsx @@ -548,6 +548,8 @@ export function SidebarSearchField(props: SidebarSearchFieldProps) { ); } +export type SidebarSpaceClassKey = 'root'; + export const SidebarSpace = styled('div')( { flex: 1, @@ -555,6 +557,8 @@ export const SidebarSpace = styled('div')( { name: 'BackstageSidebarSpace' }, ); +export type SidebarSpacerClassKey = 'root'; + export const SidebarSpacer = styled('div')( { height: 8, @@ -562,6 +566,8 @@ export const SidebarSpacer = styled('div')( { name: 'BackstageSidebarSpacer' }, ); +export type SidebarDividerClassKey = 'root'; + export const SidebarDivider = styled('hr')( { height: 1, diff --git a/packages/core-components/src/layout/Sidebar/index.ts b/packages/core-components/src/layout/Sidebar/index.ts index 79a86023ee..3d922f1322 100644 --- a/packages/core-components/src/layout/Sidebar/index.ts +++ b/packages/core-components/src/layout/Sidebar/index.ts @@ -33,7 +33,12 @@ export { SidebarSpacer, SidebarScrollWrapper, } from './Items'; -export type { SidebarItemClassKey } from './Items'; +export type { + SidebarItemClassKey, + SidebarSpaceClassKey, + SidebarSpacerClassKey, + SidebarDividerClassKey, +} from './Items'; export { IntroCard, SidebarIntro } from './Intro'; export type { SidebarIntroClassKey } from './Intro'; export { diff --git a/packages/core-components/src/overridableComponents.ts b/packages/core-components/src/overridableComponents.ts index 98b8f83abd..c53c47da1b 100644 --- a/packages/core-components/src/overridableComponents.ts +++ b/packages/core-components/src/overridableComponents.ts @@ -83,6 +83,9 @@ import { ItemCardHeaderClassKey, PageClassKey, SidebarClassKey, + SidebarSpaceClassKey, + SidebarSpacerClassKey, + SidebarDividerClassKey, SidebarIntroClassKey, SidebarItemClassKey, SidebarPageClassKey, @@ -157,6 +160,9 @@ type BackstageComponentsNameToClassKey = { BackstageItemCardHeader: ItemCardHeaderClassKey; BackstagePage: PageClassKey; BackstageSidebar: SidebarClassKey; + BackstageSidebarSpace: SidebarSpaceClassKey; + BackstageSidebarSpacer: SidebarSpacerClassKey; + BackstageSidebarDivider: SidebarDividerClassKey; BackstageSidebarIntro: SidebarIntroClassKey; BackstageSidebarItem: SidebarItemClassKey; BackstageSidebarPage: SidebarPageClassKey; From 9c0265a6aa9827f0640c97c1c3ad845f4199e6d4 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Tue, 14 Dec 2021 16:37:13 +0700 Subject: [PATCH 2/3] Update changeset to fix failed Vale Signed-off-by: Dede Hamzah --- .changeset/stupid-mice-dream.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/stupid-mice-dream.md b/.changeset/stupid-mice-dream.md index 17d2609585..2cd2b4e067 100644 --- a/.changeset/stupid-mice-dream.md +++ b/.changeset/stupid-mice-dream.md @@ -2,4 +2,4 @@ '@backstage/core-components': patch --- -Add Missing Overridable Components Type for SidebarSpace, SidebarSpacer, and SidebarDivider Components. +Add Missing Override Components Type for SidebarSpace, SidebarSpacer, and SidebarDivider Components. From 5b54d634778bc962a4e90c20d6b77aef3c9280cb Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Tue, 14 Dec 2021 16:53:31 +0700 Subject: [PATCH 3/3] Add missing api report Signed-off-by: Dede Hamzah --- packages/core-components/api-report.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index d098403113..e12a6e04fe 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -1152,6 +1152,11 @@ export const SidebarDivider: React_2.ComponentType< } >; +// Warning: (ae-missing-release-tag) "SidebarDividerClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type SidebarDividerClassKey = 'root'; + // @public export const SidebarExpandButton: () => JSX.Element | null; @@ -1760,6 +1765,11 @@ export const SidebarSpace: React_2.ComponentType< } >; +// Warning: (ae-missing-release-tag) "SidebarSpaceClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type SidebarSpaceClassKey = 'root'; + // Warning: (ae-missing-release-tag) "SidebarSpacer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -2029,6 +2039,11 @@ export const SidebarSpacer: React_2.ComponentType< } >; +// Warning: (ae-missing-release-tag) "SidebarSpacerClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type SidebarSpacerClassKey = 'root'; + // @public export const SidebarSubmenu: (props: SidebarSubmenuProps) => JSX.Element;