@backstage/core-components 0.7.1 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/index.d.ts +122 -13
- package/dist/index.esm.js.map +1 -1
- package/package.json +14 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @backstage/core-components
|
|
2
2
|
|
|
3
|
+
## 0.7.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- afd5c82ce1: Updates the d3 dependencies
|
|
8
|
+
- c6c2942daa: Deprecated `DismissbleBannerClassKey` and fixed the typo to make `DismissableBannerClassKey`
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/config@0.1.11
|
|
11
|
+
- @backstage/theme@0.2.12
|
|
12
|
+
- @backstage/errors@0.1.4
|
|
13
|
+
- @backstage/core-plugin-api@0.1.12
|
|
14
|
+
|
|
3
15
|
## 0.7.1
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -24,15 +24,19 @@ import { StyleRules } from '@material-ui/core/styles/withStyles';
|
|
|
24
24
|
/**
|
|
25
25
|
* Displays alerts from {@link @backstage/core-plugin-api#AlertApi}
|
|
26
26
|
*
|
|
27
|
+
* @public
|
|
27
28
|
* @remarks
|
|
28
29
|
*
|
|
29
30
|
* Shown as SnackBar at the top of the page
|
|
30
31
|
*/
|
|
31
32
|
declare function AlertDisplay(_props: {}): JSX.Element | null;
|
|
32
33
|
|
|
34
|
+
/** @public */
|
|
33
35
|
declare type AvatarClassKey = 'avatar';
|
|
34
36
|
/**
|
|
35
|
-
* Properties for {@link Avatar}
|
|
37
|
+
* Properties for {@link Avatar}.
|
|
38
|
+
*
|
|
39
|
+
* @public
|
|
36
40
|
*/
|
|
37
41
|
interface AvatarProps {
|
|
38
42
|
/**
|
|
@@ -51,9 +55,10 @@ interface AvatarProps {
|
|
|
51
55
|
/**
|
|
52
56
|
* Component rendering an Avatar
|
|
53
57
|
*
|
|
54
|
-
*
|
|
58
|
+
* @public
|
|
59
|
+
* @remarks
|
|
55
60
|
*
|
|
56
|
-
*
|
|
61
|
+
* Based on https://v4.mui.com/components/avatars/#avatar with some styling adjustment and two-letter initials
|
|
57
62
|
*/
|
|
58
63
|
declare function Avatar(props: AvatarProps): JSX.Element;
|
|
59
64
|
|
|
@@ -70,15 +75,19 @@ declare const ActualLink: React__default.ForwardRefExoticComponent<Pick<LinkProp
|
|
|
70
75
|
/**
|
|
71
76
|
* Properties for {@link Button}
|
|
72
77
|
*
|
|
78
|
+
* @public
|
|
73
79
|
* @remarks
|
|
74
80
|
*
|
|
75
81
|
* See {@link https://v4.mui.com/api/button/#props | Material-UI Button Props} for all properties
|
|
76
82
|
*/
|
|
77
83
|
declare type ButtonProps = ButtonProps$1 & Omit<LinkProps, 'variant' | 'color'>;
|
|
84
|
+
/** @public */
|
|
78
85
|
declare const ActualButton: (props: ButtonProps) => JSX.Element;
|
|
79
86
|
|
|
80
87
|
/**
|
|
81
88
|
* Properties for {@link CodeSnippet}
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
82
91
|
*/
|
|
83
92
|
interface CodeSnippetProps {
|
|
84
93
|
/**
|
|
@@ -121,11 +130,15 @@ interface CodeSnippetProps {
|
|
|
121
130
|
/**
|
|
122
131
|
* Thin wrapper on top of {@link https://react-syntax-highlighter.github.io/react-syntax-highlighter/ | react-syntax-highlighter}
|
|
123
132
|
* providing consistent theming and copy code button
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
124
135
|
*/
|
|
125
136
|
declare function CodeSnippet(props: CodeSnippetProps): JSX.Element;
|
|
126
137
|
|
|
127
138
|
/**
|
|
128
139
|
* Properties for {@link CopyTextButton}
|
|
140
|
+
*
|
|
141
|
+
* @public
|
|
129
142
|
*/
|
|
130
143
|
interface CopyTextButtonProps {
|
|
131
144
|
/**
|
|
@@ -152,6 +165,7 @@ interface CopyTextButtonProps {
|
|
|
152
165
|
/**
|
|
153
166
|
* Copy text button with visual feedback
|
|
154
167
|
*
|
|
168
|
+
* @public
|
|
155
169
|
* @remarks
|
|
156
170
|
*
|
|
157
171
|
* Visual feedback takes form of:
|
|
@@ -167,12 +181,16 @@ declare function CopyTextButton(props: CopyTextButtonProps): JSX.Element;
|
|
|
167
181
|
|
|
168
182
|
/**
|
|
169
183
|
* Properties for {@link CreateButton}
|
|
184
|
+
*
|
|
185
|
+
* @public
|
|
170
186
|
*/
|
|
171
187
|
declare type CreateButtonProps = {
|
|
172
188
|
title: string;
|
|
173
189
|
} & Partial<Pick<LinkProps$2, 'to'>>;
|
|
174
190
|
/**
|
|
175
191
|
* Responsive Button giving consistent UX for creation of different things
|
|
192
|
+
*
|
|
193
|
+
* @public
|
|
176
194
|
*/
|
|
177
195
|
declare function CreateButton(props: CreateButtonProps): JSX.Element | null;
|
|
178
196
|
|
|
@@ -184,6 +202,8 @@ declare function CreateButton(props: CreateButtonProps): JSX.Element | null;
|
|
|
184
202
|
|
|
185
203
|
/**
|
|
186
204
|
* Edge of {@link DependencyGraph}
|
|
205
|
+
*
|
|
206
|
+
* @public
|
|
187
207
|
*/
|
|
188
208
|
declare type DependencyEdge<T = {}> = T & {
|
|
189
209
|
/**
|
|
@@ -211,6 +231,8 @@ declare type RenderLabelProps<T = unknown> = {
|
|
|
211
231
|
declare type RenderLabelFunction<T = {}> = (props: RenderLabelProps<T>) => React__default.ReactNode;
|
|
212
232
|
/**
|
|
213
233
|
* Node of {@link DependencyGraph}
|
|
234
|
+
*
|
|
235
|
+
* @public
|
|
214
236
|
*/
|
|
215
237
|
declare type DependencyNode<T = {}> = T & {
|
|
216
238
|
id: string;
|
|
@@ -227,6 +249,8 @@ declare type RenderNodeProps<T = unknown> = {
|
|
|
227
249
|
declare type RenderNodeFunction<T = {}> = (props: RenderNodeProps<T>) => React__default.ReactNode;
|
|
228
250
|
/**
|
|
229
251
|
* Graph direction
|
|
252
|
+
*
|
|
253
|
+
* @public
|
|
230
254
|
*/
|
|
231
255
|
declare enum Direction {
|
|
232
256
|
/**
|
|
@@ -248,6 +272,8 @@ declare enum Direction {
|
|
|
248
272
|
}
|
|
249
273
|
/**
|
|
250
274
|
* Node alignment
|
|
275
|
+
*
|
|
276
|
+
* @public
|
|
251
277
|
*/
|
|
252
278
|
declare enum Alignment {
|
|
253
279
|
/**
|
|
@@ -290,6 +316,8 @@ declare enum Ranker {
|
|
|
290
316
|
}
|
|
291
317
|
/**
|
|
292
318
|
* Position of label in relation to the edge
|
|
319
|
+
*
|
|
320
|
+
* @public
|
|
293
321
|
*/
|
|
294
322
|
declare enum LabelPosition {
|
|
295
323
|
LEFT = "l",
|
|
@@ -329,6 +357,7 @@ declare namespace types_d {
|
|
|
329
357
|
/**
|
|
330
358
|
* Properties of {@link DependencyGraph}
|
|
331
359
|
*
|
|
360
|
+
* @public
|
|
332
361
|
* @remarks
|
|
333
362
|
* <NodeData> and <EdgeData> are useful when rendering custom or edge labels
|
|
334
363
|
*/
|
|
@@ -454,26 +483,40 @@ interface DependencyGraphProps<NodeData, EdgeData> extends React__default.SVGPro
|
|
|
454
483
|
}
|
|
455
484
|
/**
|
|
456
485
|
* Graph component used to visualize relations between entities
|
|
486
|
+
*
|
|
487
|
+
* @public
|
|
457
488
|
*/
|
|
458
489
|
declare function DependencyGraph<NodeData, EdgeData>(props: DependencyGraphProps<NodeData, EdgeData>): JSX.Element;
|
|
459
490
|
|
|
491
|
+
/** @public */
|
|
460
492
|
declare type DependencyGraphDefaultLabelClassKey = 'text';
|
|
461
493
|
|
|
494
|
+
/** @public */
|
|
462
495
|
declare type DependencyGraphDefaultNodeClassKey = 'node' | 'text';
|
|
463
496
|
|
|
497
|
+
/** @public */
|
|
464
498
|
declare type DependencyGraphEdgeClassKey = 'path' | 'label';
|
|
465
499
|
|
|
500
|
+
/** @public */
|
|
466
501
|
declare type DependencyGraphNodeClassKey = 'node';
|
|
467
502
|
|
|
468
|
-
|
|
503
|
+
/** @public */
|
|
504
|
+
declare type DismissableBannerClassKey = 'root' | 'topPosition' | 'icon' | 'content' | 'message' | 'info' | 'error';
|
|
505
|
+
/**
|
|
506
|
+
* @public
|
|
507
|
+
* @deprecated This type contained a typo, please use DismissableBannerClassKey instead
|
|
508
|
+
*/
|
|
509
|
+
declare type DismissbleBannerClassKey = DismissableBannerClassKey;
|
|
469
510
|
declare type Props$k = {
|
|
470
511
|
variant: 'info' | 'error';
|
|
471
512
|
message: ReactNode;
|
|
472
513
|
id: string;
|
|
473
514
|
fixed?: boolean;
|
|
474
515
|
};
|
|
516
|
+
/** @public */
|
|
475
517
|
declare const DismissableBanner: (props: Props$k) => JSX.Element;
|
|
476
518
|
|
|
519
|
+
/** @public */
|
|
477
520
|
declare type EmptyStateClassKey = 'root' | 'action' | 'imageContainer';
|
|
478
521
|
declare type Props$j = {
|
|
479
522
|
title: string;
|
|
@@ -481,8 +524,10 @@ declare type Props$j = {
|
|
|
481
524
|
missing: 'field' | 'info' | 'content' | 'data';
|
|
482
525
|
action?: JSX.Element;
|
|
483
526
|
};
|
|
527
|
+
/** @public */
|
|
484
528
|
declare function EmptyState(props: Props$j): JSX.Element;
|
|
485
529
|
|
|
530
|
+
/** @public */
|
|
486
531
|
declare type EmptyStateImageClassKey = 'generalImg';
|
|
487
532
|
|
|
488
533
|
declare type Props$i = {
|
|
@@ -491,7 +536,9 @@ declare type Props$i = {
|
|
|
491
536
|
declare type MissingAnnotationEmptyStateClassKey = 'code';
|
|
492
537
|
declare function MissingAnnotationEmptyState(props: Props$i): JSX.Element;
|
|
493
538
|
|
|
539
|
+
/** @public */
|
|
494
540
|
declare type ErrorPanelClassKey = 'text' | 'divider';
|
|
541
|
+
/** @public */
|
|
495
542
|
declare type ErrorPanelProps = {
|
|
496
543
|
error: Error;
|
|
497
544
|
defaultExpanded?: boolean;
|
|
@@ -499,6 +546,8 @@ declare type ErrorPanelProps = {
|
|
|
499
546
|
};
|
|
500
547
|
/**
|
|
501
548
|
* Renders a warning panel as the effect of an error.
|
|
549
|
+
*
|
|
550
|
+
* @public
|
|
502
551
|
*/
|
|
503
552
|
declare function ErrorPanel(props: PropsWithChildren<ErrorPanelProps>): JSX.Element;
|
|
504
553
|
|
|
@@ -511,12 +560,14 @@ declare type ResponseErrorPanelClassKey = 'text' | 'divider';
|
|
|
511
560
|
*/
|
|
512
561
|
declare function ResponseErrorPanel(props: ErrorPanelProps): JSX.Element;
|
|
513
562
|
|
|
563
|
+
/** @public */
|
|
514
564
|
declare type FeatureCalloutCircleClassKey = '@keyframes pulsateSlightly' | '@keyframes pulsateAndFade' | 'featureWrapper' | 'backdrop' | 'dot' | 'pulseCircle' | 'text';
|
|
515
565
|
declare type Props$h = {
|
|
516
566
|
featureId: string;
|
|
517
567
|
title: string;
|
|
518
568
|
description: string;
|
|
519
569
|
};
|
|
570
|
+
/** @public */
|
|
520
571
|
declare function FeatureCalloutCircular(props: PropsWithChildren<Props$h>): JSX.Element;
|
|
521
572
|
|
|
522
573
|
declare type IconLinkVerticalProps = {
|
|
@@ -528,12 +579,15 @@ declare type IconLinkVerticalProps = {
|
|
|
528
579
|
onClick?: React__default.MouseEventHandler<HTMLAnchorElement>;
|
|
529
580
|
title?: string;
|
|
530
581
|
};
|
|
582
|
+
/** @public */
|
|
531
583
|
declare type IconLinkVerticalClassKey = 'link' | 'disabled' | 'primary' | 'secondary' | 'label';
|
|
532
584
|
|
|
585
|
+
/** @public */
|
|
533
586
|
declare type HeaderIconLinkRowClassKey = 'links';
|
|
534
587
|
declare type Props$g = {
|
|
535
588
|
links: IconLinkVerticalProps[];
|
|
536
589
|
};
|
|
590
|
+
/** @public */
|
|
537
591
|
declare function HeaderIconLinkRow(props: Props$g): JSX.Element;
|
|
538
592
|
|
|
539
593
|
declare type Props$f = {
|
|
@@ -541,7 +595,9 @@ declare type Props$f = {
|
|
|
541
595
|
scrollSpeed?: number;
|
|
542
596
|
minScrollDistance?: number;
|
|
543
597
|
};
|
|
598
|
+
/** @public */
|
|
544
599
|
declare type HorizontalScrollGridClassKey = 'root' | 'container' | 'fade' | 'fadeLeft' | 'fadeRight' | 'fadeHidden' | 'button' | 'buttonLeft' | 'buttonRight';
|
|
600
|
+
/** @public */
|
|
545
601
|
declare function HorizontalScrollGrid(props: PropsWithChildren<Props$f>): JSX.Element;
|
|
546
602
|
|
|
547
603
|
declare type Props$e = CSS.Properties & {
|
|
@@ -585,6 +641,7 @@ declare type SlackChannel = {
|
|
|
585
641
|
name: string;
|
|
586
642
|
href?: string;
|
|
587
643
|
};
|
|
644
|
+
/** @public */
|
|
588
645
|
declare type ErrorBoundaryProps = {
|
|
589
646
|
slackChannel?: string | SlackChannel;
|
|
590
647
|
onError?: (error: Error, errorInfo: string) => null;
|
|
@@ -593,18 +650,25 @@ declare type State = {
|
|
|
593
650
|
error?: Error;
|
|
594
651
|
errorInfo?: ErrorInfo;
|
|
595
652
|
};
|
|
653
|
+
/** @public */
|
|
596
654
|
declare const ErrorBoundary: ComponentClass<ErrorBoundaryProps, State>;
|
|
597
655
|
|
|
656
|
+
/** @public */
|
|
598
657
|
declare type BottomLinkClassKey = 'root' | 'boxTitle' | 'arrow';
|
|
658
|
+
/** @public */
|
|
599
659
|
declare type BottomLinkProps = {
|
|
600
660
|
link: string;
|
|
601
661
|
title: string;
|
|
602
662
|
onClick?: (event: React__default.MouseEvent<HTMLAnchorElement>) => void;
|
|
603
663
|
};
|
|
664
|
+
/** @public */
|
|
604
665
|
declare function BottomLink(props: BottomLinkProps): JSX.Element;
|
|
605
666
|
|
|
667
|
+
/** @public */
|
|
606
668
|
declare type InfoCardClassKey = 'noPadding' | 'header' | 'headerTitle' | 'headerSubheader' | 'headerAvatar' | 'headerAction' | 'headerContent';
|
|
669
|
+
/** @public */
|
|
607
670
|
declare type CardActionsTopRightClassKey = 'root';
|
|
671
|
+
/** @public */
|
|
608
672
|
declare type InfoCardVariants = 'flex' | 'fullHeight' | 'gridItem';
|
|
609
673
|
/**
|
|
610
674
|
* InfoCard is used to display a paper-styled block on the screen, similar to a panel.
|
|
@@ -622,7 +686,7 @@ declare type InfoCardVariants = 'flex' | 'fullHeight' | 'gridItem';
|
|
|
622
686
|
* When the InfoCard is displayed as a grid item within a grid, you may want items to have the same height for all items.
|
|
623
687
|
* Set to the 'gridItem' variant to display the InfoCard with full height suitable for Grid:
|
|
624
688
|
*
|
|
625
|
-
*
|
|
689
|
+
* `<InfoCard variant="gridItem">...</InfoCard>`
|
|
626
690
|
*/
|
|
627
691
|
declare type Props$b = {
|
|
628
692
|
title?: ReactNode;
|
|
@@ -645,6 +709,7 @@ declare type Props$b = {
|
|
|
645
709
|
noPadding?: boolean;
|
|
646
710
|
titleTypographyProps?: object;
|
|
647
711
|
};
|
|
712
|
+
/** @public */
|
|
648
713
|
declare function InfoCard(props: Props$b): JSX.Element;
|
|
649
714
|
|
|
650
715
|
declare type Props$a = {
|
|
@@ -656,9 +721,12 @@ declare type Props$a = {
|
|
|
656
721
|
inverse?: boolean;
|
|
657
722
|
deepLink?: BottomLinkProps;
|
|
658
723
|
};
|
|
724
|
+
/** @public */
|
|
659
725
|
declare type GaugeCardClassKey = 'root';
|
|
726
|
+
/** @public */
|
|
660
727
|
declare function GaugeCard(props: Props$a): JSX.Element;
|
|
661
728
|
|
|
729
|
+
/** @public */
|
|
662
730
|
declare type GaugeClassKey = 'root' | 'overlay' | 'circle' | 'colorUnknown';
|
|
663
731
|
declare type Props$9 = {
|
|
664
732
|
value: number;
|
|
@@ -667,6 +735,7 @@ declare type Props$9 = {
|
|
|
667
735
|
unit?: string;
|
|
668
736
|
max?: number;
|
|
669
737
|
};
|
|
738
|
+
/** @public */
|
|
670
739
|
declare function Gauge(props: Props$9): JSX.Element;
|
|
671
740
|
|
|
672
741
|
declare type Props$8 = {
|
|
@@ -695,6 +764,7 @@ declare type SelectProps = {
|
|
|
695
764
|
};
|
|
696
765
|
declare function SelectComponent(props: SelectProps): JSX.Element;
|
|
697
766
|
|
|
767
|
+
/** @public */
|
|
698
768
|
declare type ClosedDropdownClassKey = 'icon';
|
|
699
769
|
|
|
700
770
|
declare type OpenedDropdownClassKey = 'icon';
|
|
@@ -818,6 +888,7 @@ declare function SubvalueCell(props: SubvalueCellProps): JSX.Element;
|
|
|
818
888
|
|
|
819
889
|
declare type TableHeaderClassKey = 'header';
|
|
820
890
|
declare type TableToolbarClassKey = 'root' | 'title' | 'searchField';
|
|
891
|
+
/** @public */
|
|
821
892
|
declare type FiltersContainerClassKey = 'root' | 'title';
|
|
822
893
|
declare type TableClassKey = 'root';
|
|
823
894
|
interface TableColumn<T extends object = {}> extends Column<T> {
|
|
@@ -903,18 +974,30 @@ declare type SupportConfig = {
|
|
|
903
974
|
declare function useSupportConfig(): SupportConfig;
|
|
904
975
|
|
|
905
976
|
declare type IconComponentProps = ComponentProps<IconComponent>;
|
|
977
|
+
/** @public */
|
|
906
978
|
declare function BrokenImageIcon(props: IconComponentProps): JSX.Element;
|
|
979
|
+
/** @public */
|
|
907
980
|
declare function CatalogIcon(props: IconComponentProps): JSX.Element;
|
|
981
|
+
/** @public */
|
|
908
982
|
declare function ChatIcon(props: IconComponentProps): JSX.Element;
|
|
983
|
+
/** @public */
|
|
909
984
|
declare function DashboardIcon(props: IconComponentProps): JSX.Element;
|
|
985
|
+
/** @public */
|
|
910
986
|
declare function DocsIcon(props: IconComponentProps): JSX.Element;
|
|
987
|
+
/** @public */
|
|
911
988
|
declare function EmailIcon(props: IconComponentProps): JSX.Element;
|
|
989
|
+
/** @public */
|
|
912
990
|
declare function GitHubIcon(props: IconComponentProps): JSX.Element;
|
|
991
|
+
/** @public */
|
|
913
992
|
declare function GroupIcon(props: IconComponentProps): JSX.Element;
|
|
993
|
+
/** @public */
|
|
914
994
|
declare function HelpIcon(props: IconComponentProps): JSX.Element;
|
|
995
|
+
/** @public */
|
|
915
996
|
declare function UserIcon(props: IconComponentProps): JSX.Element;
|
|
997
|
+
/** @public */
|
|
916
998
|
declare function WarningIcon(props: IconComponentProps): JSX.Element;
|
|
917
999
|
|
|
1000
|
+
/** @public */
|
|
918
1001
|
declare type BackstageContentClassKey = 'root' | 'stretch' | 'noPadding';
|
|
919
1002
|
declare type Props$6 = {
|
|
920
1003
|
stretch?: boolean;
|
|
@@ -927,6 +1010,7 @@ declare function Content(props: PropsWithChildren<Props$6>): JSX.Element;
|
|
|
927
1010
|
* TODO favoriteable capability
|
|
928
1011
|
*/
|
|
929
1012
|
|
|
1013
|
+
/** @public */
|
|
930
1014
|
declare type ContentHeaderClassKey = 'container' | 'leftItemsBox' | 'rightItemsBox' | 'description' | 'title';
|
|
931
1015
|
declare type ContentHeaderTitleProps = {
|
|
932
1016
|
title?: string;
|
|
@@ -938,6 +1022,7 @@ declare type ContentHeaderProps = {
|
|
|
938
1022
|
description?: string;
|
|
939
1023
|
textAlign?: 'left' | 'right' | 'center';
|
|
940
1024
|
};
|
|
1025
|
+
/** @public */
|
|
941
1026
|
declare function ContentHeader(props: PropsWithChildren<ContentHeaderProps>): JSX.Element;
|
|
942
1027
|
|
|
943
1028
|
interface IErrorPageProps {
|
|
@@ -945,11 +1030,14 @@ interface IErrorPageProps {
|
|
|
945
1030
|
statusMessage: string;
|
|
946
1031
|
additionalInfo?: string;
|
|
947
1032
|
}
|
|
1033
|
+
/** @public */
|
|
948
1034
|
declare type ErrorPageClassKey = 'container' | 'title' | 'subtitle';
|
|
1035
|
+
/** @public */
|
|
949
1036
|
declare function ErrorPage(props: IErrorPageProps): JSX.Element;
|
|
950
1037
|
|
|
951
1038
|
declare type MicDropClassKey = 'micDrop';
|
|
952
1039
|
|
|
1040
|
+
/** @public */
|
|
953
1041
|
declare type HeaderClassKey = 'header' | 'leftItemsBox' | 'rightItemsBox' | 'title' | 'subtitle' | 'type' | 'breadcrumb' | 'breadcrumbType' | 'breadcrumbTitle';
|
|
954
1042
|
declare type Props$5 = {
|
|
955
1043
|
component?: ReactNode;
|
|
@@ -961,8 +1049,10 @@ declare type Props$5 = {
|
|
|
961
1049
|
type?: string;
|
|
962
1050
|
typeLink?: string;
|
|
963
1051
|
};
|
|
1052
|
+
/** @public */
|
|
964
1053
|
declare function Header(props: PropsWithChildren<Props$5>): JSX.Element;
|
|
965
1054
|
|
|
1055
|
+
/** @public */
|
|
966
1056
|
declare type HeaderLabelClassKey = 'root' | 'label' | 'value';
|
|
967
1057
|
declare type HeaderLabelContentProps = {
|
|
968
1058
|
value: React__default.ReactNode;
|
|
@@ -973,8 +1063,10 @@ declare type HeaderLabelProps = {
|
|
|
973
1063
|
value?: HeaderLabelContentProps['value'];
|
|
974
1064
|
url?: string;
|
|
975
1065
|
};
|
|
1066
|
+
/** @public */
|
|
976
1067
|
declare function HeaderLabel(props: HeaderLabelProps): JSX.Element;
|
|
977
1068
|
|
|
1069
|
+
/** @public */
|
|
978
1070
|
declare type HeaderTabsClassKey = 'tabsWrapper' | 'defaultTab' | 'selected' | 'tabRoot';
|
|
979
1071
|
declare type Tab = {
|
|
980
1072
|
id: string;
|
|
@@ -988,10 +1080,13 @@ declare type HeaderTabsProps = {
|
|
|
988
1080
|
onChange?: (index: number) => void;
|
|
989
1081
|
selectedIndex?: number;
|
|
990
1082
|
};
|
|
1083
|
+
/** @public */
|
|
991
1084
|
declare function HeaderTabs(props: HeaderTabsProps): JSX.Element;
|
|
992
1085
|
|
|
993
1086
|
/**
|
|
994
1087
|
* Please use the HeaderWorldClock in the home plugin
|
|
1088
|
+
*
|
|
1089
|
+
* @public
|
|
995
1090
|
* @deprecated in favor of the HeaderWorldClock which is found in the to home plugin
|
|
996
1091
|
*/
|
|
997
1092
|
declare function HomepageTimer(_props: {}): JSX.Element | null;
|
|
@@ -1034,8 +1129,10 @@ declare type ItemCardProps = {
|
|
|
1034
1129
|
*/
|
|
1035
1130
|
declare function ItemCard(props: ItemCardProps): JSX.Element;
|
|
1036
1131
|
|
|
1132
|
+
/** @public */
|
|
1037
1133
|
declare type ItemCardGridClassKey = 'root';
|
|
1038
1134
|
declare const styles$1: (theme: Theme) => _material_ui_styles.StyleRules<{}, "root">;
|
|
1135
|
+
/** @public */
|
|
1039
1136
|
declare type ItemCardGridProps = Partial<WithStyles<typeof styles$1>> & {
|
|
1040
1137
|
/**
|
|
1041
1138
|
* The Card items of the grid.
|
|
@@ -1050,17 +1147,19 @@ declare type ItemCardGridProps = Partial<WithStyles<typeof styles$1>> & {
|
|
|
1050
1147
|
*
|
|
1051
1148
|
* Styles for the grid can be overridden using the `classes` prop, e.g.:
|
|
1052
1149
|
*
|
|
1053
|
-
*
|
|
1054
|
-
* <ItemCardGrid title="Hello" classes={{ root: myClassName }} />
|
|
1055
|
-
* </code>
|
|
1150
|
+
* `<ItemCardGrid title="Hello" classes={{ root: myClassName }} />`
|
|
1056
1151
|
*
|
|
1057
1152
|
* This can be useful for e.g. overriding gridTemplateColumns to adapt the
|
|
1058
1153
|
* minimum size of the cells to fit the content better.
|
|
1154
|
+
*
|
|
1155
|
+
* @public
|
|
1059
1156
|
*/
|
|
1060
1157
|
declare function ItemCardGrid(props: ItemCardGridProps): JSX.Element;
|
|
1061
1158
|
|
|
1159
|
+
/** @public */
|
|
1062
1160
|
declare type ItemCardHeaderClassKey = 'root';
|
|
1063
1161
|
declare const styles: (theme: BackstageTheme) => _material_ui_styles.StyleRules<{}, "root">;
|
|
1162
|
+
/** @public */
|
|
1064
1163
|
declare type ItemCardHeaderProps = Partial<WithStyles<typeof styles>> & {
|
|
1065
1164
|
/**
|
|
1066
1165
|
* A large title to show in the header, providing the main heading.
|
|
@@ -1092,9 +1191,9 @@ declare type ItemCardHeaderProps = Partial<WithStyles<typeof styles>> & {
|
|
|
1092
1191
|
*
|
|
1093
1192
|
* Styles for the header can be overridden using the `classes` prop, e.g.:
|
|
1094
1193
|
*
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
1097
|
-
*
|
|
1194
|
+
* `<ItemCardHeader title="Hello" classes={{ root: myClassName }} />`
|
|
1195
|
+
*
|
|
1196
|
+
* @public
|
|
1098
1197
|
*/
|
|
1099
1198
|
declare function ItemCardHeader(props: ItemCardHeaderProps): JSX.Element;
|
|
1100
1199
|
|
|
@@ -1159,11 +1258,13 @@ declare const SidebarScrollWrapper: React__default.ComponentType<Pick<React__def
|
|
|
1159
1258
|
className?: string | undefined;
|
|
1160
1259
|
}>;
|
|
1161
1260
|
|
|
1261
|
+
/** @public */
|
|
1162
1262
|
declare type SidebarIntroClassKey = 'introCard' | 'introDismiss' | 'introDismissLink' | 'introDismissText' | 'introDismissIcon';
|
|
1163
1263
|
declare type IntroCardProps = {
|
|
1164
1264
|
text: string;
|
|
1165
1265
|
onClose: () => void;
|
|
1166
1266
|
};
|
|
1267
|
+
/** @public */
|
|
1167
1268
|
declare function IntroCard(props: IntroCardProps): JSX.Element;
|
|
1168
1269
|
declare function SidebarIntro(_props: {}): JSX.Element | null;
|
|
1169
1270
|
|
|
@@ -1209,9 +1310,11 @@ declare function SignInPage(props: Props$2): JSX.Element;
|
|
|
1209
1310
|
|
|
1210
1311
|
declare type SignInPageClassKey = 'container' | 'item';
|
|
1211
1312
|
|
|
1313
|
+
/** @public */
|
|
1212
1314
|
declare type CustomProviderClassKey = 'form' | 'button';
|
|
1213
1315
|
|
|
1214
1316
|
declare type TabbedCardClassKey = 'root' | 'indicator';
|
|
1317
|
+
/** @public */
|
|
1215
1318
|
declare type BoldHeaderClassKey = 'root' | 'title' | 'subheader';
|
|
1216
1319
|
declare type Props$1 = {
|
|
1217
1320
|
/** @deprecated Use errorBoundaryProps instead */
|
|
@@ -1224,15 +1327,20 @@ declare type Props$1 = {
|
|
|
1224
1327
|
deepLink?: BottomLinkProps;
|
|
1225
1328
|
};
|
|
1226
1329
|
declare function TabbedCard(props: PropsWithChildren<Props$1>): JSX.Element;
|
|
1330
|
+
/** @public */
|
|
1227
1331
|
declare type CardTabClassKey = 'root' | 'selected';
|
|
1228
1332
|
declare type CardTabProps = TabProps$1 & {
|
|
1229
1333
|
children: ReactNode;
|
|
1230
1334
|
};
|
|
1335
|
+
/** @public */
|
|
1231
1336
|
declare function CardTab(props: PropsWithChildren<CardTabProps>): JSX.Element;
|
|
1232
1337
|
|
|
1233
1338
|
declare type Props = ComponentProps<typeof MaterialBreadcrumbs>;
|
|
1339
|
+
/** @public */
|
|
1234
1340
|
declare type BreadcrumbsClickableTextClassKey = 'root';
|
|
1341
|
+
/** @public */
|
|
1235
1342
|
declare type BreadcrumbsStyledBoxClassKey = 'root';
|
|
1343
|
+
/** @public */
|
|
1236
1344
|
declare function Breadcrumbs(props: Props): JSX.Element;
|
|
1237
1345
|
|
|
1238
1346
|
declare type BackstageComponentsNameToClassKey = {
|
|
@@ -1241,7 +1349,7 @@ declare type BackstageComponentsNameToClassKey = {
|
|
|
1241
1349
|
BackstageDependencyGraphDefaultNode: DependencyGraphDefaultNodeClassKey;
|
|
1242
1350
|
BackstageDependencyGraphEdge: DependencyGraphEdgeClassKey;
|
|
1243
1351
|
BackstageDependencyGraphNode: DependencyGraphNodeClassKey;
|
|
1244
|
-
BackstageDismissableBanner:
|
|
1352
|
+
BackstageDismissableBanner: DismissableBannerClassKey;
|
|
1245
1353
|
BackstageEmptyState: EmptyStateClassKey;
|
|
1246
1354
|
BackstageEmptyStateImage: EmptyStateImageClassKey;
|
|
1247
1355
|
BackstageMissingAnnotationEmptyState: MissingAnnotationEmptyStateClassKey;
|
|
@@ -1307,8 +1415,9 @@ declare type BackstageComponentsNameToClassKey = {
|
|
|
1307
1415
|
BackstageTabbedCardBoldHeader: BoldHeaderClassKey;
|
|
1308
1416
|
BackstageCardTab: CardTabClassKey;
|
|
1309
1417
|
};
|
|
1418
|
+
/** @public */
|
|
1310
1419
|
declare type BackstageOverrides = Overrides & {
|
|
1311
1420
|
[Name in keyof BackstageComponentsNameToClassKey]?: Partial<StyleRules<BackstageComponentsNameToClassKey[Name]>>;
|
|
1312
1421
|
};
|
|
1313
1422
|
|
|
1314
|
-
export { AlertDisplay, Avatar, AvatarClassKey, AvatarProps, BackstageContentClassKey, BackstageOverrides, BoldHeaderClassKey, BottomLink, BottomLinkClassKey, BottomLinkProps, Breadcrumbs, BreadcrumbsClickableTextClassKey, BreadcrumbsStyledBoxClassKey, BrokenImageIcon, ActualButton as Button, ButtonProps, CardActionsTopRightClassKey, CardTab, CardTabClassKey, CatalogIcon, ChatIcon, ClosedDropdownClassKey, CodeSnippet, CodeSnippetProps, Content, ContentHeader, ContentHeaderClassKey, CopyTextButton, CopyTextButtonProps, CreateButton, CreateButtonProps, CustomProviderClassKey, DashboardIcon, DependencyGraph, DependencyGraphDefaultLabelClassKey, DependencyGraphDefaultNodeClassKey, DependencyGraphEdgeClassKey, DependencyGraphNodeClassKey, DependencyGraphProps, types_d as DependencyGraphTypes, DismissableBanner, DismissbleBannerClassKey, DocsIcon, EmailIcon, EmptyState, EmptyStateClassKey, EmptyStateImageClassKey, ErrorBoundary, ErrorBoundaryProps, ErrorPage, ErrorPageClassKey, ErrorPanel, ErrorPanelClassKey, ErrorPanelProps, FeatureCalloutCircleClassKey, FeatureCalloutCircular, FiltersContainerClassKey, Gauge, GaugeCard, GaugeCardClassKey, GaugeClassKey, GitHubIcon, GroupIcon, Header, HeaderClassKey, HeaderIconLinkRow, HeaderIconLinkRowClassKey, HeaderLabel, HeaderLabelClassKey, HeaderTabs, HeaderTabsClassKey, HelpIcon, HomepageTimer, HorizontalScrollGrid, HorizontalScrollGridClassKey, IconLinkVerticalClassKey, IconLinkVerticalProps, InfoCard, InfoCardClassKey, InfoCardVariants, IntroCard, ItemCard, ItemCardGrid, ItemCardGridClassKey, ItemCardGridProps, ItemCardHeader, ItemCardHeaderClassKey, ItemCardHeaderProps, Lifecycle, LifecycleClassKey, LinearGauge, ActualLink as Link, LinkProps, LoginRequestListItemClassKey, MarkdownContent, MarkdownContentClassKey, MetadataTableCellClassKey, MetadataTableListClassKey, MetadataTableListItemClassKey, MetadataTableTitleCellClassKey, MicDropClassKey, MissingAnnotationEmptyState, MissingAnnotationEmptyStateClassKey, OAuthRequestDialog, OAuthRequestDialogClassKey, OpenedDropdownClassKey, OverflowTooltip, OverflowTooltipClassKey, Page, PageClassKey, PageWithHeader, Progress, ResponseErrorPanel, ResponseErrorPanelClassKey, RoutedTabs, SIDEBAR_INTRO_LOCAL_STORAGE, SelectComponent as Select, SelectClassKey, SelectInputBaseClassKey, Sidebar, SidebarClassKey, SidebarContext, SidebarContextType, SidebarDivider, SidebarIntro, SidebarIntroClassKey, SidebarItem, SidebarItemClassKey, SidebarPage, SidebarPageClassKey, SidebarPinStateContext, SidebarPinStateContextType, SidebarScrollWrapper, SidebarSearchField, SidebarSpace, SidebarSpacer, SignInPage, SignInPageClassKey, SignInProviderConfig, SimpleStepper, SimpleStepperFooterClassKey, SimpleStepperStep, SimpleStepperStepClassKey, StatusAborted, StatusClassKey, StatusError, StatusOK, StatusPending, StatusRunning, StatusWarning, StructuredMetadataTable, StructuredMetadataTableListClassKey, StructuredMetadataTableNestedListClassKey, SubvalueCell, SubvalueCellClassKey, SupportButton, SupportButtonClassKey, SupportConfig, SupportItem, SupportItemLink, Tab, TabBarClassKey, TabIconClassKey, TabbedCard, TabbedCardClassKey, TabbedLayout, Table, TableClassKey, TableColumn, TableFilter, TableFiltersClassKey, TableHeaderClassKey, TableProps, TableState, TableToolbarClassKey, Tabs, TabsClassKey, TrendLine, UserIcon, WarningIcon, WarningPanel, WarningPanelClassKey, sidebarConfig, useQueryParamState, useSupportConfig };
|
|
1423
|
+
export { AlertDisplay, Avatar, AvatarClassKey, AvatarProps, BackstageContentClassKey, BackstageOverrides, BoldHeaderClassKey, BottomLink, BottomLinkClassKey, BottomLinkProps, Breadcrumbs, BreadcrumbsClickableTextClassKey, BreadcrumbsStyledBoxClassKey, BrokenImageIcon, ActualButton as Button, ButtonProps, CardActionsTopRightClassKey, CardTab, CardTabClassKey, CatalogIcon, ChatIcon, ClosedDropdownClassKey, CodeSnippet, CodeSnippetProps, Content, ContentHeader, ContentHeaderClassKey, CopyTextButton, CopyTextButtonProps, CreateButton, CreateButtonProps, CustomProviderClassKey, DashboardIcon, DependencyGraph, DependencyGraphDefaultLabelClassKey, DependencyGraphDefaultNodeClassKey, DependencyGraphEdgeClassKey, DependencyGraphNodeClassKey, DependencyGraphProps, types_d as DependencyGraphTypes, DismissableBanner, DismissableBannerClassKey, DismissbleBannerClassKey, DocsIcon, EmailIcon, EmptyState, EmptyStateClassKey, EmptyStateImageClassKey, ErrorBoundary, ErrorBoundaryProps, ErrorPage, ErrorPageClassKey, ErrorPanel, ErrorPanelClassKey, ErrorPanelProps, FeatureCalloutCircleClassKey, FeatureCalloutCircular, FiltersContainerClassKey, Gauge, GaugeCard, GaugeCardClassKey, GaugeClassKey, GitHubIcon, GroupIcon, Header, HeaderClassKey, HeaderIconLinkRow, HeaderIconLinkRowClassKey, HeaderLabel, HeaderLabelClassKey, HeaderTabs, HeaderTabsClassKey, HelpIcon, HomepageTimer, HorizontalScrollGrid, HorizontalScrollGridClassKey, IconLinkVerticalClassKey, IconLinkVerticalProps, InfoCard, InfoCardClassKey, InfoCardVariants, IntroCard, ItemCard, ItemCardGrid, ItemCardGridClassKey, ItemCardGridProps, ItemCardHeader, ItemCardHeaderClassKey, ItemCardHeaderProps, Lifecycle, LifecycleClassKey, LinearGauge, ActualLink as Link, LinkProps, LoginRequestListItemClassKey, MarkdownContent, MarkdownContentClassKey, MetadataTableCellClassKey, MetadataTableListClassKey, MetadataTableListItemClassKey, MetadataTableTitleCellClassKey, MicDropClassKey, MissingAnnotationEmptyState, MissingAnnotationEmptyStateClassKey, OAuthRequestDialog, OAuthRequestDialogClassKey, OpenedDropdownClassKey, OverflowTooltip, OverflowTooltipClassKey, Page, PageClassKey, PageWithHeader, Progress, ResponseErrorPanel, ResponseErrorPanelClassKey, RoutedTabs, SIDEBAR_INTRO_LOCAL_STORAGE, SelectComponent as Select, SelectClassKey, SelectInputBaseClassKey, Sidebar, SidebarClassKey, SidebarContext, SidebarContextType, SidebarDivider, SidebarIntro, SidebarIntroClassKey, SidebarItem, SidebarItemClassKey, SidebarPage, SidebarPageClassKey, SidebarPinStateContext, SidebarPinStateContextType, SidebarScrollWrapper, SidebarSearchField, SidebarSpace, SidebarSpacer, SignInPage, SignInPageClassKey, SignInProviderConfig, SimpleStepper, SimpleStepperFooterClassKey, SimpleStepperStep, SimpleStepperStepClassKey, StatusAborted, StatusClassKey, StatusError, StatusOK, StatusPending, StatusRunning, StatusWarning, StructuredMetadataTable, StructuredMetadataTableListClassKey, StructuredMetadataTableNestedListClassKey, SubvalueCell, SubvalueCellClassKey, SupportButton, SupportButtonClassKey, SupportConfig, SupportItem, SupportItemLink, Tab, TabBarClassKey, TabIconClassKey, TabbedCard, TabbedCardClassKey, TabbedLayout, Table, TableClassKey, TableColumn, TableFilter, TableFiltersClassKey, TableHeaderClassKey, TableProps, TableState, TableToolbarClassKey, Tabs, TabsClassKey, TrendLine, UserIcon, WarningIcon, WarningPanel, WarningPanelClassKey, sidebarConfig, useQueryParamState, useSupportConfig };
|