@kentico/xperience-admin-components 31.7.4 → 31.8.1
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/dist/entry.d.ts +1098 -56
- package/dist/entry.js +21 -21
- package/package.json +7 -7
package/dist/entry.d.ts
CHANGED
|
@@ -31,7 +31,7 @@ export declare interface ActionCell extends TableCell {
|
|
|
31
31
|
*/
|
|
32
32
|
actions: TableAction[];
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Maximum number of visible actions.
|
|
35
35
|
*/
|
|
36
36
|
maxVisibleRowActions?: number;
|
|
37
37
|
/**
|
|
@@ -151,16 +151,28 @@ export declare interface ApplicationTileProps extends UITestProps {
|
|
|
151
151
|
*/
|
|
152
152
|
readonly state?: ApplicationTileState;
|
|
153
153
|
/**
|
|
154
|
-
* Tooltip.
|
|
154
|
+
* Tooltip shown when the label overflows. Defaults to the label text.
|
|
155
155
|
*/
|
|
156
156
|
readonly tooltip?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Placement of the overflow tooltip. Defaults to 'Left'.
|
|
159
|
+
*/
|
|
157
160
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
158
161
|
/**
|
|
159
|
-
*
|
|
162
|
+
* Configuration of the favourite star badge.
|
|
160
163
|
*/
|
|
161
164
|
readonly favouriteTile?: {
|
|
165
|
+
/**
|
|
166
|
+
* Renders the star badge in the tile corner.
|
|
167
|
+
*/
|
|
162
168
|
withStar?: boolean;
|
|
169
|
+
/**
|
|
170
|
+
* Tooltip of the star badge. Defaults to 'Added to favourites'.
|
|
171
|
+
*/
|
|
163
172
|
starTooltip?: string;
|
|
173
|
+
/**
|
|
174
|
+
* Placement of the star badge tooltip.
|
|
175
|
+
*/
|
|
164
176
|
starTooltipPlacement?: TooltipPlacement;
|
|
165
177
|
};
|
|
166
178
|
/**
|
|
@@ -264,6 +276,9 @@ export declare type AvatarBackgroundType = {
|
|
|
264
276
|
export declare const AvatarButton: React_2.ForwardRefExoticComponent<AvatarButtonProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
265
277
|
|
|
266
278
|
export declare interface AvatarButtonProps extends SharedAvatarProps, Pick<React.AnchorHTMLAttributes<HTMLButtonElement>, 'onClick' | 'tabIndex'> {
|
|
279
|
+
/**
|
|
280
|
+
* Applies the activated styling, typically while the menu the avatar triggers is open.
|
|
281
|
+
*/
|
|
267
282
|
readonly activated?: boolean;
|
|
268
283
|
}
|
|
269
284
|
|
|
@@ -287,9 +302,21 @@ export declare const BarItem: React_2.ForwardRefExoticComponent<BarItemProps & R
|
|
|
287
302
|
export declare const BarItemDraggable: React_2.ForwardRefExoticComponent<BarItemDraggableProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
288
303
|
|
|
289
304
|
export declare interface BarItemDraggableProps extends BarItemProps {
|
|
305
|
+
/**
|
|
306
|
+
* Unique identifier of the draggable item within its BarItemGroup.
|
|
307
|
+
*/
|
|
290
308
|
readonly draggableId: string;
|
|
309
|
+
/**
|
|
310
|
+
* Position of the item within its BarItemGroup.
|
|
311
|
+
*/
|
|
291
312
|
readonly index: number;
|
|
313
|
+
/**
|
|
314
|
+
* Disables the drag handle button.
|
|
315
|
+
*/
|
|
292
316
|
readonly draggableButtonDisabled?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* Tooltip of the drag handle button.
|
|
319
|
+
*/
|
|
293
320
|
readonly draggableButtonTitle?: string;
|
|
294
321
|
}
|
|
295
322
|
|
|
@@ -299,14 +326,32 @@ export declare const BarItemGroup: {
|
|
|
299
326
|
};
|
|
300
327
|
|
|
301
328
|
export declare interface BarItemGroupProps {
|
|
329
|
+
/**
|
|
330
|
+
* Unique identifier of the drop area containing the draggable items.
|
|
331
|
+
*/
|
|
302
332
|
readonly droppableId: string;
|
|
333
|
+
/**
|
|
334
|
+
* Handler that fires when a drag ends, with the source and destination indexes of the moved item.
|
|
335
|
+
*/
|
|
303
336
|
readonly onDragEnd: (result: DropResult) => void;
|
|
337
|
+
/**
|
|
338
|
+
* BarItemDraggable items rendered inside the group.
|
|
339
|
+
*/
|
|
304
340
|
readonly children: React.ReactNode;
|
|
305
341
|
}
|
|
306
342
|
|
|
307
343
|
export declare interface BarItemHeaderColumn {
|
|
344
|
+
/**
|
|
345
|
+
* Width of the column in pixels. Columns without a width share the remaining space.
|
|
346
|
+
*/
|
|
308
347
|
readonly width?: number;
|
|
348
|
+
/**
|
|
349
|
+
* Horizontal alignment of the column content.
|
|
350
|
+
*/
|
|
309
351
|
readonly align?: BarItemHeaderColumnAlign;
|
|
352
|
+
/**
|
|
353
|
+
* Content of the column.
|
|
354
|
+
*/
|
|
310
355
|
readonly content: React.ReactNode;
|
|
311
356
|
}
|
|
312
357
|
|
|
@@ -316,38 +361,119 @@ export declare enum BarItemHeaderColumnAlign {
|
|
|
316
361
|
}
|
|
317
362
|
|
|
318
363
|
export declare interface BarItemProps extends UITestProps {
|
|
364
|
+
/**
|
|
365
|
+
* Node rendered at the start of the header, used by BarItemDraggable to inject the drag handle.
|
|
366
|
+
*/
|
|
319
367
|
readonly dragElement?: React.ReactNode;
|
|
368
|
+
/**
|
|
369
|
+
* Icon buttons at the start of the header. The first two or three render inline, the rest collapse into a three-dots menu.
|
|
370
|
+
*/
|
|
320
371
|
readonly leadingButtons?: LeadingButtonProps[];
|
|
372
|
+
/**
|
|
373
|
+
* Controls the expanded state of the body.
|
|
374
|
+
*/
|
|
321
375
|
readonly expanded?: boolean;
|
|
376
|
+
/**
|
|
377
|
+
* Indicates if the header shows the chevron and toggles the body on click. Defaults to true when children are provided.
|
|
378
|
+
*/
|
|
322
379
|
readonly expandable?: boolean;
|
|
380
|
+
/**
|
|
381
|
+
* Applies the drag styling to the header while the item is dragged.
|
|
382
|
+
*/
|
|
323
383
|
readonly isDragging?: boolean;
|
|
384
|
+
/**
|
|
385
|
+
* When provided, replaces the built-in expand and collapse toggle invoked by the header click and Enter key.
|
|
386
|
+
*/
|
|
324
387
|
readonly onHeaderClick?: () => void;
|
|
388
|
+
/**
|
|
389
|
+
* Body content rendered below the header while expanded.
|
|
390
|
+
*/
|
|
325
391
|
readonly children?: React.ReactNode;
|
|
392
|
+
/**
|
|
393
|
+
* Columns laid out in the header.
|
|
394
|
+
*/
|
|
326
395
|
readonly headerColumns?: BarItemHeaderColumn[];
|
|
396
|
+
/**
|
|
397
|
+
* Disables the header interactions, the leading buttons and the chevron.
|
|
398
|
+
*/
|
|
327
399
|
readonly disabled?: boolean;
|
|
328
400
|
}
|
|
329
401
|
|
|
330
402
|
declare interface BaseButtonProps extends UITestProps {
|
|
403
|
+
/**
|
|
404
|
+
* Render callback producing the interactive element, receiving the computed classes and content.
|
|
405
|
+
*/
|
|
331
406
|
readonly renderComponent: (props: InjectedProps) => React.ReactNode;
|
|
407
|
+
/**
|
|
408
|
+
* Size of the button. Defaults to M.
|
|
409
|
+
*/
|
|
332
410
|
readonly size?: ButtonSize;
|
|
411
|
+
/**
|
|
412
|
+
* Visual variant of the button. Defaults to Secondary.
|
|
413
|
+
*/
|
|
333
414
|
readonly color?: ButtonColor;
|
|
415
|
+
/**
|
|
416
|
+
* Text of the button. Without it the button renders icon-only.
|
|
417
|
+
*/
|
|
334
418
|
readonly label?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Icon rendered before the label. Destructive buttons default to the bin icon.
|
|
421
|
+
*/
|
|
335
422
|
readonly icon?: IconName;
|
|
423
|
+
/**
|
|
424
|
+
* Icon rendered after the label.
|
|
425
|
+
*/
|
|
336
426
|
readonly trailingIcon?: IconName;
|
|
427
|
+
/**
|
|
428
|
+
* Applies the pressed visual state.
|
|
429
|
+
*/
|
|
337
430
|
readonly active?: boolean;
|
|
431
|
+
/**
|
|
432
|
+
* Renders a notification dot in the corner of the button.
|
|
433
|
+
*/
|
|
338
434
|
readonly badge?: boolean;
|
|
435
|
+
/**
|
|
436
|
+
* Stretches the button to the full width of its parent.
|
|
437
|
+
*/
|
|
339
438
|
readonly fillContainer?: boolean;
|
|
439
|
+
/**
|
|
440
|
+
* Applies the destructive styling.
|
|
441
|
+
*/
|
|
340
442
|
readonly destructive?: boolean;
|
|
443
|
+
/**
|
|
444
|
+
* Shows a spinner instead of the icon and disables the button.
|
|
445
|
+
*/
|
|
341
446
|
readonly inProgress?: boolean;
|
|
447
|
+
/**
|
|
448
|
+
* Disables the button.
|
|
449
|
+
*/
|
|
342
450
|
readonly disabled?: boolean;
|
|
451
|
+
/**
|
|
452
|
+
* Applies the flat borderless styling.
|
|
453
|
+
*/
|
|
343
454
|
readonly borderless?: boolean;
|
|
455
|
+
/**
|
|
456
|
+
* Tab index of the button element.
|
|
457
|
+
*/
|
|
344
458
|
readonly tabIndex?: number;
|
|
459
|
+
/**
|
|
460
|
+
* Drag handle props from @hello-pangea/dnd making the button act as a drag handle.
|
|
461
|
+
*/
|
|
345
462
|
readonly dragHandleProps?: DraggableProvidedDragHandleProps | null;
|
|
463
|
+
/**
|
|
464
|
+
* Additional class name of the button element.
|
|
465
|
+
*/
|
|
346
466
|
readonly className?: string;
|
|
347
467
|
}
|
|
348
468
|
|
|
349
469
|
declare interface BaseNotificationBarProps extends UITestProps {
|
|
470
|
+
/**
|
|
471
|
+
* Severity of the notification bar. Selects the styling, the icon and the ARIA role.
|
|
472
|
+
*/
|
|
350
473
|
readonly type: NotificationBarType;
|
|
474
|
+
/**
|
|
475
|
+
* Handler of the dismiss button. Its presence renders the button.
|
|
476
|
+
*/
|
|
351
477
|
readonly onDismiss?: () => void;
|
|
352
478
|
/**
|
|
353
479
|
* Disables the increase styling when the notification bar height is increased.
|
|
@@ -365,6 +491,9 @@ declare interface BaseNotificationBarProps extends UITestProps {
|
|
|
365
491
|
* Additional class name for the notification bar.
|
|
366
492
|
*/
|
|
367
493
|
readonly className?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Content of the notification bar. String content renders as the message text.
|
|
496
|
+
*/
|
|
368
497
|
readonly children: string | React.ReactNode;
|
|
369
498
|
/**
|
|
370
499
|
* Actions to be rendered in the notification bar.
|
|
@@ -373,11 +502,29 @@ declare interface BaseNotificationBarProps extends UITestProps {
|
|
|
373
502
|
}
|
|
374
503
|
|
|
375
504
|
declare interface BaseSimpleStatusProps extends UITestProps {
|
|
505
|
+
/**
|
|
506
|
+
* Stretches the status to the full width and height of its container.
|
|
507
|
+
*/
|
|
376
508
|
readonly spread?: boolean;
|
|
509
|
+
/**
|
|
510
|
+
* Severity of the status. Selects the label and icon colors. Fixed by the SimpleStatusError, Success and Warning wrappers.
|
|
511
|
+
*/
|
|
377
512
|
readonly type: SimpleStatusType;
|
|
513
|
+
/**
|
|
514
|
+
* Color token overriding the label color.
|
|
515
|
+
*/
|
|
378
516
|
readonly labelColor?: Colors;
|
|
517
|
+
/**
|
|
518
|
+
* Color token overriding the icon color.
|
|
519
|
+
*/
|
|
379
520
|
readonly iconColor?: Colors;
|
|
521
|
+
/**
|
|
522
|
+
* Content of the status. Requires at least a label or an icon with a tooltip.
|
|
523
|
+
*/
|
|
380
524
|
readonly content: Content;
|
|
525
|
+
/**
|
|
526
|
+
* Size of the status. Defaults to S.
|
|
527
|
+
*/
|
|
381
528
|
readonly size?: SimpleStatusSize;
|
|
382
529
|
}
|
|
383
530
|
|
|
@@ -520,7 +667,7 @@ declare interface BaseTileProps extends BaseTileBaseProps, UITestProps {
|
|
|
520
667
|
*/
|
|
521
668
|
readonly inactiveMessage?: string;
|
|
522
669
|
/**
|
|
523
|
-
*
|
|
670
|
+
* When true, clicking the tile toggles the selection instead of invoking onClick.
|
|
524
671
|
*/
|
|
525
672
|
readonly selectOnClick?: boolean;
|
|
526
673
|
/**
|
|
@@ -578,7 +725,7 @@ declare interface BaseTreeNodeProps {
|
|
|
578
725
|
*/
|
|
579
726
|
readonly isSelectable?: boolean;
|
|
580
727
|
/**
|
|
581
|
-
*
|
|
728
|
+
* Disables the expand and collapse interaction while the expand button stays visible. Defaults to `false`.
|
|
582
729
|
*/
|
|
583
730
|
readonly toggleDisabled?: boolean;
|
|
584
731
|
/**
|
|
@@ -650,28 +797,76 @@ export declare enum BorderRadius {
|
|
|
650
797
|
export declare const Box: React_2.ForwardRefExoticComponent<BoxProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
651
798
|
|
|
652
799
|
export declare interface BoxProps extends LayoutComponentProps, UITestProps {
|
|
800
|
+
/**
|
|
801
|
+
* Padding applied to all four sides. Overridden by the axis and side-specific spacing props.
|
|
802
|
+
*/
|
|
653
803
|
readonly spacing?: Spacing;
|
|
804
|
+
/**
|
|
805
|
+
* Horizontal padding (left and right). Overridden by spacingLeft and spacingRight.
|
|
806
|
+
*/
|
|
654
807
|
readonly spacingX?: Spacing;
|
|
808
|
+
/**
|
|
809
|
+
* Vertical padding (top and bottom). Overridden by spacingTop and spacingBottom.
|
|
810
|
+
*/
|
|
655
811
|
readonly spacingY?: Spacing;
|
|
812
|
+
/**
|
|
813
|
+
* Top padding. Takes precedence over spacingY and spacing.
|
|
814
|
+
*/
|
|
656
815
|
readonly spacingTop?: Spacing;
|
|
816
|
+
/**
|
|
817
|
+
* Right padding. Takes precedence over spacingX and spacing.
|
|
818
|
+
*/
|
|
657
819
|
readonly spacingRight?: Spacing;
|
|
820
|
+
/**
|
|
821
|
+
* Bottom padding. Takes precedence over spacingY and spacing.
|
|
822
|
+
*/
|
|
658
823
|
readonly spacingBottom?: Spacing;
|
|
824
|
+
/**
|
|
825
|
+
* Left padding. Takes precedence over spacingX and spacing.
|
|
826
|
+
*/
|
|
659
827
|
readonly spacingLeft?: Spacing;
|
|
660
828
|
}
|
|
661
829
|
|
|
662
830
|
export declare interface BreadcrumbProps {
|
|
831
|
+
/**
|
|
832
|
+
* Crumb label, also shown as its tooltip.
|
|
833
|
+
*/
|
|
663
834
|
readonly text?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Navigation target. Visible crumbs navigate via the router; crumbs collapsed into the drop-down navigate via a full page load.
|
|
837
|
+
*/
|
|
664
838
|
readonly path: string;
|
|
665
839
|
}
|
|
666
840
|
|
|
667
841
|
export declare const Breadcrumbs: React_2.ForwardRefExoticComponent<BreadcrumbsProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
668
842
|
|
|
669
843
|
export declare interface BreadcrumbsProps {
|
|
844
|
+
/**
|
|
845
|
+
* Content rendered at the trailing end of the bar, typically the page status.
|
|
846
|
+
*/
|
|
670
847
|
readonly status?: React.ReactNode;
|
|
848
|
+
/**
|
|
849
|
+
* When true, all middle items collapse into the ellipsis drop-down regardless of the available width.
|
|
850
|
+
*/
|
|
671
851
|
readonly shorten?: boolean;
|
|
852
|
+
/**
|
|
853
|
+
* Configuration of the page-pin star rendered after the current item. No star is rendered when omitted.
|
|
854
|
+
*/
|
|
672
855
|
readonly pin?: PinProps;
|
|
856
|
+
/**
|
|
857
|
+
* Ordered trail items. The first item is the application root shown after the built-in home crumb
|
|
858
|
+
* and the last item is the current page; the items between them collapse into an ellipsis drop-down
|
|
859
|
+
* when the container runs out of width.
|
|
860
|
+
*/
|
|
673
861
|
readonly breadcrumbs: BreadcrumbProps[];
|
|
862
|
+
/**
|
|
863
|
+
* Called when the trail enters or leaves the minimum-width state, in which no middle items
|
|
864
|
+
* are visible and the remaining crumbs are shrunk to their minimum width.
|
|
865
|
+
*/
|
|
674
866
|
readonly onCollapsedToMinWidthChange?: (isCollapsedToMinWidth: boolean) => void;
|
|
867
|
+
/**
|
|
868
|
+
* Element whose width drives the responsive collapsing. Without it the trail does not collapse.
|
|
869
|
+
*/
|
|
675
870
|
readonly containerRef?: React.RefObject<HTMLElement>;
|
|
676
871
|
}
|
|
677
872
|
|
|
@@ -715,8 +910,17 @@ export declare enum ButtonColor {
|
|
|
715
910
|
}
|
|
716
911
|
|
|
717
912
|
export declare interface ButtonProps extends HTMLButtonProps, Omit<BaseButtonProps, 'renderComponent'> {
|
|
913
|
+
/**
|
|
914
|
+
* HTML type of the button element. Defaults to 'button'.
|
|
915
|
+
*/
|
|
718
916
|
readonly type?: ButtonType;
|
|
917
|
+
/**
|
|
918
|
+
* Ref to the button element, typically used to anchor drop-down menus.
|
|
919
|
+
*/
|
|
719
920
|
readonly buttonRef?: RefObject<HTMLButtonElement>;
|
|
921
|
+
/**
|
|
922
|
+
* Element the tooltip popup is appended to.
|
|
923
|
+
*/
|
|
720
924
|
readonly tooltipAppendTo?: Element;
|
|
721
925
|
}
|
|
722
926
|
|
|
@@ -743,12 +947,33 @@ export declare enum CalloutPlacementType {
|
|
|
743
947
|
}
|
|
744
948
|
|
|
745
949
|
export declare interface CalloutProps extends UITestProps {
|
|
950
|
+
/**
|
|
951
|
+
* Bold heading rendered below the subheadline row.
|
|
952
|
+
*/
|
|
746
953
|
readonly headline?: string;
|
|
954
|
+
/**
|
|
955
|
+
* Text rendered next to the type icon in the first row.
|
|
956
|
+
*/
|
|
747
957
|
readonly subheadline?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Severity of the callout. Selects the icon and the styling.
|
|
960
|
+
*/
|
|
748
961
|
readonly type: CalloutType;
|
|
962
|
+
/**
|
|
963
|
+
* Surface the callout is placed on. Selects the background styling and the default max width.
|
|
964
|
+
*/
|
|
749
965
|
readonly placement: CalloutPlacementType;
|
|
966
|
+
/**
|
|
967
|
+
* Action rendered at the bottom of the callout, typically a Button.
|
|
968
|
+
*/
|
|
750
969
|
readonly actionButton?: React.ReactNode;
|
|
970
|
+
/**
|
|
971
|
+
* Main content of the callout.
|
|
972
|
+
*/
|
|
751
973
|
readonly children?: React.ReactNode;
|
|
974
|
+
/**
|
|
975
|
+
* Maximum width of the callout. Defaults to 600px when placed on desk.
|
|
976
|
+
*/
|
|
752
977
|
readonly maxWidth?: string | number;
|
|
753
978
|
}
|
|
754
979
|
|
|
@@ -827,18 +1052,36 @@ export declare interface CheckboxProps extends CheckboxBaseProps {
|
|
|
827
1052
|
*/
|
|
828
1053
|
readonly onChange?: (event: React.ChangeEvent<HTMLInputElement>, checked: boolean) => void;
|
|
829
1054
|
/**
|
|
830
|
-
* Indicates
|
|
1055
|
+
* Indicates whether the checkbox is highlighted. Applies only when not disabled and not indicating a high importance. Defaults to `false`.
|
|
831
1056
|
*/
|
|
832
1057
|
readonly highlighted?: boolean;
|
|
1058
|
+
/**
|
|
1059
|
+
* Explanatory message shown below the checkbox.
|
|
1060
|
+
*/
|
|
833
1061
|
readonly explanationText?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Explanatory text in tooltip for the disabled checkbox.
|
|
1064
|
+
*/
|
|
834
1065
|
readonly inactiveMessage?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Icon in the label.
|
|
1068
|
+
*/
|
|
835
1069
|
readonly labelIcon?: IconName;
|
|
1070
|
+
/**
|
|
1071
|
+
* Tooltip of the label icon.
|
|
1072
|
+
*/
|
|
836
1073
|
readonly labelIconTooltip?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* Explanatory message shown when the checkbox is invalid.
|
|
1076
|
+
*/
|
|
837
1077
|
readonly validationMessage?: string;
|
|
838
1078
|
/**
|
|
839
|
-
* Indicates whether required sign should be
|
|
1079
|
+
* Indicates whether the required sign should be displayed next to the label.
|
|
840
1080
|
*/
|
|
841
1081
|
readonly markAsRequired?: boolean;
|
|
1082
|
+
/**
|
|
1083
|
+
* Ref to the native checkbox input element.
|
|
1084
|
+
*/
|
|
842
1085
|
readonly inputRef?: RefObject<HTMLInputElement>;
|
|
843
1086
|
/**
|
|
844
1087
|
* Dangerously sets explanation text as inner HTML.
|
|
@@ -1052,6 +1295,9 @@ export declare enum Colors {
|
|
|
1052
1295
|
WarningText = "var(--color-warning-text)"
|
|
1053
1296
|
}
|
|
1054
1297
|
|
|
1298
|
+
/**
|
|
1299
|
+
* Available column spans and flex orders of the 12-column grid.
|
|
1300
|
+
*/
|
|
1055
1301
|
export declare enum Cols {
|
|
1056
1302
|
Col1 = "1",
|
|
1057
1303
|
Col2 = "2",
|
|
@@ -1076,15 +1322,45 @@ export declare enum ColumnContentType {
|
|
|
1076
1322
|
}
|
|
1077
1323
|
|
|
1078
1324
|
export declare interface ColumnProps extends LayoutComponentProps, UITestProps {
|
|
1325
|
+
/**
|
|
1326
|
+
* Fixed width in grid-unit multiples (8px each), including the row gutter. Takes precedence over the cols props.
|
|
1327
|
+
*/
|
|
1079
1328
|
readonly width?: number;
|
|
1329
|
+
/**
|
|
1330
|
+
* Number of the 12 grid columns to span. Without any cols or width the column sizes to its content.
|
|
1331
|
+
*/
|
|
1080
1332
|
readonly cols?: Cols;
|
|
1333
|
+
/**
|
|
1334
|
+
* Column span from the sm breakpoint up.
|
|
1335
|
+
*/
|
|
1081
1336
|
readonly colsSm?: Cols;
|
|
1337
|
+
/**
|
|
1338
|
+
* Column span from the md breakpoint up.
|
|
1339
|
+
*/
|
|
1082
1340
|
readonly colsMd?: Cols;
|
|
1341
|
+
/**
|
|
1342
|
+
* Column span from the lg breakpoint up.
|
|
1343
|
+
*/
|
|
1083
1344
|
readonly colsLg?: Cols;
|
|
1345
|
+
/**
|
|
1346
|
+
* Flex order of the column.
|
|
1347
|
+
*/
|
|
1084
1348
|
readonly order?: Cols;
|
|
1349
|
+
/**
|
|
1350
|
+
* Flex order from the sm breakpoint up.
|
|
1351
|
+
*/
|
|
1085
1352
|
readonly orderSm?: Cols;
|
|
1353
|
+
/**
|
|
1354
|
+
* Flex order from the md breakpoint up.
|
|
1355
|
+
*/
|
|
1086
1356
|
readonly orderMd?: Cols;
|
|
1357
|
+
/**
|
|
1358
|
+
* Flex order from the lg breakpoint up.
|
|
1359
|
+
*/
|
|
1087
1360
|
readonly orderLg?: Cols;
|
|
1361
|
+
/**
|
|
1362
|
+
* Stretches the column to the full height of the row.
|
|
1363
|
+
*/
|
|
1088
1364
|
readonly fullHeight?: boolean;
|
|
1089
1365
|
}
|
|
1090
1366
|
|
|
@@ -1104,9 +1380,21 @@ export declare const Condition: React_2.ForwardRefExoticComponent<ConditionProps
|
|
|
1104
1380
|
export declare const ConditionBuilder: React_2.ForwardRefExoticComponent<ConditionBuilderProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1105
1381
|
|
|
1106
1382
|
export declare interface ConditionBuilderProps {
|
|
1383
|
+
/**
|
|
1384
|
+
* Content of the builder: the operator select row, condition groups and operator lines between them.
|
|
1385
|
+
*/
|
|
1107
1386
|
readonly children?: React.ReactNode;
|
|
1387
|
+
/**
|
|
1388
|
+
* Handler of the footer action button, used to add a new condition group.
|
|
1389
|
+
*/
|
|
1108
1390
|
readonly onActionClick?: () => void;
|
|
1391
|
+
/**
|
|
1392
|
+
* Shows the footer action area with the add button.
|
|
1393
|
+
*/
|
|
1109
1394
|
readonly isActionVisible?: boolean;
|
|
1395
|
+
/**
|
|
1396
|
+
* Label of the footer action button.
|
|
1397
|
+
*/
|
|
1110
1398
|
readonly actionLabel: string;
|
|
1111
1399
|
}
|
|
1112
1400
|
|
|
@@ -1115,26 +1403,50 @@ export declare const ConditionGroup: React_2.ForwardRefExoticComponent<Condition
|
|
|
1115
1403
|
export declare const ConditionGroupOverview: React_2.ForwardRefExoticComponent<ConditionGroupOverviewProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1116
1404
|
|
|
1117
1405
|
export declare interface ConditionGroupOverviewProps {
|
|
1406
|
+
/**
|
|
1407
|
+
* Read-only sentences of the group, typically interleaved with ConditionOperatorOverview separators.
|
|
1408
|
+
*/
|
|
1118
1409
|
readonly children: React.ReactNode;
|
|
1119
1410
|
}
|
|
1120
1411
|
|
|
1121
1412
|
export declare interface ConditionGroupProps {
|
|
1413
|
+
/**
|
|
1414
|
+
* Content of the group: the operator row, condition cards and operator lines between them.
|
|
1415
|
+
*/
|
|
1122
1416
|
readonly children?: React.ReactNode;
|
|
1417
|
+
/**
|
|
1418
|
+
* Shows the footer action button.
|
|
1419
|
+
*/
|
|
1123
1420
|
readonly isActionVisible?: boolean;
|
|
1421
|
+
/**
|
|
1422
|
+
* Handler of the footer action button, used to add another condition to the group.
|
|
1423
|
+
*/
|
|
1124
1424
|
readonly onActionClick?: () => void;
|
|
1425
|
+
/**
|
|
1426
|
+
* Label of the footer action button.
|
|
1427
|
+
*/
|
|
1125
1428
|
readonly actionLabel: string;
|
|
1126
1429
|
}
|
|
1127
1430
|
|
|
1128
1431
|
export declare const ConditionOperatorLine: React_2.ForwardRefExoticComponent<ConditionOperatorLineProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1129
1432
|
|
|
1130
1433
|
export declare interface ConditionOperatorLineProps {
|
|
1434
|
+
/**
|
|
1435
|
+
* Operator text displayed next to the divider, e.g. 'And' or 'Or'.
|
|
1436
|
+
*/
|
|
1131
1437
|
readonly operator: string;
|
|
1132
1438
|
}
|
|
1133
1439
|
|
|
1134
1440
|
export declare const ConditionOperatorOverview: React_2.ForwardRefExoticComponent<ConditionOperatorOverviewProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1135
1441
|
|
|
1136
1442
|
export declare interface ConditionOperatorOverviewProps {
|
|
1443
|
+
/**
|
|
1444
|
+
* Operator text. Rendered uppercased.
|
|
1445
|
+
*/
|
|
1137
1446
|
readonly operator: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* Placement variant: between condition sentences inside a group, or between group boxes.
|
|
1449
|
+
*/
|
|
1138
1450
|
readonly type: ConditionOperatorOverviewType;
|
|
1139
1451
|
}
|
|
1140
1452
|
|
|
@@ -1146,56 +1458,155 @@ export declare enum ConditionOperatorOverviewType {
|
|
|
1146
1458
|
export declare const ConditionOperatorSelect: React_2.ForwardRefExoticComponent<ConditionOperatorSelectProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1147
1459
|
|
|
1148
1460
|
export declare interface ConditionOperatorSelectProps {
|
|
1461
|
+
/**
|
|
1462
|
+
* Segments of the operator sentence, typically text spans interleaved with a Select. Each segment is laid out in its own column.
|
|
1463
|
+
*/
|
|
1149
1464
|
readonly children: React.ReactNode;
|
|
1465
|
+
/**
|
|
1466
|
+
* Configuration of the delete button removing the condition group. The button renders only when provided.
|
|
1467
|
+
*/
|
|
1150
1468
|
readonly deleteButton?: DeleteButtonProps;
|
|
1151
1469
|
}
|
|
1152
1470
|
|
|
1153
1471
|
export declare const ConditionPicker: React_2.ForwardRefExoticComponent<ConditionPickerProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1154
1472
|
|
|
1155
1473
|
export declare interface ConditionPickerItem {
|
|
1474
|
+
/**
|
|
1475
|
+
* Value identifying the condition.
|
|
1476
|
+
*/
|
|
1156
1477
|
readonly value: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Text of the condition tile.
|
|
1480
|
+
*/
|
|
1157
1481
|
readonly label: string;
|
|
1158
1482
|
}
|
|
1159
1483
|
|
|
1160
1484
|
export declare interface ConditionPickerProps {
|
|
1485
|
+
/**
|
|
1486
|
+
* Condition tiles currently shown. The component renders them as given, filtering belongs to the caller.
|
|
1487
|
+
*/
|
|
1161
1488
|
readonly items: ConditionPickerItem[];
|
|
1489
|
+
/**
|
|
1490
|
+
* Handler called with the clicked condition item.
|
|
1491
|
+
*/
|
|
1162
1492
|
readonly onItemSelect: (item: ConditionPickerItem) => void;
|
|
1493
|
+
/**
|
|
1494
|
+
* Handler of the close button in the header.
|
|
1495
|
+
*/
|
|
1163
1496
|
readonly onClose?: () => void;
|
|
1497
|
+
/**
|
|
1498
|
+
* Title of the picker panel.
|
|
1499
|
+
*/
|
|
1164
1500
|
readonly headline?: string;
|
|
1501
|
+
/**
|
|
1502
|
+
* Identifier of the active category.
|
|
1503
|
+
*/
|
|
1165
1504
|
readonly selectedCategoryId: CategoryId;
|
|
1505
|
+
/**
|
|
1506
|
+
* Category buttons rendered as a toggle group.
|
|
1507
|
+
*/
|
|
1166
1508
|
readonly categories: NameToggleButton[];
|
|
1509
|
+
/**
|
|
1510
|
+
* Handler called with the identifier of the toggled category.
|
|
1511
|
+
*/
|
|
1167
1512
|
readonly onCategoryChange: (categoryId: CategoryId) => void;
|
|
1513
|
+
/**
|
|
1514
|
+
* Controlled value of the search input.
|
|
1515
|
+
*/
|
|
1168
1516
|
readonly searchValue?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Handler called with the search text on every change. Filtering belongs to the caller.
|
|
1519
|
+
*/
|
|
1169
1520
|
readonly onSearch: (searchedText: string) => void;
|
|
1521
|
+
/**
|
|
1522
|
+
* Text shown when items is empty.
|
|
1523
|
+
*/
|
|
1170
1524
|
readonly noItemsText: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* Placeholder of the search input.
|
|
1527
|
+
*/
|
|
1171
1528
|
readonly searchPlaceholder?: string;
|
|
1172
1529
|
}
|
|
1173
1530
|
|
|
1174
1531
|
export declare interface ConditionProps {
|
|
1532
|
+
/**
|
|
1533
|
+
* Segments of the condition sentence. Each segment is laid out in its own column.
|
|
1534
|
+
*/
|
|
1175
1535
|
readonly children: React.ReactNode;
|
|
1536
|
+
/**
|
|
1537
|
+
* Configuration of the delete button removing the condition.
|
|
1538
|
+
*/
|
|
1176
1539
|
readonly deleteButton: DeleteButtonProps;
|
|
1177
1540
|
}
|
|
1178
1541
|
|
|
1179
1542
|
declare type Content = {
|
|
1543
|
+
/**
|
|
1544
|
+
* Visible status text. Also shown as a tooltip when it overflows.
|
|
1545
|
+
*/
|
|
1180
1546
|
readonly label?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* Placement of the icon relative to the label.
|
|
1549
|
+
*/
|
|
1181
1550
|
readonly iconAlign?: SimpleStatusAlign;
|
|
1551
|
+
/**
|
|
1552
|
+
* Icon rendered beside the label.
|
|
1553
|
+
*/
|
|
1182
1554
|
readonly iconName: IconName;
|
|
1555
|
+
/**
|
|
1556
|
+
* Tooltip of the status.
|
|
1557
|
+
*/
|
|
1183
1558
|
readonly tooltipText: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* Placement of the tooltip.
|
|
1561
|
+
*/
|
|
1184
1562
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
1563
|
+
/**
|
|
1564
|
+
* Element the tooltip popup is appended to.
|
|
1565
|
+
*/
|
|
1185
1566
|
readonly tooltipAppendTo?: Element;
|
|
1186
1567
|
} | {
|
|
1568
|
+
/**
|
|
1569
|
+
* Visible status text. Also shown as a tooltip when it overflows.
|
|
1570
|
+
*/
|
|
1187
1571
|
readonly label: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* Placement of the icon relative to the label.
|
|
1574
|
+
*/
|
|
1188
1575
|
readonly iconAlign?: SimpleStatusAlign;
|
|
1576
|
+
/**
|
|
1577
|
+
* Icon rendered beside the label.
|
|
1578
|
+
*/
|
|
1189
1579
|
readonly iconName?: IconName;
|
|
1580
|
+
/**
|
|
1581
|
+
* Tooltip of the status.
|
|
1582
|
+
*/
|
|
1190
1583
|
readonly tooltipText?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Placement of the tooltip.
|
|
1586
|
+
*/
|
|
1191
1587
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
1588
|
+
/**
|
|
1589
|
+
* Element the tooltip popup is appended to.
|
|
1590
|
+
*/
|
|
1192
1591
|
readonly tooltipAppendTo?: Element;
|
|
1193
1592
|
};
|
|
1194
1593
|
|
|
1195
1594
|
declare type Content_2 = {
|
|
1595
|
+
/**
|
|
1596
|
+
* Visible label text.
|
|
1597
|
+
*/
|
|
1196
1598
|
readonly title: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* Tooltip shown when the label text overflows.
|
|
1601
|
+
*/
|
|
1197
1602
|
readonly tooltipText?: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* Placement of the tooltip.
|
|
1605
|
+
*/
|
|
1198
1606
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
1607
|
+
/**
|
|
1608
|
+
* Element the tooltip popup is appended to.
|
|
1609
|
+
*/
|
|
1199
1610
|
readonly tooltipAppendTo?: Element;
|
|
1200
1611
|
};
|
|
1201
1612
|
|
|
@@ -1275,11 +1686,11 @@ export declare const DateTimeInput: ForwardRefExoticComponent<DateTimeInputProps
|
|
|
1275
1686
|
|
|
1276
1687
|
export declare interface DateTimeInputProps extends UITestProps {
|
|
1277
1688
|
/**
|
|
1278
|
-
*
|
|
1689
|
+
* Handler called with the new Date instant on segment edits, calendar selection and time changes, or with null on clear.
|
|
1279
1690
|
*/
|
|
1280
1691
|
readonly onChange?: (date: Date | null) => void;
|
|
1281
1692
|
/**
|
|
1282
|
-
*
|
|
1693
|
+
* Selected Date instant.
|
|
1283
1694
|
*/
|
|
1284
1695
|
readonly value?: Date | null;
|
|
1285
1696
|
/**
|
|
@@ -1307,7 +1718,7 @@ export declare interface DateTimeInputProps extends UITestProps {
|
|
|
1307
1718
|
*/
|
|
1308
1719
|
readonly readOnly?: boolean;
|
|
1309
1720
|
/**
|
|
1310
|
-
*
|
|
1721
|
+
* IANA time zone the value is displayed and edited in. Defaults to the browser time zone. Does not change the Date payload.
|
|
1311
1722
|
*/
|
|
1312
1723
|
readonly timeZone?: string;
|
|
1313
1724
|
/**
|
|
@@ -1363,14 +1774,14 @@ export declare const DateTimeRangeInput: ForwardRefExoticComponent<DateTimeRange
|
|
|
1363
1774
|
|
|
1364
1775
|
export declare interface DateTimeRangeInputProps extends UITestProps {
|
|
1365
1776
|
/**
|
|
1366
|
-
*
|
|
1777
|
+
* Handler called with the new from/to Date instants, or with null on clear.
|
|
1367
1778
|
*/
|
|
1368
1779
|
readonly onChange?: (value: {
|
|
1369
1780
|
from: Date;
|
|
1370
1781
|
to: Date;
|
|
1371
1782
|
} | null) => void;
|
|
1372
1783
|
/**
|
|
1373
|
-
*
|
|
1784
|
+
* Selected interval as from/to Date instants.
|
|
1374
1785
|
*/
|
|
1375
1786
|
readonly value?: {
|
|
1376
1787
|
from: Date;
|
|
@@ -1397,7 +1808,7 @@ export declare interface DateTimeRangeInputProps extends UITestProps {
|
|
|
1397
1808
|
*/
|
|
1398
1809
|
readonly readOnly?: boolean;
|
|
1399
1810
|
/**
|
|
1400
|
-
*
|
|
1811
|
+
* IANA time zone the interval is displayed and edited in. Defaults to the browser time zone. The quick range presets snap to the day boundaries of this zone.
|
|
1401
1812
|
*/
|
|
1402
1813
|
readonly timeZone?: string;
|
|
1403
1814
|
/**
|
|
@@ -1411,7 +1822,13 @@ declare type DeepTestIdMapping<T> = {
|
|
|
1411
1822
|
};
|
|
1412
1823
|
|
|
1413
1824
|
declare interface DeleteButtonProps {
|
|
1825
|
+
/**
|
|
1826
|
+
* Tooltip of the delete button.
|
|
1827
|
+
*/
|
|
1414
1828
|
readonly tooltipText: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* Handler invoked when the delete button is clicked.
|
|
1831
|
+
*/
|
|
1415
1832
|
readonly onDelete: () => void;
|
|
1416
1833
|
}
|
|
1417
1834
|
|
|
@@ -1451,7 +1868,13 @@ declare interface DialogContentProps extends DialogFooterProps {
|
|
|
1451
1868
|
}
|
|
1452
1869
|
|
|
1453
1870
|
declare interface DialogFooterActionProps extends Pick<ButtonProps, 'icon' | 'trailingIcon' | 'destructive' | 'disabled' | 'inProgress' | 'color' | 'onClick'>, UITestProps {
|
|
1871
|
+
/**
|
|
1872
|
+
* Label of the action button.
|
|
1873
|
+
*/
|
|
1454
1874
|
readonly label: string;
|
|
1875
|
+
/**
|
|
1876
|
+
* Tooltip of the action button.
|
|
1877
|
+
*/
|
|
1455
1878
|
readonly tooltipText?: string;
|
|
1456
1879
|
}
|
|
1457
1880
|
|
|
@@ -1555,7 +1978,13 @@ export declare enum DividerOrientation {
|
|
|
1555
1978
|
}
|
|
1556
1979
|
|
|
1557
1980
|
export declare interface DividerProps {
|
|
1981
|
+
/**
|
|
1982
|
+
* Renders the rule horizontally or vertically.
|
|
1983
|
+
*/
|
|
1558
1984
|
readonly orientation: DividerOrientation;
|
|
1985
|
+
/**
|
|
1986
|
+
* Applies the subheader divider styling. Used internally by SubheaderDivider.
|
|
1987
|
+
*/
|
|
1559
1988
|
readonly isSubheaderDivider?: boolean;
|
|
1560
1989
|
}
|
|
1561
1990
|
|
|
@@ -1595,7 +2024,14 @@ export declare const DropDownOnClick: {
|
|
|
1595
2024
|
};
|
|
1596
2025
|
|
|
1597
2026
|
export declare interface DropDownOnClickProps extends DropDownProps {
|
|
2027
|
+
/**
|
|
2028
|
+
* Renders the trigger element. Attach the ref to the trigger DOM node and call onTriggerClick to toggle the drop-down;
|
|
2029
|
+
* isOpened carries the current state.
|
|
2030
|
+
*/
|
|
1598
2031
|
readonly renderTrigger: (ref: React.RefObject<HTMLElement>, onTriggerClick: () => void, isOpened: boolean) => React.ReactNode;
|
|
2032
|
+
/**
|
|
2033
|
+
* Called whenever the open state changes.
|
|
2034
|
+
*/
|
|
1599
2035
|
readonly onToggle?: (isOpen: boolean) => void;
|
|
1600
2036
|
}
|
|
1601
2037
|
|
|
@@ -1605,6 +2041,9 @@ export declare const DropDownOnHover: {
|
|
|
1605
2041
|
};
|
|
1606
2042
|
|
|
1607
2043
|
export declare interface DropDownOnHoverProps extends DropDownProps {
|
|
2044
|
+
/**
|
|
2045
|
+
* Renders the trigger element the drop-down opens over on hover; isOpened carries the current state.
|
|
2046
|
+
*/
|
|
1608
2047
|
readonly renderTrigger: (isOpened: boolean) => React.ReactElement;
|
|
1609
2048
|
}
|
|
1610
2049
|
|
|
@@ -1624,12 +2063,24 @@ export declare enum DropDownPlacement {
|
|
|
1624
2063
|
}
|
|
1625
2064
|
|
|
1626
2065
|
declare interface DropDownProps extends UITestProps {
|
|
2066
|
+
/**
|
|
2067
|
+
* Popper placement of the drop-down relative to the trigger. Defaults to Top.
|
|
2068
|
+
*/
|
|
1627
2069
|
readonly placement?: DropDownPlacement;
|
|
2070
|
+
/**
|
|
2071
|
+
* Offset of the drop-down in pixels: skidding shifts it along the trigger edge, distance sets the gap from the trigger.
|
|
2072
|
+
*/
|
|
1628
2073
|
readonly offset?: {
|
|
1629
2074
|
readonly skidding: number;
|
|
1630
2075
|
readonly distance: number;
|
|
1631
2076
|
};
|
|
2077
|
+
/**
|
|
2078
|
+
* Opens the drop-down. The internal trigger interaction updates the state afterwards.
|
|
2079
|
+
*/
|
|
1632
2080
|
readonly open?: boolean;
|
|
2081
|
+
/**
|
|
2082
|
+
* Content of the drop-down.
|
|
2083
|
+
*/
|
|
1633
2084
|
readonly children: React.ReactNode;
|
|
1634
2085
|
}
|
|
1635
2086
|
|
|
@@ -1677,25 +2128,23 @@ export declare interface DropzoneOverlayProps extends DropzoneProps {
|
|
|
1677
2128
|
|
|
1678
2129
|
export declare interface DropzoneProps {
|
|
1679
2130
|
/**
|
|
1680
|
-
*
|
|
2131
|
+
* Handler called with the dropped files.
|
|
1681
2132
|
*/
|
|
1682
2133
|
readonly onUpload: (files: FileList) => void;
|
|
1683
2134
|
/**
|
|
1684
|
-
*
|
|
2135
|
+
* Handler called with true while an allowed transfer is dragged over the dropzone and with false when it leaves. The caller renders the highlight.
|
|
1685
2136
|
*/
|
|
1686
2137
|
readonly onActiveChange: (isActive: boolean) => void;
|
|
1687
2138
|
/**
|
|
1688
|
-
*
|
|
1689
|
-
* If null, everything is permitted.
|
|
1690
|
-
* If true, drag will be permitted. Otherwise false.
|
|
2139
|
+
* Gatekeeper of the dragged data transfer. Returning false suppresses the drop affordance and the active state.
|
|
1691
2140
|
*/
|
|
1692
2141
|
readonly onCurrentTransfer?: (dataTransfer: DataTransfer) => boolean;
|
|
1693
2142
|
/**
|
|
1694
|
-
*
|
|
2143
|
+
* Ignores all drag and drop events.
|
|
1695
2144
|
*/
|
|
1696
2145
|
readonly disabled?: boolean;
|
|
1697
2146
|
/**
|
|
1698
|
-
*
|
|
2147
|
+
* Visible content of the drop target. The dropzone renders no visuals of its own.
|
|
1699
2148
|
*/
|
|
1700
2149
|
readonly children: React.ReactNode;
|
|
1701
2150
|
}
|
|
@@ -1703,8 +2152,17 @@ export declare interface DropzoneProps {
|
|
|
1703
2152
|
export declare const EnablementStatus: React_2.ForwardRefExoticComponent<EnablementStatusProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1704
2153
|
|
|
1705
2154
|
export declare interface EnablementStatusProps extends UITestProps {
|
|
2155
|
+
/**
|
|
2156
|
+
* Color token of the label text.
|
|
2157
|
+
*/
|
|
1706
2158
|
readonly textColor: Colors;
|
|
2159
|
+
/**
|
|
2160
|
+
* Color token of the label pill background.
|
|
2161
|
+
*/
|
|
1707
2162
|
readonly backgroundColor: Colors;
|
|
2163
|
+
/**
|
|
2164
|
+
* Content of the status label.
|
|
2165
|
+
*/
|
|
1708
2166
|
readonly content: Content_2;
|
|
1709
2167
|
}
|
|
1710
2168
|
|
|
@@ -1793,27 +2251,81 @@ export declare enum FormEditMode {
|
|
|
1793
2251
|
export declare const FormItemWrapper: React_2.ForwardRefExoticComponent<FormItemWrapperProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1794
2252
|
|
|
1795
2253
|
export declare interface FormItemWrapperProps extends UITestProps {
|
|
2254
|
+
/**
|
|
2255
|
+
* Id of the wrapped control the label points to.
|
|
2256
|
+
*/
|
|
1796
2257
|
readonly id?: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Renders the control before the label in one clickable row, used by checkboxes and switches.
|
|
2260
|
+
*/
|
|
1797
2261
|
readonly inline?: boolean;
|
|
2262
|
+
/**
|
|
2263
|
+
* Label of the field.
|
|
2264
|
+
*/
|
|
1798
2265
|
readonly label?: string;
|
|
2266
|
+
/**
|
|
2267
|
+
* Displays the required sign next to the label.
|
|
2268
|
+
*/
|
|
1799
2269
|
readonly markAsRequired?: boolean;
|
|
1800
2270
|
/**
|
|
1801
2271
|
* @deprecated Property is deprecated and will be removed in the next version. Use `editMode` set to `FormEditMode.Disabled` instead.
|
|
1802
2272
|
*/
|
|
1803
2273
|
readonly disabled?: boolean;
|
|
2274
|
+
/**
|
|
2275
|
+
* Edit mode of the field. Read-only hides the required sign, status and explanation, disabled greys the chrome out.
|
|
2276
|
+
*/
|
|
1804
2277
|
readonly editMode?: FormEditMode;
|
|
2278
|
+
/**
|
|
2279
|
+
* Explanatory text in tooltip shown while the field is disabled.
|
|
2280
|
+
*/
|
|
1805
2281
|
readonly inactiveMessage?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* Icon rendered after the label.
|
|
2284
|
+
*/
|
|
1806
2285
|
readonly labelIcon?: IconName;
|
|
2286
|
+
/**
|
|
2287
|
+
* Tooltip of the label icon.
|
|
2288
|
+
*/
|
|
1807
2289
|
readonly labelIconTooltip?: string;
|
|
2290
|
+
/**
|
|
2291
|
+
* Additional class name of the label.
|
|
2292
|
+
*/
|
|
1808
2293
|
readonly labelClassnames?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* Additional class name of the footer.
|
|
2296
|
+
*/
|
|
1809
2297
|
readonly footerClassnames?: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* Additional class name of the subheadline.
|
|
2300
|
+
*/
|
|
1810
2301
|
readonly subheadlineClassnames?: string;
|
|
2302
|
+
/**
|
|
2303
|
+
* Additional class name of the children wrapper.
|
|
2304
|
+
*/
|
|
1811
2305
|
readonly childrenWrapperClassnames?: string;
|
|
2306
|
+
/**
|
|
2307
|
+
* Additional class name of the inline row wrapper.
|
|
2308
|
+
*/
|
|
1812
2309
|
readonly inlineWrapperClassnames?: string;
|
|
2310
|
+
/**
|
|
2311
|
+
* Indicates the invalid state. The validation message renders only when set.
|
|
2312
|
+
*/
|
|
1813
2313
|
readonly invalid?: boolean;
|
|
2314
|
+
/**
|
|
2315
|
+
* Explanatory message shown below the field while invalid.
|
|
2316
|
+
*/
|
|
1814
2317
|
readonly validationMessage?: string;
|
|
2318
|
+
/**
|
|
2319
|
+
* Status line shown below the field when not invalid.
|
|
2320
|
+
*/
|
|
1815
2321
|
readonly statusText?: string;
|
|
2322
|
+
/**
|
|
2323
|
+
* Explanatory message shown below the field.
|
|
2324
|
+
*/
|
|
1816
2325
|
readonly explanationText?: string;
|
|
2326
|
+
/**
|
|
2327
|
+
* The wrapped form control.
|
|
2328
|
+
*/
|
|
1817
2329
|
readonly children: React_2.ReactNode;
|
|
1818
2330
|
/**
|
|
1819
2331
|
* Dangerously sets explanation text as inner HTML.
|
|
@@ -1823,7 +2335,13 @@ export declare interface FormItemWrapperProps extends UITestProps {
|
|
|
1823
2335
|
* Dangerously sets tooltip as inner HTML.
|
|
1824
2336
|
*/
|
|
1825
2337
|
readonly tooltipAsHtml?: boolean;
|
|
1826
|
-
|
|
2338
|
+
/**
|
|
2339
|
+
* Handler invoked when the inline row is clicked.
|
|
2340
|
+
*/
|
|
2341
|
+
readonly onInlineWrapperClick?: (e: React_2.MouseEvent<HTMLDivElement>) => void;
|
|
2342
|
+
/**
|
|
2343
|
+
* Element rendered next to the label, typically an action button.
|
|
2344
|
+
*/
|
|
1827
2345
|
readonly labelActionsElement?: React_2.ReactNode;
|
|
1828
2346
|
}
|
|
1829
2347
|
|
|
@@ -1937,8 +2455,17 @@ export declare enum Gradients {
|
|
|
1937
2455
|
export declare const Grid: React_2.ForwardRefExoticComponent<GridProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1938
2456
|
|
|
1939
2457
|
export declare interface GridProps extends LayoutComponentProps, UITestProps {
|
|
2458
|
+
/**
|
|
2459
|
+
* Number of equal-width columns.
|
|
2460
|
+
*/
|
|
1940
2461
|
readonly cols?: number;
|
|
2462
|
+
/**
|
|
2463
|
+
* Vertical gap between rows.
|
|
2464
|
+
*/
|
|
1941
2465
|
readonly rowGap?: Spacing;
|
|
2466
|
+
/**
|
|
2467
|
+
* Horizontal gap between columns.
|
|
2468
|
+
*/
|
|
1942
2469
|
readonly columnGap?: Spacing;
|
|
1943
2470
|
}
|
|
1944
2471
|
|
|
@@ -1956,8 +2483,17 @@ export declare enum HeaderSelection {
|
|
|
1956
2483
|
export declare const Headline: React_2.ForwardRefExoticComponent<HeadlineProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
1957
2484
|
|
|
1958
2485
|
export declare interface HeadlineProps extends Pick<BoxProps, 'spacingTop' | 'spacingBottom' | 'spacingY'> {
|
|
2486
|
+
/**
|
|
2487
|
+
* Content of the headline.
|
|
2488
|
+
*/
|
|
1959
2489
|
readonly children?: React.ReactNode;
|
|
2490
|
+
/**
|
|
2491
|
+
* Size of the headline typography.
|
|
2492
|
+
*/
|
|
1960
2493
|
readonly size: HeadlineSize;
|
|
2494
|
+
/**
|
|
2495
|
+
* Color token applied to the headline text.
|
|
2496
|
+
*/
|
|
1961
2497
|
readonly labelColor?: Colors;
|
|
1962
2498
|
}
|
|
1963
2499
|
|
|
@@ -2076,7 +2612,13 @@ export declare enum IconSize {
|
|
|
2076
2612
|
}
|
|
2077
2613
|
|
|
2078
2614
|
export declare interface IconToggleButton extends Pick<IconButtonProps, 'icon' | 'ariaLabel'>, ToggleButtonsItem {
|
|
2615
|
+
/**
|
|
2616
|
+
* Tooltip of the button.
|
|
2617
|
+
*/
|
|
2079
2618
|
readonly tooltip?: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* Placement of the tooltip.
|
|
2621
|
+
*/
|
|
2080
2622
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
2081
2623
|
}
|
|
2082
2624
|
|
|
@@ -2091,23 +2633,23 @@ export declare const InfoCard: {
|
|
|
2091
2633
|
};
|
|
2092
2634
|
|
|
2093
2635
|
/**
|
|
2094
|
-
*
|
|
2636
|
+
* Data displayed by a single info card.
|
|
2095
2637
|
*/
|
|
2096
2638
|
export declare interface InfoCardData {
|
|
2097
2639
|
/**
|
|
2098
|
-
*
|
|
2640
|
+
* Caption displayed in the top strip next to the info icon.
|
|
2099
2641
|
*/
|
|
2100
2642
|
readonly caption: string;
|
|
2101
2643
|
/**
|
|
2102
|
-
*
|
|
2644
|
+
* Tooltip shown when hovering the info icon next to the caption.
|
|
2103
2645
|
*/
|
|
2104
2646
|
readonly tooltip: string;
|
|
2105
2647
|
/**
|
|
2106
|
-
*
|
|
2648
|
+
* The main metric value.
|
|
2107
2649
|
*/
|
|
2108
2650
|
readonly text: string;
|
|
2109
2651
|
/**
|
|
2110
|
-
*
|
|
2652
|
+
* Secondary line elaborating the main text.
|
|
2111
2653
|
*/
|
|
2112
2654
|
readonly details: string;
|
|
2113
2655
|
}
|
|
@@ -2128,12 +2670,27 @@ export declare const injectIcons: (injectedIcons: React.FC<IconProps>[]) => void
|
|
|
2128
2670
|
export declare const Inline: React_2.ForwardRefExoticComponent<InlineProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
2129
2671
|
|
|
2130
2672
|
export declare interface InlineProps extends LayoutComponentProps, UITestProps {
|
|
2673
|
+
/**
|
|
2674
|
+
* Uniform gap around every child. Defaults to none.
|
|
2675
|
+
*/
|
|
2131
2676
|
readonly spacing?: Spacing;
|
|
2677
|
+
/**
|
|
2678
|
+
* Horizontal gap between children, applied to the side given by spacingXDirection. Falls back to spacing.
|
|
2679
|
+
*/
|
|
2132
2680
|
readonly spacingX?: Spacing;
|
|
2681
|
+
/**
|
|
2682
|
+
* Vertical gap between wrapped lines. Falls back to spacing.
|
|
2683
|
+
*/
|
|
2133
2684
|
readonly spacingY?: Spacing;
|
|
2685
|
+
/**
|
|
2686
|
+
* Side the horizontal gap is applied to. Defaults to Left. Only takes effect when spacingX is set.
|
|
2687
|
+
*/
|
|
2134
2688
|
readonly spacingXDirection?: InlineSpacingXDirection;
|
|
2135
2689
|
}
|
|
2136
2690
|
|
|
2691
|
+
/**
|
|
2692
|
+
* Side of each child the horizontal gap is applied to.
|
|
2693
|
+
*/
|
|
2137
2694
|
export declare enum InlineSpacingXDirection {
|
|
2138
2695
|
Left = "Left",
|
|
2139
2696
|
Right = "Right"
|
|
@@ -2153,7 +2710,7 @@ export declare interface InputBaseProps extends NativeInputProps, UITestProps {
|
|
|
2153
2710
|
*/
|
|
2154
2711
|
readonly readOnly?: boolean;
|
|
2155
2712
|
/**
|
|
2156
|
-
*
|
|
2713
|
+
* Indicates the invalid state of the input.
|
|
2157
2714
|
*/
|
|
2158
2715
|
readonly invalid?: boolean;
|
|
2159
2716
|
/**
|
|
@@ -3417,7 +3974,13 @@ export declare const LabelWithTooltip: {
|
|
|
3417
3974
|
* Represents properties for the LabelWithTooltip component.
|
|
3418
3975
|
*/
|
|
3419
3976
|
export declare interface LabelWithTooltipProps extends UITestProps {
|
|
3977
|
+
/**
|
|
3978
|
+
* Text displayed in the label.
|
|
3979
|
+
*/
|
|
3420
3980
|
readonly label: string;
|
|
3981
|
+
/**
|
|
3982
|
+
* Text displayed in the tooltip of the trailing info icon.
|
|
3983
|
+
*/
|
|
3421
3984
|
readonly tooltipText: string;
|
|
3422
3985
|
}
|
|
3423
3986
|
|
|
@@ -3428,16 +3991,40 @@ export declare enum LayoutAlignment {
|
|
|
3428
3991
|
}
|
|
3429
3992
|
|
|
3430
3993
|
export declare interface LayoutComponentProps {
|
|
3994
|
+
/**
|
|
3995
|
+
* Class name passed to the root element.
|
|
3996
|
+
*/
|
|
3431
3997
|
className?: string;
|
|
3998
|
+
/**
|
|
3999
|
+
* Content of the layout container.
|
|
4000
|
+
*/
|
|
3432
4001
|
children?: React.ReactNode;
|
|
3433
4002
|
}
|
|
3434
4003
|
|
|
3435
4004
|
export declare interface LeadingButtonProps extends UITestProps {
|
|
4005
|
+
/**
|
|
4006
|
+
* Accessible label of the button, shown as the item label when the button overflows into the three-dots menu.
|
|
4007
|
+
*/
|
|
3436
4008
|
readonly label: string;
|
|
4009
|
+
/**
|
|
4010
|
+
* Icon of the button.
|
|
4011
|
+
*/
|
|
3437
4012
|
readonly icon: IconName;
|
|
4013
|
+
/**
|
|
4014
|
+
* Disables the button.
|
|
4015
|
+
*/
|
|
3438
4016
|
readonly disabled?: boolean;
|
|
4017
|
+
/**
|
|
4018
|
+
* Applies the destructive styling.
|
|
4019
|
+
*/
|
|
3439
4020
|
readonly destructive?: boolean;
|
|
4021
|
+
/**
|
|
4022
|
+
* Tooltip of the button.
|
|
4023
|
+
*/
|
|
3440
4024
|
readonly tooltip?: string;
|
|
4025
|
+
/**
|
|
4026
|
+
* Handler invoked when the button is clicked.
|
|
4027
|
+
*/
|
|
3441
4028
|
readonly onClick?: (event: MouseEvent_2<HTMLElement> | KeyboardEvent_2<HTMLElement>) => void;
|
|
3442
4029
|
}
|
|
3443
4030
|
|
|
@@ -3454,6 +4041,9 @@ export declare const LinkButton: {
|
|
|
3454
4041
|
};
|
|
3455
4042
|
|
|
3456
4043
|
export declare interface LinkButtonProps extends AnchorButtonProps, Omit<BaseButtonProps, 'renderComponent'> {
|
|
4044
|
+
/**
|
|
4045
|
+
* Ref to the anchor element.
|
|
4046
|
+
*/
|
|
3457
4047
|
readonly anchorRef?: RefObject<HTMLAnchorElement>;
|
|
3458
4048
|
}
|
|
3459
4049
|
|
|
@@ -3474,7 +4064,7 @@ export declare interface LinkProps extends UITestProps {
|
|
|
3474
4064
|
*/
|
|
3475
4065
|
readonly target?: '_self' | '_blank' | '_parent' | '_top';
|
|
3476
4066
|
/**
|
|
3477
|
-
*
|
|
4067
|
+
* When true, renders plain text instead of an anchor element, with no navigation.
|
|
3478
4068
|
*/
|
|
3479
4069
|
readonly inactive?: boolean;
|
|
3480
4070
|
/**
|
|
@@ -3511,27 +4101,75 @@ declare interface MenuDropDownProps extends Omit<DropDownOnClickProps, 'offset'>
|
|
|
3511
4101
|
export declare const MenuItem: React_2.ForwardRefExoticComponent<MenuItemProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
3512
4102
|
|
|
3513
4103
|
export declare interface MenuItemProps extends UITestProps {
|
|
4104
|
+
/**
|
|
4105
|
+
* Main text of the item. Shown as the tooltip when it overflows.
|
|
4106
|
+
*/
|
|
3514
4107
|
readonly primaryLabel: string;
|
|
4108
|
+
/**
|
|
4109
|
+
* Smaller second line rendered under the primary label.
|
|
4110
|
+
*/
|
|
3515
4111
|
readonly secondaryLabel?: string;
|
|
4112
|
+
/**
|
|
4113
|
+
* Tooltip of the item, combined with the overflow tooltip of the labels.
|
|
4114
|
+
*/
|
|
3516
4115
|
readonly tooltipText?: string;
|
|
4116
|
+
/**
|
|
4117
|
+
* Placement of the tooltip.
|
|
4118
|
+
*/
|
|
3517
4119
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
4120
|
+
/**
|
|
4121
|
+
* Applies the destructive styling to the labels.
|
|
4122
|
+
*/
|
|
3518
4123
|
readonly destructive?: boolean;
|
|
4124
|
+
/**
|
|
4125
|
+
* Disables the item interactions.
|
|
4126
|
+
*/
|
|
3519
4127
|
readonly disabled?: boolean;
|
|
4128
|
+
/**
|
|
4129
|
+
* Applies the selected styling. In multi-select mode also renders the leading check icon.
|
|
4130
|
+
*/
|
|
3520
4131
|
readonly selected?: boolean;
|
|
4132
|
+
/**
|
|
4133
|
+
* Indents the item, used for nested rows in tree-like menus.
|
|
4134
|
+
*/
|
|
3521
4135
|
readonly isNested?: boolean;
|
|
4136
|
+
/**
|
|
4137
|
+
* Disables the hover styling.
|
|
4138
|
+
*/
|
|
3522
4139
|
readonly noHoverCss?: boolean;
|
|
4140
|
+
/**
|
|
4141
|
+
* Reserves a leading slot showing a check icon while the item is selected.
|
|
4142
|
+
*/
|
|
3523
4143
|
readonly isMultiSelect?: boolean;
|
|
4144
|
+
/**
|
|
4145
|
+
* Applies the highlight styling while the submenu of the item is open. Managed by MenuItemWithSubmenu.
|
|
4146
|
+
*/
|
|
3524
4147
|
readonly isSubmenuOpened?: boolean;
|
|
4148
|
+
/**
|
|
4149
|
+
* Element rendered before the labels. The type drives the slot sizing and spacing.
|
|
4150
|
+
*/
|
|
3525
4151
|
readonly leadingElement?: {
|
|
3526
4152
|
readonly type: LeadingElementType;
|
|
3527
4153
|
readonly element: React_2.ReactNode;
|
|
3528
4154
|
};
|
|
4155
|
+
/**
|
|
4156
|
+
* Element rendered after the labels. The type drives the slot sizing and spacing.
|
|
4157
|
+
*/
|
|
3529
4158
|
readonly trailingElement?: {
|
|
3530
4159
|
readonly type: TrailingElementType;
|
|
3531
4160
|
readonly element: React_2.ReactNode;
|
|
3532
4161
|
};
|
|
4162
|
+
/**
|
|
4163
|
+
* Handler invoked on click and on the Enter key.
|
|
4164
|
+
*/
|
|
3533
4165
|
readonly onClick?: (e: MouseEvent_2<HTMLElement> | KeyboardEvent_2<HTMLElement>) => void;
|
|
4166
|
+
/**
|
|
4167
|
+
* Value of the item, read by parent components such as Select to track the selected option.
|
|
4168
|
+
*/
|
|
3534
4169
|
readonly value?: string;
|
|
4170
|
+
/**
|
|
4171
|
+
* Increases the row height.
|
|
4172
|
+
*/
|
|
3535
4173
|
readonly large?: boolean;
|
|
3536
4174
|
}
|
|
3537
4175
|
|
|
@@ -3541,6 +4179,9 @@ export declare const MenuItemWithSubmenu: {
|
|
|
3541
4179
|
};
|
|
3542
4180
|
|
|
3543
4181
|
export declare interface MenuItemWithSubmenuProps extends Omit<MenuItemProps, 'isSubmenuOpened' | 'trailingElement'> {
|
|
4182
|
+
/**
|
|
4183
|
+
* Content of the submenu opened on hover, typically a SelectMenu with MenuItem components.
|
|
4184
|
+
*/
|
|
3544
4185
|
readonly submenuContent: React_2.ReactNode;
|
|
3545
4186
|
}
|
|
3546
4187
|
|
|
@@ -3596,12 +4237,18 @@ declare type NativeInputProps = Pick<React.InputHTMLAttributes<HTMLInputElement>
|
|
|
3596
4237
|
export declare const NotificationBarAlert: ForwardRefExoticComponent<NotificationBarAlertProps & RefAttributes<HTMLDivElement>>;
|
|
3597
4238
|
|
|
3598
4239
|
export declare interface NotificationBarAlertProps extends Pick<BaseNotificationBarProps, 'noAutoIncrease' | 'children' | 'childrenAsHtml' | 'dataTestId' | 'noBoldWeight' | 'className' | 'actions'> {
|
|
4240
|
+
/**
|
|
4241
|
+
* Handler of the dismiss button. Its presence renders the button.
|
|
4242
|
+
*/
|
|
3599
4243
|
readonly onDismiss?: () => void;
|
|
3600
4244
|
}
|
|
3601
4245
|
|
|
3602
4246
|
export declare const NotificationBarInfo: ForwardRefExoticComponent<NotificationBarInfoProps & RefAttributes<HTMLDivElement>>;
|
|
3603
4247
|
|
|
3604
4248
|
export declare interface NotificationBarInfoProps extends Pick<BaseNotificationBarProps, 'noAutoIncrease' | 'children' | 'childrenAsHtml' | 'dataTestId' | 'noBoldWeight' | 'className' | 'actions'> {
|
|
4249
|
+
/**
|
|
4250
|
+
* Handler of the dismiss button. Its presence renders the button.
|
|
4251
|
+
*/
|
|
3605
4252
|
readonly onDismiss?: () => void;
|
|
3606
4253
|
}
|
|
3607
4254
|
|
|
@@ -3614,6 +4261,9 @@ declare enum NotificationBarType {
|
|
|
3614
4261
|
export declare const NotificationBarWarning: ForwardRefExoticComponent<NotificationBarWarningProps & RefAttributes<HTMLDivElement>>;
|
|
3615
4262
|
|
|
3616
4263
|
export declare interface NotificationBarWarningProps extends Pick<BaseNotificationBarProps, 'noAutoIncrease' | 'children' | 'childrenAsHtml' | 'dataTestId' | 'noBoldWeight' | 'className' | 'actions'> {
|
|
4264
|
+
/**
|
|
4265
|
+
* Handler of the dismiss button. Its presence renders the button.
|
|
4266
|
+
*/
|
|
3617
4267
|
readonly onDismiss?: () => void;
|
|
3618
4268
|
}
|
|
3619
4269
|
|
|
@@ -3627,22 +4277,49 @@ export declare const OptionalTooltip: {
|
|
|
3627
4277
|
*/
|
|
3628
4278
|
export declare interface OptionalTooltipProps extends Omit<TooltipProps, 'shortcuts' | 'children'> {
|
|
3629
4279
|
/**
|
|
3630
|
-
*
|
|
4280
|
+
* Text content that is measured for truncation. When truncated, it is appended to the tooltip.
|
|
3631
4281
|
*/
|
|
3632
4282
|
readonly text: string;
|
|
4283
|
+
/**
|
|
4284
|
+
* Custom renderer of the text element. Attach the provided ref to the element measured for truncation; children are ignored when set.
|
|
4285
|
+
*/
|
|
3633
4286
|
readonly customRenderText?: (refForTruncatedElement: RefObject<any>) => React_2.ReactElement;
|
|
4287
|
+
/**
|
|
4288
|
+
* Text content rendered inside the measured wrapper when customRenderText is not provided.
|
|
4289
|
+
*/
|
|
3634
4290
|
readonly children?: React_2.ReactNode | string;
|
|
3635
4291
|
}
|
|
3636
4292
|
|
|
3637
4293
|
export declare const OptionTile: React_2.ForwardRefExoticComponent<OptionTileProps & React_2.RefAttributes<HTMLButtonElement>>;
|
|
3638
4294
|
|
|
3639
4295
|
export declare interface OptionTileProps extends Pick<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onClick' | 'tabIndex'> {
|
|
4296
|
+
/**
|
|
4297
|
+
* Text of the tile. Shown as the tooltip when it overflows.
|
|
4298
|
+
*/
|
|
3640
4299
|
readonly label: string;
|
|
4300
|
+
/**
|
|
4301
|
+
* Icon rendered before the label.
|
|
4302
|
+
*/
|
|
3641
4303
|
readonly startIcon?: IconName;
|
|
4304
|
+
/**
|
|
4305
|
+
* Icon rendered at the right edge of the tile.
|
|
4306
|
+
*/
|
|
3642
4307
|
readonly endIcon?: IconName;
|
|
4308
|
+
/**
|
|
4309
|
+
* Stretches the tile to the full container width.
|
|
4310
|
+
*/
|
|
3643
4311
|
readonly block?: boolean;
|
|
4312
|
+
/**
|
|
4313
|
+
* Maximum width of the tile.
|
|
4314
|
+
*/
|
|
3644
4315
|
readonly maxWidth?: string | number;
|
|
4316
|
+
/**
|
|
4317
|
+
* Test id data attribute.
|
|
4318
|
+
*/
|
|
3645
4319
|
readonly dataTestId?: TestId;
|
|
4320
|
+
/**
|
|
4321
|
+
* Applies the expanding styling stretching the tile to the container width.
|
|
4322
|
+
*/
|
|
3646
4323
|
readonly shouldExpand?: boolean;
|
|
3647
4324
|
}
|
|
3648
4325
|
|
|
@@ -3717,8 +4394,17 @@ export declare interface PaperProps extends DivBaseProps, UITestProps {
|
|
|
3717
4394
|
}
|
|
3718
4395
|
|
|
3719
4396
|
export declare interface PinProps {
|
|
4397
|
+
/**
|
|
4398
|
+
* Renders the filled star when true, the empty star otherwise.
|
|
4399
|
+
*/
|
|
3720
4400
|
readonly active: boolean;
|
|
4401
|
+
/**
|
|
4402
|
+
* Tooltip of the star button.
|
|
4403
|
+
*/
|
|
3721
4404
|
readonly tooltip: string;
|
|
4405
|
+
/**
|
|
4406
|
+
* Called when the star is clicked.
|
|
4407
|
+
*/
|
|
3722
4408
|
readonly onClick: () => void;
|
|
3723
4409
|
}
|
|
3724
4410
|
|
|
@@ -3726,7 +4412,7 @@ export declare const ProgressBar: React_2.ForwardRefExoticComponent<ProgressBarP
|
|
|
3726
4412
|
|
|
3727
4413
|
export declare interface ProgressBarProps {
|
|
3728
4414
|
/**
|
|
3729
|
-
*
|
|
4415
|
+
* Completed percentage of the tracked operation. Values are clamped to the 0-100 range.
|
|
3730
4416
|
*/
|
|
3731
4417
|
readonly completed?: number;
|
|
3732
4418
|
}
|
|
@@ -3784,16 +4470,37 @@ export declare interface RadioButtonProps {
|
|
|
3784
4470
|
export declare const RadioGroup: React_2.ForwardRefExoticComponent<RadioGroupProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
3785
4471
|
|
|
3786
4472
|
export declare interface RadioGroupProps extends Omit<FormItemWrapperProps, 'id' | 'inline' | 'labelClassnames' | 'footerClassnames' | 'subheadlineClassnames' | 'editMode' | 'disabled'> {
|
|
4473
|
+
/**
|
|
4474
|
+
* Name of the radio group shared by its radio buttons.
|
|
4475
|
+
*/
|
|
3787
4476
|
readonly name: string;
|
|
4477
|
+
/**
|
|
4478
|
+
* Value of the selected radio button.
|
|
4479
|
+
*/
|
|
3788
4480
|
readonly value?: string;
|
|
4481
|
+
/**
|
|
4482
|
+
* Handler called with the value of the newly selected radio button.
|
|
4483
|
+
*/
|
|
3789
4484
|
readonly onChange?: (value: string) => void;
|
|
4485
|
+
/**
|
|
4486
|
+
* Size of the radio buttons. Defaults to Medium.
|
|
4487
|
+
*/
|
|
3790
4488
|
readonly size?: RadioGroupSize;
|
|
4489
|
+
/**
|
|
4490
|
+
* Lays the radio buttons out horizontally.
|
|
4491
|
+
*/
|
|
3791
4492
|
readonly inline?: boolean;
|
|
3792
4493
|
/**
|
|
3793
4494
|
* @deprecated Property is deprecated and will be removed in the next version. Use `aria-label` instead.
|
|
3794
4495
|
*/
|
|
3795
4496
|
readonly ariaLabel?: string;
|
|
4497
|
+
/**
|
|
4498
|
+
* Disables the whole group.
|
|
4499
|
+
*/
|
|
3796
4500
|
readonly disabled?: boolean;
|
|
4501
|
+
/**
|
|
4502
|
+
* Makes the whole group read-only.
|
|
4503
|
+
*/
|
|
3797
4504
|
readonly readOnly?: boolean;
|
|
3798
4505
|
}
|
|
3799
4506
|
|
|
@@ -3962,12 +4669,16 @@ export declare interface RichTextEditorProps extends UITestProps {
|
|
|
3962
4669
|
*/
|
|
3963
4670
|
readonly htmlSanitizerConfiguration?: HTMLSanitizerConfig;
|
|
3964
4671
|
/**
|
|
3965
|
-
* Height
|
|
3966
|
-
* If both are set then min-height will always be height.
|
|
3967
|
-
* Height, minHeight, maxHeight - for long text options.
|
|
4672
|
+
* Height of the editor area. Takes priority over minHeight when both are set.
|
|
3968
4673
|
*/
|
|
3969
4674
|
readonly height?: number | string;
|
|
4675
|
+
/**
|
|
4676
|
+
* Minimum height of the editor area.
|
|
4677
|
+
*/
|
|
3970
4678
|
readonly minHeight?: number | string;
|
|
4679
|
+
/**
|
|
4680
|
+
* Maximum height of the editor area.
|
|
4681
|
+
*/
|
|
3971
4682
|
readonly maxHeight?: number | string;
|
|
3972
4683
|
/**
|
|
3973
4684
|
* Dangerously sets tooltip as inner HTML.
|
|
@@ -4029,15 +4740,36 @@ export declare interface RichTextEditorRef {
|
|
|
4029
4740
|
|
|
4030
4741
|
export declare const Row: React_2.ForwardRefExoticComponent<RowProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4031
4742
|
|
|
4032
|
-
export declare interface RowProps extends LayoutComponentProps {
|
|
4743
|
+
export declare interface RowProps extends LayoutComponentProps, UITestProps {
|
|
4744
|
+
/**
|
|
4745
|
+
* Horizontal alignment of the columns along the main axis.
|
|
4746
|
+
*/
|
|
4033
4747
|
readonly alignX?: LayoutAlignment;
|
|
4748
|
+
/**
|
|
4749
|
+
* Vertical alignment of the columns along the cross axis. Defaults to Start, which renders as stretch.
|
|
4750
|
+
*/
|
|
4034
4751
|
readonly alignY?: LayoutAlignment;
|
|
4752
|
+
/**
|
|
4753
|
+
* Gutter between columns on both axes.
|
|
4754
|
+
*/
|
|
4035
4755
|
readonly spacing?: Spacing;
|
|
4756
|
+
/**
|
|
4757
|
+
* Horizontal gutter between columns. Overrides spacing on the horizontal axis.
|
|
4758
|
+
*/
|
|
4036
4759
|
readonly spacingX?: Spacing;
|
|
4760
|
+
/**
|
|
4761
|
+
* Vertical gutter between wrapped lines. Overrides spacing on the vertical axis.
|
|
4762
|
+
*/
|
|
4037
4763
|
readonly spacingY?: Spacing;
|
|
4764
|
+
/**
|
|
4765
|
+
* Wrapping of the columns. Defaults to Wrap.
|
|
4766
|
+
*/
|
|
4038
4767
|
readonly wrap?: RowWrap;
|
|
4039
4768
|
}
|
|
4040
4769
|
|
|
4770
|
+
/**
|
|
4771
|
+
* Wrapping behavior of the row columns.
|
|
4772
|
+
*/
|
|
4041
4773
|
export declare enum RowWrap {
|
|
4042
4774
|
NoWrap = "nowrap",
|
|
4043
4775
|
Wrap = "wrap",
|
|
@@ -4062,25 +4794,67 @@ export declare const Select: React_2.ForwardRefExoticComponent<SelectProps & Rea
|
|
|
4062
4794
|
export declare const SelectGroupCell: React_2.ForwardRefExoticComponent<SelectGroupCellProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4063
4795
|
|
|
4064
4796
|
declare interface SelectGroupCellProps extends UITestProps {
|
|
4797
|
+
/**
|
|
4798
|
+
* Indicates the open state of the cell drop-down. Flips the chevron.
|
|
4799
|
+
*/
|
|
4065
4800
|
readonly open?: boolean;
|
|
4801
|
+
/**
|
|
4802
|
+
* Text of the cell.
|
|
4803
|
+
*/
|
|
4066
4804
|
readonly label?: string;
|
|
4805
|
+
/**
|
|
4806
|
+
* Tooltip of the cell.
|
|
4807
|
+
*/
|
|
4067
4808
|
readonly tooltipText?: string;
|
|
4809
|
+
/**
|
|
4810
|
+
* Icon rendered at the start of the cell.
|
|
4811
|
+
*/
|
|
4068
4812
|
readonly icon?: IconName;
|
|
4813
|
+
/**
|
|
4814
|
+
* Element rendered at the start of the cell instead of the icon. The type drives the slot sizing.
|
|
4815
|
+
*/
|
|
4069
4816
|
readonly leadingElement?: {
|
|
4070
4817
|
readonly type: LeadingElementType;
|
|
4071
4818
|
readonly element: React.ReactNode;
|
|
4072
4819
|
};
|
|
4820
|
+
/**
|
|
4821
|
+
* Renders the cell as the icon-only overflow cell.
|
|
4822
|
+
*/
|
|
4073
4823
|
readonly ellipsis?: boolean;
|
|
4824
|
+
/**
|
|
4825
|
+
* Handler invoked when the cell is clicked.
|
|
4826
|
+
*/
|
|
4074
4827
|
readonly onClick?: MouseEventHandler<HTMLElement>;
|
|
4828
|
+
/**
|
|
4829
|
+
* Removes the chevron and the click affordance.
|
|
4830
|
+
*/
|
|
4075
4831
|
readonly selectionDisabled?: boolean;
|
|
4832
|
+
/**
|
|
4833
|
+
* Ref to the label element, used by callers to measure truncation.
|
|
4834
|
+
*/
|
|
4076
4835
|
readonly labelRef?: React.RefObject<HTMLDivElement>;
|
|
4836
|
+
/**
|
|
4837
|
+
* Additional class name of the cell.
|
|
4838
|
+
*/
|
|
4077
4839
|
readonly className?: string;
|
|
4078
4840
|
}
|
|
4079
4841
|
|
|
4080
4842
|
export declare interface SelectGroupProps<SelectShape> {
|
|
4843
|
+
/**
|
|
4844
|
+
* Data of the selector cells, one cell per item. Cells overflowing the container collapse behind an ellipsis cell.
|
|
4845
|
+
*/
|
|
4081
4846
|
readonly selects: SelectShape[];
|
|
4847
|
+
/**
|
|
4848
|
+
* Minimum width of the group in pixels.
|
|
4849
|
+
*/
|
|
4082
4850
|
readonly minWidth?: number;
|
|
4851
|
+
/**
|
|
4852
|
+
* Additional class name of the underlying Paper.
|
|
4853
|
+
*/
|
|
4083
4854
|
readonly paperClassName?: string;
|
|
4855
|
+
/**
|
|
4856
|
+
* Renders one selector cell. onItemClick must be invoked on item selection, visible carries the current label visibility.
|
|
4857
|
+
*/
|
|
4084
4858
|
readonly renderSelect: (select: SelectShape, onItemClick: () => void, visible: boolean, index: number) => React.ReactNode;
|
|
4085
4859
|
}
|
|
4086
4860
|
|
|
@@ -4098,9 +4872,21 @@ export declare interface SelectorItemInfoTableCellComponentProps {
|
|
|
4098
4872
|
}
|
|
4099
4873
|
|
|
4100
4874
|
export declare interface SelectProps extends Omit<InputProps, 'type' | 'actionElement' | 'onChange'>, Pick<DropDownActionMenuProps, 'maxContentHeight'> {
|
|
4875
|
+
/**
|
|
4876
|
+
* Handler called with the value of the selected MenuItem, or with an empty string on clear.
|
|
4877
|
+
*/
|
|
4101
4878
|
readonly onChange?: (value?: string) => void;
|
|
4879
|
+
/**
|
|
4880
|
+
* Options of the select. MenuItem children anywhere in the tree are wired up, the one matching the value supplies the visible text.
|
|
4881
|
+
*/
|
|
4102
4882
|
readonly children: React.ReactNode;
|
|
4883
|
+
/**
|
|
4884
|
+
* Renders a clear button inside the field while a value is selected.
|
|
4885
|
+
*/
|
|
4103
4886
|
readonly clearable?: boolean;
|
|
4887
|
+
/**
|
|
4888
|
+
* Tooltip of the clear button.
|
|
4889
|
+
*/
|
|
4104
4890
|
readonly clearButtonTooltip?: string;
|
|
4105
4891
|
}
|
|
4106
4892
|
|
|
@@ -4144,9 +4930,12 @@ declare interface SharedAvatarProps {
|
|
|
4144
4930
|
export declare const Shelf: React_2.ForwardRefExoticComponent<ShelfProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4145
4931
|
|
|
4146
4932
|
export declare interface ShelfProps {
|
|
4933
|
+
/**
|
|
4934
|
+
* Content of the shelf.
|
|
4935
|
+
*/
|
|
4147
4936
|
readonly children?: React.ReactNode;
|
|
4148
4937
|
/**
|
|
4149
|
-
*
|
|
4938
|
+
* Side the shelf sticks to. The stuck side renders with square corners.
|
|
4150
4939
|
*/
|
|
4151
4940
|
readonly sticky?: ShelfStickyPosition;
|
|
4152
4941
|
/**
|
|
@@ -4179,13 +4968,28 @@ export declare enum SideMenuItemState {
|
|
|
4179
4968
|
export declare const SideMenuItemTile: React_2.ForwardRefExoticComponent<SideMenuItemTileProps & React_2.RefAttributes<HTMLButtonElement>>;
|
|
4180
4969
|
|
|
4181
4970
|
export declare interface SideMenuItemTileProps extends UITestProps {
|
|
4971
|
+
/**
|
|
4972
|
+
* Text label of the tile, also used as the accessible name of the button.
|
|
4973
|
+
*/
|
|
4182
4974
|
readonly label: string;
|
|
4975
|
+
/**
|
|
4976
|
+
* Icon rendered above the label.
|
|
4977
|
+
*/
|
|
4183
4978
|
readonly iconName: IconName;
|
|
4979
|
+
/**
|
|
4980
|
+
* Visual and interaction state of the tile. Defaults to Default.
|
|
4981
|
+
*/
|
|
4184
4982
|
readonly state?: SideMenuItemState;
|
|
4983
|
+
/**
|
|
4984
|
+
* Called when the tile is clicked. Not called in the Disabled state.
|
|
4985
|
+
*/
|
|
4185
4986
|
readonly onClick?: (e: React_2.MouseEvent<HTMLButtonElement>) => void;
|
|
4186
4987
|
}
|
|
4187
4988
|
|
|
4188
4989
|
export declare interface SideMenuProps extends UITestProps {
|
|
4990
|
+
/**
|
|
4991
|
+
* Menu tiles stacked vertically, typically SideMenuItemTile components.
|
|
4992
|
+
*/
|
|
4189
4993
|
readonly children: React_2.ReactNode;
|
|
4190
4994
|
}
|
|
4191
4995
|
|
|
@@ -4342,7 +5146,7 @@ export declare interface SidePanelProps extends UITestProps {
|
|
|
4342
5146
|
*/
|
|
4343
5147
|
readonly onClose: (event: SidePanelCloseEvent) => Promise<void> | void;
|
|
4344
5148
|
/**
|
|
4345
|
-
* Can the side panel maximize and cover whole content? This will add minimize/maximize button to
|
|
5149
|
+
* Can the side panel maximize and cover whole content? This will add a minimize/maximize button to the panel's header.
|
|
4346
5150
|
* By default false.
|
|
4347
5151
|
*/
|
|
4348
5152
|
readonly isMaximizable?: boolean;
|
|
@@ -4352,12 +5156,12 @@ export declare interface SidePanelProps extends UITestProps {
|
|
|
4352
5156
|
*/
|
|
4353
5157
|
readonly isMaximized?: boolean;
|
|
4354
5158
|
/**
|
|
4355
|
-
* Indicates if the side
|
|
5159
|
+
* Indicates if the side panel has a close button in the panel's header.
|
|
4356
5160
|
* By default true.
|
|
4357
5161
|
*/
|
|
4358
5162
|
readonly showCloseButton?: boolean;
|
|
4359
5163
|
/**
|
|
4360
|
-
*
|
|
5164
|
+
* Indicates whether the side panel can be closed by clicking outside of it.
|
|
4361
5165
|
* By default true.
|
|
4362
5166
|
*/
|
|
4363
5167
|
readonly isOutsideClickCloseable?: boolean;
|
|
@@ -4407,11 +5211,29 @@ export declare interface SimpleStatusDefaultProps extends Omit<BaseSimpleStatusP
|
|
|
4407
5211
|
export declare const SimpleStatusError: React_2.ForwardRefExoticComponent<SimpleStatusErrorProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4408
5212
|
|
|
4409
5213
|
export declare interface SimpleStatusErrorProps extends Omit<BaseSimpleStatusProps, 'type' | 'content' | 'labelColor' | 'iconColor'> {
|
|
5214
|
+
/**
|
|
5215
|
+
* Content of the status. The error icon is fixed.
|
|
5216
|
+
*/
|
|
4410
5217
|
readonly content: {
|
|
5218
|
+
/**
|
|
5219
|
+
* Visible status text.
|
|
5220
|
+
*/
|
|
4411
5221
|
readonly label: string;
|
|
5222
|
+
/**
|
|
5223
|
+
* Placement of the icon relative to the label.
|
|
5224
|
+
*/
|
|
4412
5225
|
readonly iconAlign?: SimpleStatusAlign;
|
|
5226
|
+
/**
|
|
5227
|
+
* Tooltip of the status.
|
|
5228
|
+
*/
|
|
4413
5229
|
readonly tooltipText?: string;
|
|
5230
|
+
/**
|
|
5231
|
+
* Placement of the tooltip.
|
|
5232
|
+
*/
|
|
4414
5233
|
readonly tooltipPlacement?: TooltipPlacement;
|
|
5234
|
+
/**
|
|
5235
|
+
* Element the tooltip popup is appended to.
|
|
5236
|
+
*/
|
|
4415
5237
|
readonly tooltipAppendTo?: Element;
|
|
4416
5238
|
};
|
|
4417
5239
|
}
|
|
@@ -4451,8 +5273,17 @@ export declare const SkeletonBody: {
|
|
|
4451
5273
|
};
|
|
4452
5274
|
|
|
4453
5275
|
declare interface SkeletonBodyProps {
|
|
5276
|
+
/**
|
|
5277
|
+
* Number of skeleton rows to render.
|
|
5278
|
+
*/
|
|
4454
5279
|
readonly rowCount: number;
|
|
5280
|
+
/**
|
|
5281
|
+
* Columns of the table the skeleton stands in for. The content type of each column selects the skeleton cell shape.
|
|
5282
|
+
*/
|
|
4455
5283
|
readonly columns: TableColumn[];
|
|
5284
|
+
/**
|
|
5285
|
+
* Reserves the checkbox column so the skeleton matches a selectable table.
|
|
5286
|
+
*/
|
|
4456
5287
|
readonly selectable?: boolean;
|
|
4457
5288
|
}
|
|
4458
5289
|
|
|
@@ -4482,9 +5313,21 @@ export declare enum SnackbarItemVariant {
|
|
|
4482
5313
|
export declare const SnackbarProvider: ({ children, position, verticalSpacing, horizontalSpacing }: SnackbarProviderProps) => JSX_2.Element;
|
|
4483
5314
|
|
|
4484
5315
|
declare interface SnackbarProviderProps {
|
|
5316
|
+
/**
|
|
5317
|
+
* Subtree that gains access to the snackbar context.
|
|
5318
|
+
*/
|
|
4485
5319
|
readonly children: React.ReactNode;
|
|
5320
|
+
/**
|
|
5321
|
+
* Viewport corner or edge the messages anchor to. Defaults to BottomRight.
|
|
5322
|
+
*/
|
|
4486
5323
|
readonly position?: SnackbarItemPosition;
|
|
5324
|
+
/**
|
|
5325
|
+
* Additional vertical offset of the message stack.
|
|
5326
|
+
*/
|
|
4487
5327
|
readonly verticalSpacing?: SnackbarSpacing;
|
|
5328
|
+
/**
|
|
5329
|
+
* Additional horizontal offset of the message stack.
|
|
5330
|
+
*/
|
|
4488
5331
|
readonly horizontalSpacing?: SnackbarSpacing;
|
|
4489
5332
|
}
|
|
4490
5333
|
|
|
@@ -4529,6 +5372,9 @@ export declare const Spinner: {
|
|
|
4529
5372
|
};
|
|
4530
5373
|
|
|
4531
5374
|
export declare interface SpinnerProps extends Omit<IconProps, 'name'> {
|
|
5375
|
+
/**
|
|
5376
|
+
* Additional class name controlling the spinner size, color or margins.
|
|
5377
|
+
*/
|
|
4532
5378
|
className?: string;
|
|
4533
5379
|
}
|
|
4534
5380
|
|
|
@@ -4544,23 +5390,62 @@ export declare enum SplitButtonDisabledState {
|
|
|
4544
5390
|
}
|
|
4545
5391
|
|
|
4546
5392
|
export declare interface SplitButtonProps extends Omit<BaseButtonProps, 'renderComponent' | 'trailingIcon' | 'active' | 'badge' | 'fillContainer' | 'destructive' | 'borderless' | 'className'> {
|
|
5393
|
+
/**
|
|
5394
|
+
* Visual variant of the button.
|
|
5395
|
+
*/
|
|
4547
5396
|
readonly color: ButtonColor.Primary | ButtonColor.Secondary | ButtonColor.Tertiary;
|
|
5397
|
+
/**
|
|
5398
|
+
* Handler called with the new open state of the drop-down. When provided, the chevron delegates the toggling to it.
|
|
5399
|
+
*/
|
|
4548
5400
|
readonly onToggle?: (isOpen: boolean) => void;
|
|
5401
|
+
/**
|
|
5402
|
+
* Size of the button.
|
|
5403
|
+
*/
|
|
4549
5404
|
readonly size: ButtonSize.S | ButtonSize.M | ButtonSize.L;
|
|
5405
|
+
/**
|
|
5406
|
+
* Controls the open state of the drop-down.
|
|
5407
|
+
*/
|
|
4550
5408
|
readonly open?: boolean;
|
|
5409
|
+
/**
|
|
5410
|
+
* When provided, the main half renders as a link to this URL instead of a button.
|
|
5411
|
+
*/
|
|
4551
5412
|
readonly href?: string;
|
|
5413
|
+
/**
|
|
5414
|
+
* Target of the link rendered from href.
|
|
5415
|
+
*/
|
|
4552
5416
|
readonly target?: HTMLAttributeAnchorTarget;
|
|
5417
|
+
/**
|
|
5418
|
+
* Handler invoked when the main half is clicked.
|
|
5419
|
+
*/
|
|
4553
5420
|
readonly onClick?: (e: MouseEvent_2<HTMLElement>) => void;
|
|
5421
|
+
/**
|
|
5422
|
+
* Content of the drop-down menu, typically MenuItem components.
|
|
5423
|
+
*/
|
|
4554
5424
|
readonly children: React.ReactNode;
|
|
5425
|
+
/**
|
|
5426
|
+
* Tooltip of the whole control.
|
|
5427
|
+
*/
|
|
4555
5428
|
readonly title?: string;
|
|
5429
|
+
/**
|
|
5430
|
+
* Disables the whole control (ALL) or only the main half while the drop-down stays operable (PARTIAL).
|
|
5431
|
+
*/
|
|
4556
5432
|
readonly disabledState?: SplitButtonDisabledState;
|
|
4557
5433
|
}
|
|
4558
5434
|
|
|
4559
5435
|
export declare const Stack: React_2.ForwardRefExoticComponent<StackProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4560
5436
|
|
|
4561
5437
|
export declare interface StackProps extends LayoutComponentProps {
|
|
5438
|
+
/**
|
|
5439
|
+
* Cross-axis alignment of the children. Start and undefined both render as stretch.
|
|
5440
|
+
*/
|
|
4562
5441
|
readonly align?: LayoutAlignment;
|
|
5442
|
+
/**
|
|
5443
|
+
* Vertical gap between children. Defaults to none.
|
|
5444
|
+
*/
|
|
4563
5445
|
readonly spacing?: Spacing;
|
|
5446
|
+
/**
|
|
5447
|
+
* Stretches the stack to the full height of the parent.
|
|
5448
|
+
*/
|
|
4564
5449
|
readonly fullHeight?: boolean;
|
|
4565
5450
|
}
|
|
4566
5451
|
|
|
@@ -4628,6 +5513,9 @@ export declare interface StringTableCellComponentProps {
|
|
|
4628
5513
|
export declare const SubheaderDivider: React_2.ForwardRefExoticComponent<SubheaderDividerProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4629
5514
|
|
|
4630
5515
|
export declare interface SubheaderDividerProps {
|
|
5516
|
+
/**
|
|
5517
|
+
* Label shown before the rule.
|
|
5518
|
+
*/
|
|
4631
5519
|
readonly text: string;
|
|
4632
5520
|
}
|
|
4633
5521
|
|
|
@@ -4636,9 +5524,6 @@ export declare interface SubheaderDividerProps {
|
|
|
4636
5524
|
*/
|
|
4637
5525
|
export declare const Switch: React_2.ForwardRefExoticComponent<SwitchProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
4638
5526
|
|
|
4639
|
-
/**
|
|
4640
|
-
* Switch on/off state indicator
|
|
4641
|
-
*/
|
|
4642
5527
|
export declare interface SwitchProps extends UITestProps {
|
|
4643
5528
|
/**
|
|
4644
5529
|
* Switch on/off state (required).
|
|
@@ -4657,7 +5542,7 @@ export declare interface SwitchProps extends UITestProps {
|
|
|
4657
5542
|
*/
|
|
4658
5543
|
readonly disabled?: boolean;
|
|
4659
5544
|
/**
|
|
4660
|
-
*
|
|
5545
|
+
* Not currently wired to the rendered markup. The switch generates its own internal id.
|
|
4661
5546
|
*/
|
|
4662
5547
|
readonly switchId?: string;
|
|
4663
5548
|
/**
|
|
@@ -4682,6 +5567,9 @@ export declare enum SwitchSize {
|
|
|
4682
5567
|
L = "L"
|
|
4683
5568
|
}
|
|
4684
5569
|
|
|
5570
|
+
/**
|
|
5571
|
+
* Built-in theme names.
|
|
5572
|
+
*/
|
|
4685
5573
|
export declare enum SystemTheme {
|
|
4686
5574
|
Light = "light",
|
|
4687
5575
|
Dark = "dark"
|
|
@@ -4745,7 +5633,7 @@ export declare interface TableColumn {
|
|
|
4745
5633
|
*/
|
|
4746
5634
|
visible: boolean;
|
|
4747
5635
|
/**
|
|
4748
|
-
*
|
|
5636
|
+
* Minimum width of the column.
|
|
4749
5637
|
*/
|
|
4750
5638
|
minWidth: number;
|
|
4751
5639
|
/**
|
|
@@ -4753,11 +5641,11 @@ export declare interface TableColumn {
|
|
|
4753
5641
|
*/
|
|
4754
5642
|
maxWidth: number;
|
|
4755
5643
|
/**
|
|
4756
|
-
* Content type of the
|
|
5644
|
+
* Content type of the column.
|
|
4757
5645
|
*/
|
|
4758
5646
|
contentType: ColumnContentType;
|
|
4759
5647
|
/**
|
|
4760
|
-
* Indicates if the
|
|
5648
|
+
* Indicates if the column is sortable.
|
|
4761
5649
|
*/
|
|
4762
5650
|
sortable: boolean;
|
|
4763
5651
|
/**
|
|
@@ -4859,8 +5747,7 @@ export declare interface TableProps extends UITestProps {
|
|
|
4859
5747
|
readonly onRowClick?: (identifier: unknown) => void;
|
|
4860
5748
|
/**
|
|
4861
5749
|
* Handler that fires when the table view changes.
|
|
4862
|
-
* @param
|
|
4863
|
-
* @param y vertical scroll position
|
|
5750
|
+
* @param viewChangeEvent Scroll position and dimensions of the table viewport and content.
|
|
4864
5751
|
*/
|
|
4865
5752
|
readonly onViewChange?: (viewChangeEvent: ViewChangeEvent) => void;
|
|
4866
5753
|
/**
|
|
@@ -4892,7 +5779,7 @@ export declare interface TableRow {
|
|
|
4892
5779
|
*/
|
|
4893
5780
|
isInvalid?: boolean;
|
|
4894
5781
|
/**
|
|
4895
|
-
* The message to show when
|
|
5782
|
+
* The message to show when the row is inactive.
|
|
4896
5783
|
*/
|
|
4897
5784
|
inactiveMessage?: string;
|
|
4898
5785
|
/**
|
|
@@ -4999,6 +5886,9 @@ export declare interface TableRowProps extends UITestProps {
|
|
|
4999
5886
|
export declare const Tag: React_2.ForwardRefExoticComponent<TagProps & React_2.RefAttributes<HTMLDivElement>>;
|
|
5000
5887
|
|
|
5001
5888
|
export declare type TagBackgroundType = {
|
|
5889
|
+
/**
|
|
5890
|
+
* Color token of the tag background.
|
|
5891
|
+
*/
|
|
5002
5892
|
readonly color: Colors;
|
|
5003
5893
|
};
|
|
5004
5894
|
|
|
@@ -5008,22 +5898,73 @@ declare enum TagMode {
|
|
|
5008
5898
|
}
|
|
5009
5899
|
|
|
5010
5900
|
export declare interface TagProps {
|
|
5901
|
+
/**
|
|
5902
|
+
* Text of the tag. Shown as the tooltip when it overflows and no tooltipText is provided.
|
|
5903
|
+
*/
|
|
5011
5904
|
readonly label: string;
|
|
5905
|
+
/**
|
|
5906
|
+
* Tooltip of the tag. Takes precedence over the overflowing label.
|
|
5907
|
+
*/
|
|
5012
5908
|
readonly tooltipText?: string;
|
|
5909
|
+
/**
|
|
5910
|
+
* Dangerously sets the tooltip text as inner HTML.
|
|
5911
|
+
*/
|
|
5013
5912
|
readonly tooltipTextAsHtml?: boolean;
|
|
5913
|
+
/**
|
|
5914
|
+
* When provided, the tag body renders as a button and invokes the handler on click.
|
|
5915
|
+
*/
|
|
5014
5916
|
readonly onClick?: () => void;
|
|
5917
|
+
/**
|
|
5918
|
+
* Handler of the trailing remove button. Its presence renders the button.
|
|
5919
|
+
*/
|
|
5015
5920
|
readonly onRemoveClick?: () => void;
|
|
5921
|
+
/**
|
|
5922
|
+
* Mouse down handler of the remove button.
|
|
5923
|
+
*/
|
|
5016
5924
|
readonly onRemoveMouseDown?: () => void;
|
|
5925
|
+
/**
|
|
5926
|
+
* Disables the tag interactions and drops the custom background color.
|
|
5927
|
+
*/
|
|
5017
5928
|
readonly disabled?: boolean;
|
|
5929
|
+
/**
|
|
5930
|
+
* Suppresses all interactive parts while keeping the visual tag.
|
|
5931
|
+
*/
|
|
5018
5932
|
readonly readOnly?: boolean;
|
|
5933
|
+
/**
|
|
5934
|
+
* Forces the remove button to render even without onRemoveClick.
|
|
5935
|
+
*/
|
|
5019
5936
|
readonly removable?: boolean;
|
|
5937
|
+
/**
|
|
5938
|
+
* Background of the tag. Defaults to the default tag background token.
|
|
5939
|
+
*/
|
|
5020
5940
|
readonly background?: TagBackgroundType;
|
|
5941
|
+
/**
|
|
5942
|
+
* Stretches the tag to the container width.
|
|
5943
|
+
*/
|
|
5021
5944
|
readonly fullWidth?: boolean;
|
|
5945
|
+
/**
|
|
5946
|
+
* Applies the dragged styling, used by TagDraggable.
|
|
5947
|
+
*/
|
|
5022
5948
|
readonly isDragging?: boolean;
|
|
5949
|
+
/**
|
|
5950
|
+
* Button rendered before the label.
|
|
5951
|
+
*/
|
|
5023
5952
|
readonly leadingButton?: React_2.ReactElement<HTMLButtonElement>;
|
|
5953
|
+
/**
|
|
5954
|
+
* Brightness of the background. Selects the opposite text brightness.
|
|
5955
|
+
*/
|
|
5024
5956
|
readonly mode?: TagMode;
|
|
5957
|
+
/**
|
|
5958
|
+
* Test id data attribute of the non-clickable tag.
|
|
5959
|
+
*/
|
|
5025
5960
|
readonly dataTestId?: TestId;
|
|
5961
|
+
/**
|
|
5962
|
+
* Test id data attribute of the clickable tag body.
|
|
5963
|
+
*/
|
|
5026
5964
|
readonly dataTestIdTagButton?: TestId;
|
|
5965
|
+
/**
|
|
5966
|
+
* Test id data attribute of the remove button.
|
|
5967
|
+
*/
|
|
5027
5968
|
readonly dataTestIdRemoveButton?: TestId;
|
|
5028
5969
|
}
|
|
5029
5970
|
|
|
@@ -5057,6 +5998,7 @@ declare const testIds: {
|
|
|
5057
5998
|
PageMenu: "page-menu-actions";
|
|
5058
5999
|
};
|
|
5059
6000
|
ActionTiles: {
|
|
6001
|
+
TemplateTilePrefix: "template-tile-";
|
|
5060
6002
|
Default: "action-tile";
|
|
5061
6003
|
Item: "item-tile";
|
|
5062
6004
|
};
|
|
@@ -5098,6 +6040,7 @@ declare const testIds: {
|
|
|
5098
6040
|
ContentItemActionCancelScheduledPublish: "content-item-action-menu-item-cancelscheduledpublish";
|
|
5099
6041
|
ContentItemActionCancelScheduledUnpublish: "content-item-action-menu-item-cancelscheduledunpublish";
|
|
5100
6042
|
ContentItemActionConfirmFirstSelection: "content-item-action-button-confirmfirstselection";
|
|
6043
|
+
ContentItemActionConfirmSecondSelection: "content-item-action-button-confirmsecondselection";
|
|
5101
6044
|
ContentItemActionConfirmSelection: "content-item-action-button-confirmselection";
|
|
5102
6045
|
ContentItemActionContinue: "content-item-action-button-continue";
|
|
5103
6046
|
ContentItemActionCreate: "content-item-action-button-create";
|
|
@@ -5111,6 +6054,7 @@ declare const testIds: {
|
|
|
5111
6054
|
ContentItemActionPublish: "content-item-action-button-publish";
|
|
5112
6055
|
ContentItemActionRevertToPublished: "content-item-action-menu-item-discard";
|
|
5113
6056
|
ContentItemActionSave: "content-item-action-button-save";
|
|
6057
|
+
ContentItemActionSaveAndCreateAnother: "content-item-action-button-saveandcreateanother";
|
|
5114
6058
|
ContentItemEditScheduledPage: "content-item-menu-split-button-cancelscheduledpublishandedit";
|
|
5115
6059
|
ContentItemMenuSplitContinue: "content-item-menu-split-button-continue";
|
|
5116
6060
|
ContentItemMenuSplitCreateNewVersion: "content-item-menu-split-button-createnewversion";
|
|
@@ -5122,6 +6066,7 @@ declare const testIds: {
|
|
|
5122
6066
|
Create_V1: "button-create";
|
|
5123
6067
|
Create_V2: "Create";
|
|
5124
6068
|
CreateFolder_V2: "createfolder-action";
|
|
6069
|
+
CreateInTree: "create-action";
|
|
5125
6070
|
CreateNewStage: "create-new-stage-button";
|
|
5126
6071
|
DeleteContentItem: "button-Move to recycle bin";
|
|
5127
6072
|
DeleteFolder: "deletefolder-action";
|
|
@@ -5206,6 +6151,7 @@ declare const testIds: {
|
|
|
5206
6151
|
Expand: "expand-button";
|
|
5207
6152
|
ExpandRedirectCategory: "form-category-button-Redirect";
|
|
5208
6153
|
ExpandSplit: "expand-split-button";
|
|
6154
|
+
Export: "export-button";
|
|
5209
6155
|
Filter: "filter-button";
|
|
5210
6156
|
ForgottenPassword: "forgottenPassword";
|
|
5211
6157
|
GenerateCampaignReport: "generate-campaign-report-button";
|
|
@@ -5274,6 +6220,7 @@ declare const testIds: {
|
|
|
5274
6220
|
Funnel: "funnel-chart";
|
|
5275
6221
|
};
|
|
5276
6222
|
Checkboxes: {
|
|
6223
|
+
LanguageIsDefault: "ContentLanguageIsDefaultCheckbox";
|
|
5277
6224
|
ActivityTypeEnabled: "ActivityTypeEnabled";
|
|
5278
6225
|
ApplyForSubItemsCheckbox: "ApplyForSubItemsCheckbox";
|
|
5279
6226
|
ContactGroupScheduledRecalculation: "ContactGroupIsAutomaticallyRebuiltCheckbox";
|
|
@@ -5315,9 +6262,11 @@ declare const testIds: {
|
|
|
5315
6262
|
AutomationProcessList: "automation-process-list-form-dialog";
|
|
5316
6263
|
CloneSmartFolder: "clone-smart-folder-dialog";
|
|
5317
6264
|
ContentItemDelete: "content-item-delete-dialog";
|
|
6265
|
+
CreateAnotherPage: "create-another-page-dialog";
|
|
5318
6266
|
CreateFolder: "create-folder-dialog";
|
|
5319
6267
|
Delete: "delete-dialog";
|
|
5320
6268
|
EditPageName: "edit-page-name-dialog";
|
|
6269
|
+
ExportListing: "export-listing-dialog";
|
|
5321
6270
|
FoldersForm: "folders-form-dialog";
|
|
5322
6271
|
IconSelector: "icon-selector-dialog";
|
|
5323
6272
|
InsertDynamicText: "insert-dynamic-text-dialog";
|
|
@@ -5377,6 +6326,7 @@ declare const testIds: {
|
|
|
5377
6326
|
XpArrowSend: "xp-arrow-send";
|
|
5378
6327
|
XpChevronDown: "xp-chevron-down";
|
|
5379
6328
|
XpChevronUp: "xp-chevron-up";
|
|
6329
|
+
XpFlagFrance: "xp-flag-france";
|
|
5380
6330
|
XpMagicEdit: "xp-magic-edit";
|
|
5381
6331
|
XpPicture: "xp-picture";
|
|
5382
6332
|
XpTimesCircle: "xp-times-circle";
|
|
@@ -5414,6 +6364,7 @@ declare const testIds: {
|
|
|
5414
6364
|
ContactGroupDisplayName: "ContactGroupDisplayName";
|
|
5415
6365
|
Content: "Content";
|
|
5416
6366
|
ContentTypeName: "ClassDisplayName";
|
|
6367
|
+
CurrentPassword: "CurrentPassword";
|
|
5417
6368
|
CustomDescription: "CustomDescription";
|
|
5418
6369
|
CustomInstructions: "CustomInstructions";
|
|
5419
6370
|
DateFrom: "EventTime-date-from";
|
|
@@ -5454,6 +6405,7 @@ declare const testIds: {
|
|
|
5454
6405
|
MemberRoleDisplayName: "MemberRoleDisplayName";
|
|
5455
6406
|
ModuleDisplayName: "ResourceDisplayName";
|
|
5456
6407
|
Name: "Name";
|
|
6408
|
+
NewPassword: "NewPassword";
|
|
5457
6409
|
NotificationDisplayName: "NotificationEmailDisplayName";
|
|
5458
6410
|
NotificationEmailContent: "NotificationEmailContent";
|
|
5459
6411
|
NotificationEmailSenderEmailAddress: "NotificationEmailSenderEmailAddress";
|
|
@@ -5462,7 +6414,9 @@ declare const testIds: {
|
|
|
5462
6414
|
NotificationEmailTemplateSourceCode: "NotificationEmailTemplateCode";
|
|
5463
6415
|
ObjectType: "ObjectType";
|
|
5464
6416
|
OrderStatusDisplayName: "OrderStatusDisplayName";
|
|
6417
|
+
PageName: "PageName";
|
|
5465
6418
|
PagesInFolderCount: "PagesInFolderCount";
|
|
6419
|
+
PageTemplate: "PageTemplate";
|
|
5466
6420
|
Password: "password";
|
|
5467
6421
|
PaymentMethodDescription: "PaymentMethodDescription";
|
|
5468
6422
|
PaymentMethodDisplayName: "PaymentMethodDisplayName";
|
|
@@ -5495,6 +6449,8 @@ declare const testIds: {
|
|
|
5495
6449
|
TrackedWebsiteDescription: "TrackedWebsiteDescription";
|
|
5496
6450
|
TrackedWebsiteDisplayName: "TrackedWebsiteDisplayName";
|
|
5497
6451
|
TrackedWebsiteURL: "TrackedWebsiteURL";
|
|
6452
|
+
WebPageCodeName: "CodeName";
|
|
6453
|
+
WebPageTreePathSlug: "TreePathSlug";
|
|
5498
6454
|
WebsiteChannelDomain: "WebsiteChannelDomain";
|
|
5499
6455
|
WebsiteChannelId: "WebsiteChannelId";
|
|
5500
6456
|
WebUrls: "WebUrls";
|
|
@@ -5517,6 +6473,7 @@ declare const testIds: {
|
|
|
5517
6473
|
ErrorMessage: "ErrorMessage";
|
|
5518
6474
|
FieldName: "field-name";
|
|
5519
6475
|
FolderDisplayName: "FolderDisplayName";
|
|
6476
|
+
IconSelectorSearch: "icon-selector-search-input";
|
|
5520
6477
|
Label: "Label";
|
|
5521
6478
|
LinkText: "LinkText";
|
|
5522
6479
|
MaximumLength: "MaximumLength";
|
|
@@ -5546,6 +6503,7 @@ declare const testIds: {
|
|
|
5546
6503
|
ContactGroupRecipientListThankYouPage: "ContactGroupRecipientListThankYouPage";
|
|
5547
6504
|
EditableAreaGeneral: "editable-area-general";
|
|
5548
6505
|
GeneralSettings: "General settings";
|
|
6506
|
+
LanguageIdentifiersWrapper: "ContentLanguageNameWrapper";
|
|
5549
6507
|
TableCellActivityEnabled: "table-cell-ActivityTypeEnabled";
|
|
5550
6508
|
TableCellActivityTypeIsCustom: "table-cell-ActivityTypeIsCustom";
|
|
5551
6509
|
TableCellAutomation: "table-cell-Automation";
|
|
@@ -5555,6 +6513,7 @@ declare const testIds: {
|
|
|
5555
6513
|
TableCellConverted: "table-cell-Converted";
|
|
5556
6514
|
TableCellDroppedOff: "table-cell-Dropped off";
|
|
5557
6515
|
TableCellFirstName: "table-cell-FirstName";
|
|
6516
|
+
TableCellLanguageDisplayName: "table-cell-ContentLanguageDisplayName";
|
|
5558
6517
|
TableCellLastName: "table-cell-LastName";
|
|
5559
6518
|
TableCellTextInput: "table-cell-TextInput";
|
|
5560
6519
|
AdditionalActions: "additional-actions";
|
|
@@ -5582,6 +6541,7 @@ declare const testIds: {
|
|
|
5582
6541
|
MassAssetUploadGrid: "mass-asset-upload-grid";
|
|
5583
6542
|
NotificationEmailPreview: "notification-email-preview";
|
|
5584
6543
|
NotificationEmailSubject: "notification-email-subject";
|
|
6544
|
+
PermissionMatrixRow: "permission-matrix-row";
|
|
5585
6545
|
PropertiesPage: "properties-page";
|
|
5586
6546
|
SelectedEmails: "selected-emails";
|
|
5587
6547
|
SidePanelFooter: "side-panel-footer";
|
|
@@ -5644,10 +6604,13 @@ declare const testIds: {
|
|
|
5644
6604
|
ContentLanguage: "content-language";
|
|
5645
6605
|
ContentType: "content-type";
|
|
5646
6606
|
ContentTypeForMassUploadedItems: "content-type-for-mass-uploaded-items";
|
|
6607
|
+
DropdownSelector: "dropdown-selector";
|
|
5647
6608
|
EmailSender: "sender";
|
|
5648
6609
|
EmailSendTo: "send-to";
|
|
5649
6610
|
EmailTemplateProperties: "email-template";
|
|
6611
|
+
FallbackLanguage: "fallback-language";
|
|
5650
6612
|
FileInputUploadMassAsset: "file-input-upload-mass-asset";
|
|
6613
|
+
LanguageFlagIcon: "ContentLanguageFlagIconName";
|
|
5651
6614
|
OrderStatusCustomerNotificationEmailConfiguration: "OrderStatusCustomerNotificationEmailConfiguration";
|
|
5652
6615
|
PreferredLanguage: "UserPreferredLanguage";
|
|
5653
6616
|
PrimaryLanguage: "primary-language";
|
|
@@ -5871,7 +6834,7 @@ export declare interface TextAreaProps extends Pick<React_2.TextareaHTMLAttribut
|
|
|
5871
6834
|
*/
|
|
5872
6835
|
readonly explanationTextAsHtml?: boolean;
|
|
5873
6836
|
/**
|
|
5874
|
-
* Dangerously tooltip as inner HTML.
|
|
6837
|
+
* Dangerously sets tooltip as inner HTML.
|
|
5875
6838
|
*/
|
|
5876
6839
|
readonly tooltipAsHtml?: boolean;
|
|
5877
6840
|
/**
|
|
@@ -5900,14 +6863,32 @@ export declare interface TextWithLabelProps extends UITestProps {
|
|
|
5900
6863
|
export declare const ThemeContext: React_2.Context<ThemeContextType>;
|
|
5901
6864
|
|
|
5902
6865
|
declare interface ThemeContextType {
|
|
6866
|
+
/**
|
|
6867
|
+
* Name of the active theme.
|
|
6868
|
+
*/
|
|
5903
6869
|
readonly theme: string;
|
|
6870
|
+
/**
|
|
6871
|
+
* Activates the theme with the given name.
|
|
6872
|
+
*/
|
|
5904
6873
|
readonly setTheme: (theme: string) => void;
|
|
6874
|
+
/**
|
|
6875
|
+
* Registers additional themes at runtime.
|
|
6876
|
+
*/
|
|
5905
6877
|
readonly injectTheme: (themes: ThemesObjectType) => void;
|
|
5906
6878
|
}
|
|
5907
6879
|
|
|
5908
6880
|
export declare interface ThemeProps {
|
|
6881
|
+
/**
|
|
6882
|
+
* Subtree the theme applies to.
|
|
6883
|
+
*/
|
|
5909
6884
|
readonly children: React.ReactNode;
|
|
6885
|
+
/**
|
|
6886
|
+
* Custom themes to register, where the key is the theme name and the value is the css module class.
|
|
6887
|
+
*/
|
|
5910
6888
|
readonly customThemes?: ThemesObjectType;
|
|
6889
|
+
/**
|
|
6890
|
+
* Name of the initially active theme. Defaults to the light system theme.
|
|
6891
|
+
*/
|
|
5911
6892
|
readonly defaultTheme?: string;
|
|
5912
6893
|
}
|
|
5913
6894
|
|
|
@@ -5916,6 +6897,9 @@ export declare const ThemeProvider: {
|
|
|
5916
6897
|
displayName: string;
|
|
5917
6898
|
};
|
|
5918
6899
|
|
|
6900
|
+
/**
|
|
6901
|
+
* Map of theme names to css module classes.
|
|
6902
|
+
*/
|
|
5919
6903
|
declare interface ThemesObjectType {
|
|
5920
6904
|
[key: string]: string;
|
|
5921
6905
|
}
|
|
@@ -5976,13 +6960,28 @@ declare enum ToggleButtonBaseTypes {
|
|
|
5976
6960
|
}
|
|
5977
6961
|
|
|
5978
6962
|
declare interface ToggleButtonsItem {
|
|
6963
|
+
/**
|
|
6964
|
+
* Identity of the item used for the selection and the change callback.
|
|
6965
|
+
*/
|
|
5979
6966
|
readonly id: ItemId;
|
|
5980
6967
|
}
|
|
5981
6968
|
|
|
5982
6969
|
declare interface ToggleButtonsProps<ItemsType> {
|
|
6970
|
+
/**
|
|
6971
|
+
* Identifier of the highlighted item. The component is fully controlled.
|
|
6972
|
+
*/
|
|
5983
6973
|
readonly selectedItemId: ItemId;
|
|
6974
|
+
/**
|
|
6975
|
+
* Buttons of the group, rendered in order.
|
|
6976
|
+
*/
|
|
5984
6977
|
readonly items: ItemsType[];
|
|
6978
|
+
/**
|
|
6979
|
+
* Handler called with the identifier of the clicked item.
|
|
6980
|
+
*/
|
|
5985
6981
|
readonly onChange: (id: ItemId) => void;
|
|
6982
|
+
/**
|
|
6983
|
+
* Not currently wired to any styling or behavior.
|
|
6984
|
+
*/
|
|
5986
6985
|
readonly orientation?: 'vertical' | 'horizontal';
|
|
5987
6986
|
}
|
|
5988
6987
|
|
|
@@ -6011,14 +7010,41 @@ export declare enum TooltipPlacement {
|
|
|
6011
7010
|
}
|
|
6012
7011
|
|
|
6013
7012
|
export declare interface TooltipProps {
|
|
7013
|
+
/**
|
|
7014
|
+
* The single trigger element the tooltip attaches to.
|
|
7015
|
+
*/
|
|
6014
7016
|
readonly children: React_2.ReactElement<HTMLElement>;
|
|
7017
|
+
/**
|
|
7018
|
+
* Tooltip body text. Without tooltipText and shortcuts the tooltip is disabled.
|
|
7019
|
+
*/
|
|
6015
7020
|
readonly tooltipText?: string;
|
|
7021
|
+
/**
|
|
7022
|
+
* Placement relative to the trigger. Defaults to Top.
|
|
7023
|
+
*/
|
|
6016
7024
|
readonly placement?: TooltipPlacement;
|
|
7025
|
+
/**
|
|
7026
|
+
* Keyboard shortcut badge appended to the tooltip text.
|
|
7027
|
+
*/
|
|
6017
7028
|
readonly shortcuts?: string;
|
|
7029
|
+
/**
|
|
7030
|
+
* Maximum content width in grid units (8px each). Defaults to 50.
|
|
7031
|
+
*/
|
|
6018
7032
|
readonly maxGridUnitWidth?: number;
|
|
7033
|
+
/**
|
|
7034
|
+
* Skips the 300 ms show delay.
|
|
7035
|
+
*/
|
|
6019
7036
|
readonly withoutShowDelay?: boolean;
|
|
7037
|
+
/**
|
|
7038
|
+
* Controls the visibility instead of hover when set.
|
|
7039
|
+
*/
|
|
6020
7040
|
readonly visible?: boolean;
|
|
7041
|
+
/**
|
|
7042
|
+
* Disables the tooltip.
|
|
7043
|
+
*/
|
|
6021
7044
|
readonly disabled?: boolean;
|
|
7045
|
+
/**
|
|
7046
|
+
* Element the tooltip portal mounts into. Defaults to the shared tooltip container.
|
|
7047
|
+
*/
|
|
6022
7048
|
readonly appendTo?: Element;
|
|
6023
7049
|
/**
|
|
6024
7050
|
* Dangerously sets tooltip text as inner HTML.
|
|
@@ -6046,6 +7072,10 @@ export declare interface TreeNodeAction {
|
|
|
6046
7072
|
* Indicates if the action is disabled. Defaults to `false`.
|
|
6047
7073
|
*/
|
|
6048
7074
|
readonly disabled?: boolean;
|
|
7075
|
+
/**
|
|
7076
|
+
* Executes the action.
|
|
7077
|
+
* @deprecated Use TreeNodeMenu actionExecutor property instead.
|
|
7078
|
+
*/
|
|
6049
7079
|
readonly actionExecutor?: (action: string) => void;
|
|
6050
7080
|
/**
|
|
6051
7081
|
* Actions tooltip.
|
|
@@ -6370,7 +7400,7 @@ export declare interface UploadTileProps {
|
|
|
6370
7400
|
*/
|
|
6371
7401
|
readonly size: UploadTileSize;
|
|
6372
7402
|
/**
|
|
6373
|
-
* File types
|
|
7403
|
+
* File types accepted by the browse dialog. Does not restrict drag and drop.
|
|
6374
7404
|
*/
|
|
6375
7405
|
readonly acceptFiles?: string;
|
|
6376
7406
|
}
|
|
@@ -6469,9 +7499,21 @@ export declare const useWindowDimensions: () => {
|
|
|
6469
7499
|
};
|
|
6470
7500
|
|
|
6471
7501
|
declare interface VerticalMenuProps {
|
|
7502
|
+
/**
|
|
7503
|
+
* Render callback of an item pinned below the scrolling item list, separated by a divider.
|
|
7504
|
+
*/
|
|
6472
7505
|
readonly pinnedItem?: () => React.ReactNode;
|
|
7506
|
+
/**
|
|
7507
|
+
* Styling variant of the menu. Fixed by the ActionMenu and SelectMenu wrappers.
|
|
7508
|
+
*/
|
|
6473
7509
|
readonly menuType?: VerticalMenuType;
|
|
7510
|
+
/**
|
|
7511
|
+
* Items of the menu, typically MenuItem components with dividers and headlines.
|
|
7512
|
+
*/
|
|
6474
7513
|
readonly children: React.ReactNode;
|
|
7514
|
+
/**
|
|
7515
|
+
* Maximum height of the item list. Content beyond it scrolls while the pinned item stays visible.
|
|
7516
|
+
*/
|
|
6475
7517
|
readonly maxContentHeight?: string;
|
|
6476
7518
|
}
|
|
6477
7519
|
|
|
@@ -6614,20 +7656,20 @@ declare interface WindowProps extends UITestProps {
|
|
|
6614
7656
|
*/
|
|
6615
7657
|
readonly children: ReactNode;
|
|
6616
7658
|
/**
|
|
6617
|
-
* Called when user
|
|
7659
|
+
* Called when the user requests to close the window
|
|
6618
7660
|
*/
|
|
6619
7661
|
readonly onClose?: () => void;
|
|
6620
7662
|
/**
|
|
6621
7663
|
* Called when window stage changes, usually after some user interaction
|
|
6622
|
-
* @param
|
|
7664
|
+
* @param stage Current window stage
|
|
6623
7665
|
*/
|
|
6624
|
-
readonly onStageChange?: (
|
|
7666
|
+
readonly onStageChange?: (stage: WindowStage) => void;
|
|
6625
7667
|
/**
|
|
6626
|
-
* Can the window
|
|
7668
|
+
* Can the window be resized with the mouse
|
|
6627
7669
|
*/
|
|
6628
7670
|
readonly resizable?: boolean;
|
|
6629
7671
|
/**
|
|
6630
|
-
* Can the window
|
|
7672
|
+
* Can the window be dragged with the mouse
|
|
6631
7673
|
*/
|
|
6632
7674
|
readonly draggable?: boolean;
|
|
6633
7675
|
/**
|
|
@@ -6657,7 +7699,7 @@ declare interface WindowProps extends UITestProps {
|
|
|
6657
7699
|
*/
|
|
6658
7700
|
readonly closeOnEsc?: boolean;
|
|
6659
7701
|
/**
|
|
6660
|
-
*
|
|
7702
|
+
* Tooltips of the window header buttons
|
|
6661
7703
|
*/
|
|
6662
7704
|
readonly tooltips?: {
|
|
6663
7705
|
close: string;
|