diff --git a/.changeset/honest-teams-shave.md b/.changeset/honest-teams-shave.md index 931cfd2f63..6afbf37039 100644 --- a/.changeset/honest-teams-shave.md +++ b/.changeset/honest-teams-shave.md @@ -4,6 +4,7 @@ --- Export ContentModal from `@backstage/plugin-home-react` so people can use this in other scenarios. +Renamed `CatalogReactComponentsNameToClassKey` to `PluginHomeComponentsNameToClassKey` in `overridableComponents.ts` Made QuickStartCard `docsLinkTitle` prop more flexible to allow for any React.JSX.Element instead of just a string. Added QuickStartCard prop `additionalContent` which can eventually replace the prop `video`. diff --git a/plugins/home-react/report.api.md b/plugins/home-react/report.api.md index ee14be9a3f..26ef6267aa 100644 --- a/plugins/home-react/report.api.md +++ b/plugins/home-react/report.api.md @@ -13,8 +13,8 @@ import { UiSchema } from '@rjsf/utils'; // @public (undocumented) export type BackstageOverrides = Overrides & { - [Name in keyof CatalogReactComponentsNameToClassKey]?: Partial< - StyleRules + [Name in keyof PluginHomeComponentsNameToClassKey]?: Partial< + StyleRules >; }; @@ -49,11 +49,6 @@ export type CardSettings = { uiSchema?: UiSchema; }; -// @public (undocumented) -export type CatalogReactComponentsNameToClassKey = { - PluginHomeContentModal: PluginHomeContentModalClassKey; -}; - // @public (undocumented) export type ComponentParts = { Content: (props?: any) => JSX.Element; @@ -86,6 +81,11 @@ export function createCardExtension(options: { settings?: CardSettings; }): Extension<(props: CardExtensionProps) => JSX_2.Element>; +// @public (undocumented) +export type PluginHomeComponentsNameToClassKey = { + PluginHomeContentModal: PluginHomeContentModalClassKey; +}; + // @public (undocumented) export type PluginHomeContentModalClassKey = 'contentModal' | 'linkText'; diff --git a/plugins/home-react/src/overridableComponents.ts b/plugins/home-react/src/overridableComponents.ts index e9ee530de0..8a88fd5c94 100644 --- a/plugins/home-react/src/overridableComponents.ts +++ b/plugins/home-react/src/overridableComponents.ts @@ -19,18 +19,18 @@ import { StyleRules } from '@material-ui/core/styles/withStyles'; import { PluginHomeContentModalClassKey } from './'; /** @public */ -export type CatalogReactComponentsNameToClassKey = { +export type PluginHomeComponentsNameToClassKey = { PluginHomeContentModal: PluginHomeContentModalClassKey; }; /** @public */ export type BackstageOverrides = Overrides & { - [Name in keyof CatalogReactComponentsNameToClassKey]?: Partial< - StyleRules + [Name in keyof PluginHomeComponentsNameToClassKey]?: Partial< + StyleRules >; }; declare module '@backstage/theme' { interface OverrideComponentNameToClassKeys - extends CatalogReactComponentsNameToClassKey {} + extends PluginHomeComponentsNameToClassKey {} }