@@ -50,12 +50,12 @@ submenus.
50
50
|`submenu` |`boolean` |yes |Whether this group should be displayed as
51
51
submenu
52
52
53
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
53
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
54
54
item referenced here.For arrays, the first one found in order is used.
55
55
56
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
56
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
57
57
item referenced here.For arrays, the first one found in order is
58
- used.insertBefore takes precedence.
58
+ used. The ` insertBefore` value takes precedence.
59
59
|===
60
60
61
61
'''''
@@ -119,7 +119,9 @@ which returns actions for the given resource model
119
119
|===
120
120
|Name |Value Type |Optional |Description
121
121
|`alert` |`string` |no |
122
+
122
123
|`text` |`string` |no |
124
+
123
125
|`action` |`CodeRef<(alert: any) => void>` |no |
124
126
|===
125
127
@@ -137,13 +139,13 @@ which returns actions for the given resource model
137
139
[cols=",,,",options="header",]
138
140
|===
139
141
|Name |Value Type |Optional |Description
140
- |`catalogId` |`string | string[]` |no |The unique identifier for the
142
+ |`catalogId` |`string` \| ` string[]` |no |The unique identifier for the
141
143
catalog this provider contributes to.
142
144
143
145
|`type` |`string` |no |Type ID for the catalog item type.
144
146
145
147
|`filter` |`CodeRef<(item: CatalogItem) => boolean>` |no |Filters items
146
- of a specific type. Value is a function that takes CatalogItem[] and
148
+ of a specific type. Value is a function that takes ` CatalogItem[]` and
147
149
returns a subset based on the filter criteria.
148
150
|===
149
151
@@ -161,7 +163,7 @@ returns a subset based on the filter criteria.
161
163
[cols=",,,",options="header",]
162
164
|===
163
165
|Name |Value Type |Optional |Description
164
- |`catalogId` |`string | string[]` |no |The unique identifier for the
166
+ |`catalogId` |`string` \| ` string[]` |no |The unique identifier for the
165
167
catalog this provider contributes to.
166
168
167
169
|`type` |`string` |no |Type ID for the catalog item type.
@@ -186,7 +188,7 @@ metadata to catalog items of a specific type.
186
188
[cols=",,,",options="header",]
187
189
|===
188
190
|Name |Value Type |Optional |Description
189
- |`catalogId` |`string | string[]` |no |The unique identifier for the
191
+ |`catalogId` |`string` \| ` string[]` |no |The unique identifier for the
190
192
catalog this provider contributes to.
191
193
192
194
|`type` |`string` |no |Type ID for the catalog item type.
@@ -221,7 +223,7 @@ providers.
221
223
222
224
|`title` |`string` |no |Title for the catalog item.
223
225
224
- |`catalogDescription` |`string | CodeRef<React.ReactNode>` |yes
226
+ |`catalogDescription` |`string` \| ` CodeRef<React.ReactNode>` |yes
225
227
|Description for the type specific catalog.
226
228
227
229
|`typeDescription` |`string` |yes |Description for the catalog item
@@ -370,7 +372,7 @@ Adds a new dashboard card.
370
372
|`tab` |`string` |no |The id of the dashboard tab to which the card will
371
373
be added.
372
374
373
- |`position` |`'LEFT' | 'RIGHT' | 'MAIN'` |no |The grid position of the
375
+ |`position` |`'LEFT' \ | 'RIGHT' \ | 'MAIN'` |no |The grid position of the
374
376
card on the dashboard.
375
377
376
378
|`component` |`CodeRef<React.ComponentType<{}>>` |no |Dashboard card
@@ -448,7 +450,7 @@ the source of status is a K8s REST API.
448
450
which will be fetched and passed to `healthHandler`.
449
451
450
452
|`getOperatorsWithStatuses` |`CodeRef<GetOperatorsWithStatuses<T>>` |yes
451
- |Resolves status for the operators .
453
+ |Resolves status for the Operators .
452
454
453
455
|`operatorRowLoader`
454
456
|`CodeRef<React.ComponentType<OperatorRowProps<T>>>` |yes |Loader for
@@ -601,7 +603,7 @@ Adds an inventory status group.
601
603
|`id` |`string` |no |The id of the status group.
602
604
603
605
|`icon`
604
- |`CodeRef<React.ReactElement<any, string | React.JSXElementConstructor<any>>>`
606
+ |`CodeRef<React.ReactElement<any, string` \| ` React.JSXElementConstructor<any>>>`
605
607
|no |React component representing the status group icon.
606
608
|===
607
609
@@ -695,7 +697,7 @@ Adds a new dashboard tab, placed after the Overview tab.
695
697
|`id` |`string` |no |A unique tab identifier, used as tab link `href`
696
698
and when adding cards to this tab.
697
699
698
- |`navSection` |`'home' | 'storage'` |no |NavSection to which the tab
700
+ |`navSection` |`'home' \ | 'storage'` |no |NavSection to which the tab
699
701
belongs to
700
702
701
703
|`title` |`string` |no |The title of the tab.
@@ -871,18 +873,18 @@ attributes to the DOM.
871
873
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
872
874
starts with one of these paths.
873
875
874
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
876
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
875
877
item referenced here. For arrays, the first one found in order is used.
876
878
877
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
879
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
878
880
item referenced here. For arrays, the first one found in order is used.
879
881
`insertBefore` takes precedence.
880
882
881
- |`namespaced` |`boolean` |yes |if true, adds /ns/active-namespace to the
883
+ |`namespaced` |`boolean` |yes |If true, adds ` /ns/active-namespace` to the
882
884
end
883
885
884
- |`prefixNamespaced` |`boolean` |yes |if true, adds
885
- /k8s/ns/active-namespace to the begining
886
+ |`prefixNamespaced` |`boolean` |yes |If true, adds
887
+ ` /k8s/ns/active-namespace` to the beginning
886
888
|===
887
889
888
890
'''''
@@ -916,10 +918,10 @@ attributes to the DOM.
916
918
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
917
919
starts with one of these paths.
918
920
919
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
921
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
920
922
item referenced here. For arrays, the first one found in order is used.
921
923
922
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
924
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
923
925
item referenced here. For arrays, the first one found in order is used.
924
926
`insertBefore` takes precedence.
925
927
@@ -958,10 +960,10 @@ attributes to the DOM.
958
960
|`startsWith` |`string[]` |yes |Mark this item as active when the URL
959
961
starts with one of these paths.
960
962
961
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
963
+ |`insertBefore` |`string \ | string[]` |yes |Insert this item before the
962
964
item referenced here. For arrays, the first one found in order is used.
963
965
964
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
966
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
965
967
item referenced here. For arrays, the first one found in order is used.
966
968
`insertBefore` takes precedence.
967
969
@@ -991,10 +993,10 @@ belongs to. If not specified, contributes to the default perspective.
991
993
|`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
992
994
attributes to the DOM.
993
995
994
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
996
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
995
997
item referenced here. For arrays, the first one found in order is used.
996
998
997
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
999
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
998
1000
item referenced here. For arrays, the first one found in order is used.
999
1001
`insertBefore` takes precedence.
1000
1002
@@ -1027,10 +1029,10 @@ to. If not specified, render this item as a top level link.
1027
1029
|`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
1028
1030
attributes to the DOM.
1029
1031
1030
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
1032
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
1031
1033
item referenced here. For arrays, the first one found in order is used.
1032
1034
1033
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
1035
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
1034
1036
item referenced here. For arrays, the first one found in order is used.
1035
1037
`insertBefore` takes precedence.
1036
1038
|===
@@ -1098,7 +1100,7 @@ https://v5.reactrouter.com/
1098
1100
|`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
1099
1101
|no |The component to be rendered when the route matches.
1100
1102
1101
- |`path` |`string | string[]` |no |Valid URL path or array of paths that
1103
+ |`path` |`string` \| ` string[]` |no |Valid URL path or array of paths that
1102
1104
`path-to-regexp@^1.7.0` understands.
1103
1105
1104
1106
|`perspective` |`string` |yes |The perspective to which this page
@@ -1128,7 +1130,7 @@ https://v5.reactrouter.com/
1128
1130
|`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
1129
1131
|no |The component to be rendered when the route matches.
1130
1132
1131
- |`path` |`string | string[]` |no |Valid URL path or array of paths that
1133
+ |`path` |`string` \| ` string[]` |no |Valid URL path or array of paths that
1132
1134
`path-to-regexp@^1.7.0` understands.
1133
1135
1134
1136
|`exact` |`boolean` |yes |When true, will only match if the path matches
@@ -1635,10 +1637,10 @@ DetailsTab contributes a tab for the topology details panel.
1635
1637
1636
1638
|`label` |`string` |no |The tab label to display in the UI.
1637
1639
1638
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
1640
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
1639
1641
item referenced here.For arrays, the first one found in order is used.
1640
1642
1641
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
1643
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
1642
1644
item referenced here.For arrays, the first one found in order is
1643
1645
used.insertBefore takes precedence.
1644
1646
|===
@@ -1672,12 +1674,12 @@ topology sidebar.SDK component: <Section title=\{}>... padded area
1672
1674
|no |@deprecated Fallback if no provider is defined. renderNull is a
1673
1675
no-op already.
1674
1676
1675
- |`insertBefore` |`string | string[]` |yes |Insert this item before the
1677
+ |`insertBefore` |`string` \| ` string[]` |yes |Insert this item before the
1676
1678
item referenced here.For arrays, the first one found in order is used.
1677
1679
1678
- |`insertAfter` |`string | string[]` |yes |Insert this item after the
1680
+ |`insertAfter` |`string` \| ` string[]` |yes |Insert this item after the
1679
1681
item referenced here.For arrays, the first one found in order is
1680
- used.insertBefore takes precedence.
1682
+ used. The ` insertBefore` value takes precedence.
1681
1683
|===
1682
1684
1683
1685
'''''
0 commit comments