You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workspaces/homepage/docs/create-a-new-card.md
+1-33Lines changed: 1 addition & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,48 +38,16 @@ Cards commonly uses the [InfoCard](https://backstage.io/storybook/?path=/story/l
38
38
);
39
39
```
40
40
41
-
3. And finally, users can add them to their `app-config` to expose the component as mount point `home.page/cards` (for default cards) or `home.page/widgets` (for additional plugin cards):
41
+
3. And finally, users can add them to their `app-config` to expose the component as mount point `home.page/cards`:
42
42
43
43
```yaml
44
44
dynamicPlugins:
45
45
frontend:
46
46
your-plugin-id:
47
47
mountPoints:
48
-
# For default cards that appear by default
49
48
- mountPoint: home.page/cards
50
49
importName: YourHomePageCard
51
50
config:
52
-
title: 'My Custom Card'# Title for "Add widget" dialog
53
-
description: 'Description of what it does'# Description for dialog
54
-
layout: ...
55
-
props: ...
56
-
# For additional cards contributed by plugins
57
-
- mountPoint: home.page/widgets
58
-
importName: YourAdditionalCard
59
-
config:
60
-
title: 'Plugin Card'# Title for "Add widget" dialog
61
-
description: 'Card from external plugin'# Description for dialog
62
-
priority: 10# Optional: higher priority appears first
63
51
layout: ...
64
52
props: ...
65
53
```
66
-
67
-
## Configuration Options
68
-
69
-
### Metadata (for "Add widget" dialog)
70
-
71
-
- **`title`** (optional): Display name shown in the "Add widget" dialog
72
-
- **`description`** (optional): Description text shown in the "Add widget" dialog
73
-
74
-
If `title` and `description` are not provided in config, the component will appear in the "Add widget" dialog with its component name or without description.
75
-
76
-
### Layout and Behavior
77
-
78
-
- **`priority`** (optional): Number to control display order (higher priority appears first)
79
-
- **`layouts`**: Responsive layout configuration for different screen sizes
80
-
- **`props`**: Properties passed to the component
81
-
82
-
## Mount Points
83
-
84
-
- **`home.page/cards`** - Default homepage cards that appear by default
85
-
- **`home.page/widgets`** - Additional cards contributed by other plugins that appear alongside default cards
Copy file name to clipboardExpand all lines: workspaces/homepage/docs/index.md
+2-32Lines changed: 2 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,8 @@
1
-
# RHDH Home Page plugin
1
+
# RHDH Home Page pluginpage
2
2
3
3
The RHDH home page plugin is based on the upstream [home plugin](https://github.com/backstage/backstage/blob/master/plugins/home/README.md).
4
4
5
-
It allows primarily **admins** to customize the homepage in the `app-config`, and plugin authors to extend the home page with additional cards or content.
6
-
7
-
## Key Features
8
-
9
-
-**Dual Mount Point System**: Separate default cards from plugin-contributed cards
10
-
-**Config-Based Metadata**: Add titles and descriptions directly in YAML configuration
11
-
-**Customizable Grid**: Drag-and-drop, resizable cards with "Add widget" functionality
12
-
-**Plugin Integration**: Easy integration for external plugins via configuration
13
-
14
-
## Mount Points
15
-
16
-
The plugin supports two mount points:
17
-
18
-
-**`home.page/cards`** - Default homepage cards that appear by default
19
-
-**`home.page/widgets`** - Additional cards contributed by other plugins that appear in the "Add widget" dialog
20
-
21
-
## Configuration-Based Metadata
22
-
23
-
Cards can have titles and descriptions defined directly in the configuration:
24
-
25
-
```yaml
26
-
dynamicPlugins:
27
-
frontend:
28
-
your-plugin:
29
-
mountPoints:
30
-
- mountPoint: home.page/widgets
31
-
importName: YourCard
32
-
config:
33
-
title: 'Your Card Title'
34
-
description: 'Description shown in Add widget dialog'
35
-
```
5
+
It allows primarly **admins** to customize the homepage in the `app-config`, and plugin authors to extend the home page with additional cards or content.
36
6
37
7
The default home page shows a Search input field, a "Quick Access" card, and a "Your Starred Entities" card by default.
0 commit comments