diff --git a/plugins/home-react/report-alpha.api.md b/plugins/home-react/report-alpha.api.md index acc8f629f0..9e30c78bc9 100644 --- a/plugins/home-react/report-alpha.api.md +++ b/plugins/home-react/report-alpha.api.md @@ -6,7 +6,7 @@ import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; import { ExtensionBlueprint } from '@backstage/frontend-plugin-api'; import { ExtensionDataRef } from '@backstage/frontend-plugin-api'; -import { JSX as JSX_2 } from 'react'; +import { ReactElement } from 'react'; import { RJSFSchema } from '@rjsf/utils'; import { TranslationRef } from '@backstage/frontend-plugin-api'; import { UiSchema } from '@rjsf/utils'; @@ -43,19 +43,7 @@ export type ComponentParts = { export const HomepageWidgetBlueprint: ExtensionBlueprint<{ kind: 'home-widget'; params: HomepageWidgetBlueprintParams; - output: - | ExtensionDataRef - | ExtensionDataRef< - { - name?: string; - title?: string; - description?: string; - layout?: CardLayout; - settings?: CardSettings; - }, - 'home.widget.metadata', - {} - >; + output: ExtensionDataRef; inputs: {}; config: {}; configInput: {}; @@ -73,6 +61,23 @@ export interface HomepageWidgetBlueprintParams { title?: string; } +// @alpha +export interface HomePageWidgetData { + component: ReactElement; + description?: string; + layout?: CardLayout; + name?: string; + settings?: CardSettings; + title?: string; +} + +// @alpha +export const homePageWidgetDataRef: ConfigurableExtensionDataRef< + HomePageWidgetData, + 'home.widget.data', + {} +>; + // @alpha export const homeReactTranslationRef: TranslationRef< 'home-react', @@ -82,17 +87,4 @@ export const homeReactTranslationRef: TranslationRef< readonly 'cardExtension.settingsButtonTitle': 'Settings'; } >; - -// @alpha -export const widgetMetadataRef: ConfigurableExtensionDataRef< - { - name?: string; - title?: string; - description?: string; - layout?: CardLayout; - settings?: CardSettings; - }, - 'home.widget.metadata', - {} ->; ``` diff --git a/plugins/home/report-alpha.api.md b/plugins/home/report-alpha.api.md index d84d3e1ce5..6ae6e44bdb 100644 --- a/plugins/home/report-alpha.api.md +++ b/plugins/home/report-alpha.api.md @@ -12,6 +12,7 @@ import { ExtensionBlueprint } from '@backstage/frontend-plugin-api'; import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api'; import { ExtensionDataRef } from '@backstage/frontend-plugin-api'; import { ExtensionInput } from '@backstage/frontend-plugin-api'; +import { HomePageWidgetData } from '@backstage/plugin-home-react/alpha'; import { IconComponent } from '@backstage/core-plugin-api'; import { JSX as JSX_2 } from 'react'; import { OverridableExtensionDefinition } from '@backstage/frontend-plugin-api'; @@ -146,7 +147,7 @@ export const HomepageBlueprint: ExtensionBlueprint<{ >; inputs: { widgets: ExtensionInput< - ConfigurableExtensionDataRef, + ConfigurableExtensionDataRef, { singleton: false; optional: false;