refactor(home): rename HomepageWidgetBlueprint to HomePageWidgetBlueprint

Align naming convention with HomePageLayoutBlueprint and the catalog
plugin's consistent entity- prefix pattern. Also update the kind string
from 'home-widget' to 'home-page-widget' to match 'home-page-layout'.
Added interface-level JSDoc to HomePageWidgetBlueprintParams.
Signed-off-by: Adam Kunicki <kunickiaj@gmail.com>
This commit is contained in:
Adam Kunicki
2026-02-07 05:11:35 -08:00
parent 1ba0ee341a
commit e4544fb773
6 changed files with 26 additions and 22 deletions
+3 -3
View File
@@ -25,9 +25,9 @@
*/
export { homeReactTranslationRef } from './translation';
export {
HomepageWidgetBlueprint,
type HomepageWidgetBlueprintParams,
} from './alpha/blueprints/HomepageWidgetBlueprint';
HomePageWidgetBlueprint,
type HomePageWidgetBlueprintParams,
} from './alpha/blueprints/HomePageWidgetBlueprint';
export {
HomePageLayoutBlueprint,
type HomePageLayoutBlueprintParams,
@@ -28,8 +28,12 @@ import {
} from '../../extensions';
import { homePageWidgetDataRef } from '../dataRefs';
/** @alpha */
export interface HomepageWidgetBlueprintParams {
/**
* Parameters for creating a home page widget extension.
*
* @alpha
*/
export interface HomePageWidgetBlueprintParams {
/**
* Optional name for the widget. If not provided, the extension will use only its kind
* in the extension ID.
@@ -71,14 +75,14 @@ const DEFAULT_WIDGET_ATTACH_POINT = {
*
* @alpha
*/
export const HomepageWidgetBlueprint = createExtensionBlueprint({
kind: 'home-widget',
export const HomePageWidgetBlueprint = createExtensionBlueprint({
kind: 'home-page-widget',
attachTo: DEFAULT_WIDGET_ATTACH_POINT,
dataRefs: {
widget: homePageWidgetDataRef,
},
output: [homePageWidgetDataRef],
*factory(params: HomepageWidgetBlueprintParams, { node }) {
*factory(params: HomePageWidgetBlueprintParams, { node }) {
const isCustomizable = params.settings?.schema !== undefined;
const LazyCard = lazy(() =>
params.components().then(parts => ({