paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 40 Packages Projects Releases Wiki Activity

refactor(home): rename HomepageWidgetBlueprint to HomePageWidgetBlueprint

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
plugins/home/README.md
+4 -4
View File
@@ -114,17 +114,17 @@ app:
Homepage widgets are React components that can be added to customizable home pages. The **key difference** between the new frontend system and legacy system is how these widget components are **registered and exported**:
- **New Frontend System**: Use `HomepageWidgetBlueprint` to register widgets as extensions
- **New Frontend System**: Use `HomePageWidgetBlueprint` to register widgets as extensions
- **Legacy System**: Use `createCardExtension` to export widgets as card components
### New Frontend System
Create widgets using the `HomepageWidgetBlueprint`:
Create widgets using the `HomePageWidgetBlueprint`:
```ts
import { HomepageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';
import { HomePageWidgetBlueprint } from '@backstage/plugin-home-react/alpha';
const myWidget = HomepageWidgetBlueprint.make({
const myWidget = HomePageWidgetBlueprint.make({
name: 'my-widget',
params: {
name: 'MyWidget',