From 9adc5526021605b88ba42e14799f1361321b9449 Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Mon, 9 Sep 2024 18:12:12 -0500 Subject: [PATCH] Refactoring based on feedback Signed-off-by: Andre Wanlin --- .changeset/sour-cherries-allow.md | 7 +++++++ .changeset/ten-numbers-vanish.md | 2 -- .changeset/tough-plants-divide.md | 7 +++++++ packages/core-components/api-report.md | 3 --- .../components/EmptyState/MissingAnnotationEmptyState.tsx | 6 ------ .../core-components/src/components/EmptyState/index.ts | 1 - packages/core-components/src/overridableComponents.ts | 6 ++---- plugins/catalog-react/api-report.md | 4 ++-- plugins/catalog-react/src/overridableComponents.ts | 4 ++-- plugins/catalog/api-report.md | 4 ++-- plugins/catalog/src/overridableComponents.ts | 4 ++-- plugins/search-react/src/overridableComponents.ts | 2 +- 12 files changed, 25 insertions(+), 25 deletions(-) create mode 100644 .changeset/sour-cherries-allow.md create mode 100644 .changeset/tough-plants-divide.md diff --git a/.changeset/sour-cherries-allow.md b/.changeset/sour-cherries-allow.md new file mode 100644 index 0000000000..4b4dc5aa22 --- /dev/null +++ b/.changeset/sour-cherries-allow.md @@ -0,0 +1,7 @@ +--- +'@backstage/core-components': patch +--- + +Added missing items to `overridableComponents` + +**BREAKING** Overridable component name for styling `OAuthRequestDialog` changed to `BackstageOAuthRequestDialog`. Overridable component name `BackstageMissingAnnotationEmptyState` that was previously deprecated has been removed. diff --git a/.changeset/ten-numbers-vanish.md b/.changeset/ten-numbers-vanish.md index a4502688ce..bca3f6ba56 100644 --- a/.changeset/ten-numbers-vanish.md +++ b/.changeset/ten-numbers-vanish.md @@ -1,7 +1,5 @@ --- -'@backstage/core-components': patch '@backstage/plugin-catalog-graph': patch -'@backstage/plugin-catalog-react': patch '@backstage/plugin-search-react': patch '@backstage/plugin-catalog': patch '@backstage/plugin-home': patch diff --git a/.changeset/tough-plants-divide.md b/.changeset/tough-plants-divide.md new file mode 100644 index 0000000000..210be1d962 --- /dev/null +++ b/.changeset/tough-plants-divide.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-catalog-react': patch +--- + +Added missing items to `overridableComponents` + +**BREAKING** Overridable component name for styling `BackstageMissingAnnotationEmptyState` has been changed to `CatalogReactMissingAnnotationEmptyState` diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 370df346d1..9b4e9f6798 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -800,9 +800,6 @@ export function MissingAnnotationEmptyState( props: Props_3, ): React_2.JSX.Element; -// @public @deprecated (undocumented) -export type MissingAnnotationEmptyStateClassKey = 'code'; - // @public export const MobileSidebar: ( props: MobileSidebarProps, diff --git a/packages/core-components/src/components/EmptyState/MissingAnnotationEmptyState.tsx b/packages/core-components/src/components/EmptyState/MissingAnnotationEmptyState.tsx index e185dff8a6..31168b4ac7 100644 --- a/packages/core-components/src/components/EmptyState/MissingAnnotationEmptyState.tsx +++ b/packages/core-components/src/components/EmptyState/MissingAnnotationEmptyState.tsx @@ -49,12 +49,6 @@ type Props = { readMoreUrl?: string; }; -/** - * @public - * @deprecated This component is deprecated, please use {@link @backstage/plugin-catalog-react#MissingAnnotationEmptyStateClassKey} instead - */ -export type MissingAnnotationEmptyStateClassKey = 'code'; - const useStyles = makeStyles( theme => ({ code: { diff --git a/packages/core-components/src/components/EmptyState/index.ts b/packages/core-components/src/components/EmptyState/index.ts index 2696fba850..70e113833a 100644 --- a/packages/core-components/src/components/EmptyState/index.ts +++ b/packages/core-components/src/components/EmptyState/index.ts @@ -18,4 +18,3 @@ export { EmptyState } from './EmptyState'; export type { EmptyStateClassKey } from './EmptyState'; export type { EmptyStateImageClassKey } from './EmptyStateImage'; export { MissingAnnotationEmptyState } from './MissingAnnotationEmptyState'; -export type { MissingAnnotationEmptyStateClassKey } from './MissingAnnotationEmptyState'; diff --git a/packages/core-components/src/overridableComponents.ts b/packages/core-components/src/overridableComponents.ts index c5ab003b0d..df6db52094 100644 --- a/packages/core-components/src/overridableComponents.ts +++ b/packages/core-components/src/overridableComponents.ts @@ -25,7 +25,6 @@ import { DismissableBannerClassKey, EmptyStateClassKey, EmptyStateImageClassKey, - MissingAnnotationEmptyStateClassKey, ErrorPanelClassKey, FeatureCalloutCircleClassKey, HeaderIconLinkRowClassKey, @@ -107,7 +106,6 @@ type BackstageComponentsNameToClassKey = { BackstageDismissableBanner: DismissableBannerClassKey; BackstageEmptyState: EmptyStateClassKey; BackstageEmptyStateImage: EmptyStateImageClassKey; - BackstageMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey; BackstageErrorPanel: ErrorPanelClassKey; BackstageFeatureCalloutCircular: FeatureCalloutCircleClassKey; BackstageHeaderIconLinkRow: HeaderIconLinkRowClassKey; @@ -117,7 +115,7 @@ type BackstageComponentsNameToClassKey = { BackstageMarkdownContent: MarkdownContentClassKey; BackstageLoginRequestListItem: LoginRequestListItemClassKey; BackstageLogViewer: LogViewerClassKey; - OAuthRequestDialog: OAuthRequestDialogClassKey; + BackstageOAuthRequestDialog: OAuthRequestDialogClassKey; BackstageOverflowTooltip: OverflowTooltipClassKey; BackstageGauge: GaugeClassKey; BackstageGaugeCard: GaugeCardClassKey; @@ -173,7 +171,7 @@ type BackstageComponentsNameToClassKey = { BackstageTabbedCard: TabbedCardClassKey; BackstageTabbedCardBoldHeader: BoldHeaderClassKey; BackstageCardTab: CardTabClassKey; - Link: LinkClassKey; + BackstageLink: LinkClassKey; BackstageFavoriteToggleIcon: FavoriteToggleIconClassKey; }; diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 954dd28ac0..0293fca239 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -92,10 +92,10 @@ export type CatalogReactComponentsNameToClassKey = { CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey; CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey; CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey; - FixedWidthFormControlLabel: FixedWidthFormControlLabelClassKey; + CatalogReactFixedWidthFormControlLabel: FixedWidthFormControlLabelClassKey; CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey; CatalogReactEntityAutocompletePickerClassKey: CatalogReactEntityAutocompletePickerClassKey; - BackstageMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey; + CatalogReactMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey; }; // @public (undocumented) diff --git a/plugins/catalog-react/src/overridableComponents.ts b/plugins/catalog-react/src/overridableComponents.ts index 96bb069fd2..1b27a350da 100644 --- a/plugins/catalog-react/src/overridableComponents.ts +++ b/plugins/catalog-react/src/overridableComponents.ts @@ -38,10 +38,10 @@ export type CatalogReactComponentsNameToClassKey = { CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey; CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey; CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey; - FixedWidthFormControlLabel: FixedWidthFormControlLabelClassKey; + CatalogReactFixedWidthFormControlLabel: FixedWidthFormControlLabelClassKey; CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey; CatalogReactEntityAutocompletePickerClassKey: CatalogReactEntityAutocompletePickerClassKey; - BackstageMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey; + CatalogReactMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey; }; /** @public */ diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md index 5a37f69885..535269dfca 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.md @@ -632,8 +632,8 @@ export type PluginCatalogComponentsNameToClassKey = { PluginCatalogEntityLinksEmptyState: EntityLinksEmptyStateClassKey; PluginCatalogSystemDiagramCard: SystemDiagramCardClassKey; PluginCatalogEntityContextMenu: EntityContextMenuClassKey; - CatalogSearchResultListItem: CatalogSearchResultListItemClassKey; - pluginCatalogTableToolbar: CatalogTableToolbarClassKey; + PluginCatalogSearchResultListItem: CatalogSearchResultListItemClassKey; + PluginCatalogTableToolbar: CatalogTableToolbarClassKey; PluginCatalogEntityLabelsEmptyState: EntityLabelsEmptyStateClassKey; }; diff --git a/plugins/catalog/src/overridableComponents.ts b/plugins/catalog/src/overridableComponents.ts index 3846240dd4..c700566b97 100644 --- a/plugins/catalog/src/overridableComponents.ts +++ b/plugins/catalog/src/overridableComponents.ts @@ -28,8 +28,8 @@ export type PluginCatalogComponentsNameToClassKey = { PluginCatalogEntityLinksEmptyState: EntityLinksEmptyStateClassKey; PluginCatalogSystemDiagramCard: SystemDiagramCardClassKey; PluginCatalogEntityContextMenu: EntityContextMenuClassKey; - CatalogSearchResultListItem: CatalogSearchResultListItemClassKey; - pluginCatalogTableToolbar: CatalogTableToolbarClassKey; + PluginCatalogSearchResultListItem: CatalogSearchResultListItemClassKey; + PluginCatalogTableToolbar: CatalogTableToolbarClassKey; PluginCatalogEntityLabelsEmptyState: EntityLabelsEmptyStateClassKey; }; diff --git a/plugins/search-react/src/overridableComponents.ts b/plugins/search-react/src/overridableComponents.ts index 8b6bff8514..be921ebf04 100644 --- a/plugins/search-react/src/overridableComponents.ts +++ b/plugins/search-react/src/overridableComponents.ts @@ -20,7 +20,7 @@ import { HighlightedSearchResultTextClassKey } from './components'; /** @public */ export type CatalogReactComponentsNameToClassKey = { - BackstageHighlightedSearchResultText: HighlightedSearchResultTextClassKey; + SearchReactHighlightedSearchResultText: HighlightedSearchResultTextClassKey; }; /** @public */