@dxc-technology/halstack-react 0.0.0-646cad5 → 0.0.0-648c007
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/index.d.mts +519 -671
- package/dist/index.d.ts +519 -671
- package/dist/index.js +5084 -5953
- package/dist/index.mjs +4902 -5771
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -111,10 +111,10 @@ type NonIndependentProps = CommonProps$9 & {
|
|
|
111
111
|
*/
|
|
112
112
|
onActiveChange?: (index: number[]) => void;
|
|
113
113
|
};
|
|
114
|
-
type Props$
|
|
114
|
+
type Props$I = IndependentProps | NonIndependentProps;
|
|
115
115
|
|
|
116
116
|
declare const DxcAccordion: {
|
|
117
|
-
(props: Props$
|
|
117
|
+
(props: Props$I): JSX.Element;
|
|
118
118
|
AccordionItem: ({ label, subLabel, badge, statusLight, icon, assistiveText, disabled, children, tabIndex, }: AccordionItemProps) => JSX.Element;
|
|
119
119
|
};
|
|
120
120
|
|
|
@@ -197,9 +197,9 @@ type ModeSpecificProps = {
|
|
|
197
197
|
*/
|
|
198
198
|
mode: "modal";
|
|
199
199
|
};
|
|
200
|
-
type Props$
|
|
200
|
+
type Props$H = CommonProps$8 & ModeSpecificProps;
|
|
201
201
|
|
|
202
|
-
declare function DxcAlert({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$
|
|
202
|
+
declare function DxcAlert({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$H): react_jsx_runtime.JSX.Element;
|
|
203
203
|
|
|
204
204
|
type SidenavTitlePropsType = {
|
|
205
205
|
/**
|
|
@@ -264,7 +264,7 @@ type SidenavLinkPropsType = {
|
|
|
264
264
|
*/
|
|
265
265
|
tabIndex?: number;
|
|
266
266
|
};
|
|
267
|
-
type Props$
|
|
267
|
+
type Props$G = {
|
|
268
268
|
/**
|
|
269
269
|
* The area assigned to render the sidenav title. It is highly recommended to use the sidenav title.
|
|
270
270
|
*/
|
|
@@ -276,7 +276,7 @@ type Props$H = {
|
|
|
276
276
|
};
|
|
277
277
|
|
|
278
278
|
type Size$4 = "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
279
|
-
type Option$
|
|
279
|
+
type Option$2 = {
|
|
280
280
|
/**
|
|
281
281
|
* Option display value.
|
|
282
282
|
*/
|
|
@@ -290,11 +290,11 @@ type Option$1 = {
|
|
|
290
290
|
*/
|
|
291
291
|
value: string;
|
|
292
292
|
};
|
|
293
|
-
type Props$
|
|
293
|
+
type Props$F = {
|
|
294
294
|
/**
|
|
295
295
|
* An array of objects representing the options.
|
|
296
296
|
*/
|
|
297
|
-
options: Option$
|
|
297
|
+
options: Option$2[];
|
|
298
298
|
/**
|
|
299
299
|
* In case options include icons, whether the icon should appear
|
|
300
300
|
* after or before the label.
|
|
@@ -350,7 +350,21 @@ type Props$G = {
|
|
|
350
350
|
title?: string;
|
|
351
351
|
};
|
|
352
352
|
|
|
353
|
-
type
|
|
353
|
+
type Logo = {
|
|
354
|
+
/**
|
|
355
|
+
* URL to navigate when the logo is clicked.
|
|
356
|
+
*/
|
|
357
|
+
href?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Source of the logo image.
|
|
360
|
+
*/
|
|
361
|
+
src: string;
|
|
362
|
+
/**
|
|
363
|
+
* Alternative text for the logo image.
|
|
364
|
+
*/
|
|
365
|
+
title?: string;
|
|
366
|
+
};
|
|
367
|
+
type Props$E = {
|
|
354
368
|
/**
|
|
355
369
|
* Whether a contrast line should appear at the bottom of the header.
|
|
356
370
|
*/
|
|
@@ -367,13 +381,17 @@ type Props$F = {
|
|
|
367
381
|
*/
|
|
368
382
|
responsiveContent?: (closeHandler: () => void) => ReactNode;
|
|
369
383
|
/**
|
|
370
|
-
*
|
|
384
|
+
* Logo to be displayed inside the header
|
|
371
385
|
*/
|
|
372
|
-
|
|
386
|
+
logo?: Logo;
|
|
373
387
|
/**
|
|
374
388
|
* Size of the bottom margin to be applied to the header.
|
|
375
389
|
*/
|
|
376
390
|
margin?: Space$1;
|
|
391
|
+
/**
|
|
392
|
+
* This function will be called when the user clicks the header logo.
|
|
393
|
+
*/
|
|
394
|
+
onClick?: () => void;
|
|
377
395
|
/**
|
|
378
396
|
* Value of the tabindex for all interactive elements, except those inside the
|
|
379
397
|
* custom area.
|
|
@@ -476,12 +494,12 @@ declare const DxcApplicationLayout: {
|
|
|
476
494
|
({ visibilityToggleLabel, header, sidenav, footer, children, }: ApplicationLayoutPropsType): JSX.Element;
|
|
477
495
|
Footer: ({ socialLinks, bottomLinks, copyright, children, margin, tabIndex, mode, }: FooterPropsType) => JSX.Element;
|
|
478
496
|
Header: {
|
|
479
|
-
({ underlined, content, responsiveContent,
|
|
480
|
-
Dropdown: (props: react.ComponentProps<({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$
|
|
497
|
+
({ underlined, content, responsiveContent, logo, margin, onClick, tabIndex, }: Props$E): JSX.Element;
|
|
498
|
+
Dropdown: (props: react.ComponentProps<({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$F) => react_jsx_runtime.JSX.Element>) => react_jsx_runtime.JSX.Element;
|
|
481
499
|
};
|
|
482
500
|
Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
|
|
483
501
|
SideNav: {
|
|
484
|
-
({ title, children }: Props$
|
|
502
|
+
({ title, children }: Props$G): JSX.Element;
|
|
485
503
|
Section: ({ children }: SidenavSectionPropsType) => JSX.Element;
|
|
486
504
|
Group: ({ title, collapsable, icon, children }: SidenavGroupPropsType) => JSX.Element;
|
|
487
505
|
Link: react.ForwardRefExoticComponent<SidenavLinkPropsType & react.RefAttributes<HTMLAnchorElement>>;
|
|
@@ -540,144 +558,52 @@ type CommonProps$7 = {
|
|
|
540
558
|
*/
|
|
541
559
|
size?: "small" | "medium" | "large";
|
|
542
560
|
};
|
|
543
|
-
type Props$
|
|
561
|
+
type Props$D = (ContextualProps | NotificationProps) & CommonProps$7;
|
|
544
562
|
|
|
545
|
-
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$
|
|
546
|
-
|
|
547
|
-
/**
|
|
548
|
-
* Halstack Color Palette
|
|
549
|
-
* @link https://developer.dxc.com/halstack/next/principles/color/#color-tokens-core-color-tokens
|
|
550
|
-
*/
|
|
551
|
-
declare const CoreColorTokens: {
|
|
552
|
-
color_black: string;
|
|
553
|
-
color_white: string;
|
|
554
|
-
color_transparent: string;
|
|
555
|
-
color_grey_50: string;
|
|
556
|
-
color_grey_100: string;
|
|
557
|
-
color_grey_200: string;
|
|
558
|
-
color_grey_300: string;
|
|
559
|
-
color_grey_400: string;
|
|
560
|
-
color_grey_500: string;
|
|
561
|
-
color_grey_600: string;
|
|
562
|
-
color_grey_700: string;
|
|
563
|
-
color_grey_800: string;
|
|
564
|
-
color_grey_900: string;
|
|
565
|
-
color_grey_50_a: string;
|
|
566
|
-
color_grey_100_a: string;
|
|
567
|
-
color_grey_200_a: string;
|
|
568
|
-
color_grey_300_a: string;
|
|
569
|
-
color_grey_400_a: string;
|
|
570
|
-
color_grey_500_a: string;
|
|
571
|
-
color_grey_600_a: string;
|
|
572
|
-
color_grey_700_a: string;
|
|
573
|
-
color_grey_800_a: string;
|
|
574
|
-
color_grey_900_a: string;
|
|
575
|
-
color_purple_50: string;
|
|
576
|
-
color_purple_100: string;
|
|
577
|
-
color_purple_200: string;
|
|
578
|
-
color_purple_300: string;
|
|
579
|
-
color_purple_400: string;
|
|
580
|
-
color_purple_500: string;
|
|
581
|
-
color_purple_600: string;
|
|
582
|
-
color_purple_700: string;
|
|
583
|
-
color_purple_800: string;
|
|
584
|
-
color_purple_900: string;
|
|
585
|
-
color_blue_50: string;
|
|
586
|
-
color_blue_100: string;
|
|
587
|
-
color_blue_200: string;
|
|
588
|
-
color_blue_300: string;
|
|
589
|
-
color_blue_400: string;
|
|
590
|
-
color_blue_500: string;
|
|
591
|
-
color_blue_600: string;
|
|
592
|
-
color_blue_700: string;
|
|
593
|
-
color_blue_800: string;
|
|
594
|
-
color_blue_900: string;
|
|
595
|
-
color_red_50: string;
|
|
596
|
-
color_red_100: string;
|
|
597
|
-
color_red_200: string;
|
|
598
|
-
color_red_300: string;
|
|
599
|
-
color_red_400: string;
|
|
600
|
-
color_red_500: string;
|
|
601
|
-
color_red_600: string;
|
|
602
|
-
color_red_700: string;
|
|
603
|
-
color_red_800: string;
|
|
604
|
-
color_red_900: string;
|
|
605
|
-
color_green_50: string;
|
|
606
|
-
color_green_100: string;
|
|
607
|
-
color_green_200: string;
|
|
608
|
-
color_green_300: string;
|
|
609
|
-
color_green_400: string;
|
|
610
|
-
color_green_500: string;
|
|
611
|
-
color_green_600: string;
|
|
612
|
-
color_green_700: string;
|
|
613
|
-
color_green_800: string;
|
|
614
|
-
color_green_900: string;
|
|
615
|
-
color_yellow_50: string;
|
|
616
|
-
color_yellow_100: string;
|
|
617
|
-
color_yellow_200: string;
|
|
618
|
-
color_yellow_300: string;
|
|
619
|
-
color_yellow_400: string;
|
|
620
|
-
color_yellow_500: string;
|
|
621
|
-
color_yellow_600: string;
|
|
622
|
-
color_yellow_700: string;
|
|
623
|
-
color_yellow_800: string;
|
|
624
|
-
color_yellow_900: string;
|
|
625
|
-
color_orange_50: string;
|
|
626
|
-
color_orange_100: string;
|
|
627
|
-
color_orange_200: string;
|
|
628
|
-
color_orange_300: string;
|
|
629
|
-
color_orange_400: string;
|
|
630
|
-
color_orange_500: string;
|
|
631
|
-
color_orange_600: string;
|
|
632
|
-
color_orange_700: string;
|
|
633
|
-
color_orange_800: string;
|
|
634
|
-
color_orange_900: string;
|
|
635
|
-
};
|
|
636
|
-
type CoreColorTokensType = keyof typeof CoreColorTokens;
|
|
637
|
-
type CoreSpacingTokensType = "0rem" | "0.125rem" | "0.25rem" | "0.5rem" | "0.75rem" | "1rem" | "1.5rem" | "2rem" | "2.5rem" | "3rem" | "3.5rem" | "4rem" | "5rem" | "6rem" | "7rem";
|
|
563
|
+
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$D) => JSX.Element;
|
|
638
564
|
|
|
639
|
-
type Props$
|
|
565
|
+
type Props$C = {
|
|
640
566
|
/**
|
|
641
567
|
* Applies the spacing scale to all sides.
|
|
642
568
|
*/
|
|
643
|
-
space?:
|
|
569
|
+
space?: string;
|
|
644
570
|
/**
|
|
645
571
|
* Applies the spacing scale to the left and right sides.
|
|
646
572
|
*/
|
|
647
|
-
horizontal?:
|
|
573
|
+
horizontal?: string;
|
|
648
574
|
/**
|
|
649
575
|
* Applies the spacing scale to the top and bottom sides.
|
|
650
576
|
*/
|
|
651
|
-
vertical?:
|
|
577
|
+
vertical?: string;
|
|
652
578
|
/**
|
|
653
579
|
* Applies the spacing scale to the top side.
|
|
654
580
|
*/
|
|
655
|
-
top?:
|
|
581
|
+
top?: string;
|
|
656
582
|
/**
|
|
657
583
|
* Applies the spacing scale to the right side.
|
|
658
584
|
*/
|
|
659
|
-
right?:
|
|
585
|
+
right?: string;
|
|
660
586
|
/**
|
|
661
587
|
* Applies the spacing scale to the bottom side.
|
|
662
588
|
*/
|
|
663
|
-
bottom?:
|
|
589
|
+
bottom?: string;
|
|
664
590
|
/**
|
|
665
591
|
* Applies the spacing scale to the left side.
|
|
666
592
|
*/
|
|
667
|
-
left?:
|
|
593
|
+
left?: string;
|
|
668
594
|
/**
|
|
669
595
|
* Custom content inside the bleed.
|
|
670
596
|
*/
|
|
671
597
|
children: ReactNode;
|
|
672
598
|
};
|
|
673
599
|
|
|
674
|
-
declare
|
|
600
|
+
declare function DxcBleed({ space, horizontal, vertical, top, right, bottom, left, children }: Props$C): react_jsx_runtime.JSX.Element;
|
|
675
601
|
|
|
676
602
|
type Item$1 = {
|
|
677
603
|
href?: string;
|
|
678
604
|
label: string;
|
|
679
605
|
};
|
|
680
|
-
type Props$
|
|
606
|
+
type Props$B = {
|
|
681
607
|
/**
|
|
682
608
|
* Provides a label that describes the type of navigation enabled by
|
|
683
609
|
* the component.
|
|
@@ -709,7 +635,7 @@ type Props$C = {
|
|
|
709
635
|
showRoot?: boolean;
|
|
710
636
|
};
|
|
711
637
|
|
|
712
|
-
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$
|
|
638
|
+
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$B) => react_jsx_runtime.JSX.Element;
|
|
713
639
|
|
|
714
640
|
type IconProps = {
|
|
715
641
|
/**
|
|
@@ -739,7 +665,7 @@ type OtherProps = {
|
|
|
739
665
|
*/
|
|
740
666
|
children: ReactNode;
|
|
741
667
|
};
|
|
742
|
-
type Props$
|
|
668
|
+
type Props$A = IconProps | OtherProps;
|
|
743
669
|
|
|
744
670
|
type BulletedListItemPropsType = {
|
|
745
671
|
/**
|
|
@@ -749,7 +675,7 @@ type BulletedListItemPropsType = {
|
|
|
749
675
|
};
|
|
750
676
|
|
|
751
677
|
declare const DxcBulletedList: {
|
|
752
|
-
({ children, type, icon }: Props$
|
|
678
|
+
({ children, type, icon }: Props$A): JSX.Element;
|
|
753
679
|
Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
|
|
754
680
|
};
|
|
755
681
|
|
|
@@ -762,7 +688,7 @@ type Size$3 = {
|
|
|
762
688
|
height?: "small" | "medium" | "large";
|
|
763
689
|
width?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
764
690
|
};
|
|
765
|
-
type Props$
|
|
691
|
+
type Props$z = {
|
|
766
692
|
/**
|
|
767
693
|
* Text to be placed in the button.
|
|
768
694
|
*/
|
|
@@ -814,7 +740,7 @@ type Props$A = {
|
|
|
814
740
|
tabIndex?: number;
|
|
815
741
|
};
|
|
816
742
|
|
|
817
|
-
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$
|
|
743
|
+
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$z) => JSX.Element;
|
|
818
744
|
|
|
819
745
|
type Size$2 = {
|
|
820
746
|
top?: Space$1;
|
|
@@ -822,7 +748,7 @@ type Size$2 = {
|
|
|
822
748
|
left?: Space$1;
|
|
823
749
|
right?: Space$1;
|
|
824
750
|
};
|
|
825
|
-
type Props$
|
|
751
|
+
type Props$y = {
|
|
826
752
|
/**
|
|
827
753
|
* URL of the image that will be placed in the card component.
|
|
828
754
|
* In case of omission, the image container will not appear and
|
|
@@ -876,23 +802,26 @@ type Props$z = {
|
|
|
876
802
|
children?: ReactNode;
|
|
877
803
|
};
|
|
878
804
|
|
|
879
|
-
declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$
|
|
805
|
+
declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$y) => react_jsx_runtime.JSX.Element;
|
|
880
806
|
|
|
881
|
-
type Props$
|
|
807
|
+
type Props$x = {
|
|
882
808
|
/**
|
|
883
|
-
*
|
|
809
|
+
* Specifies a string to be used as the name for the checkbox element when no `label` is provided.
|
|
884
810
|
*/
|
|
885
|
-
|
|
811
|
+
ariaLabel?: string;
|
|
886
812
|
/**
|
|
887
813
|
* If true, the component is checked. If undefined the component will be
|
|
888
814
|
* uncontrolled and the value will be managed internally by the component.
|
|
889
815
|
*/
|
|
890
816
|
checked?: boolean;
|
|
891
817
|
/**
|
|
892
|
-
*
|
|
893
|
-
* When inside a form, this value will be only submitted if the checkbox is checked.
|
|
818
|
+
* Initial state of the checkbox, only when it is uncontrolled.
|
|
894
819
|
*/
|
|
895
|
-
|
|
820
|
+
defaultChecked?: boolean;
|
|
821
|
+
/**
|
|
822
|
+
* If true, the component will be disabled.
|
|
823
|
+
*/
|
|
824
|
+
disabled?: boolean;
|
|
896
825
|
/**
|
|
897
826
|
* Text to be placed next to the checkbox.
|
|
898
827
|
*/
|
|
@@ -901,14 +830,22 @@ type Props$y = {
|
|
|
901
830
|
* Whether the label should appear after or before the checkbox.
|
|
902
831
|
*/
|
|
903
832
|
labelPosition?: "before" | "after";
|
|
833
|
+
/**
|
|
834
|
+
* Size of the margin to be applied to the component
|
|
835
|
+
* ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
836
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
837
|
+
* in order to specify different margin sizes.
|
|
838
|
+
*/
|
|
839
|
+
margin?: Space$1 | Margin;
|
|
904
840
|
/**
|
|
905
841
|
* Name attribute of the input element.
|
|
906
842
|
*/
|
|
907
843
|
name?: string;
|
|
908
844
|
/**
|
|
909
|
-
*
|
|
845
|
+
* This function will be called when the user clicks the checkbox.
|
|
846
|
+
* The new value will be passed as a parameter.
|
|
910
847
|
*/
|
|
911
|
-
|
|
848
|
+
onChange?: (value: boolean) => void;
|
|
912
849
|
/**
|
|
913
850
|
* If true, the component will display '(Optional)' next to the label.
|
|
914
851
|
*/
|
|
@@ -917,18 +854,6 @@ type Props$y = {
|
|
|
917
854
|
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
918
855
|
*/
|
|
919
856
|
readOnly?: boolean;
|
|
920
|
-
/**
|
|
921
|
-
* This function will be called when the user clicks the checkbox.
|
|
922
|
-
* The new value will be passed as a parameter.
|
|
923
|
-
*/
|
|
924
|
-
onChange?: (value: boolean) => void;
|
|
925
|
-
/**
|
|
926
|
-
* Size of the margin to be applied to the component
|
|
927
|
-
* ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
928
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
929
|
-
* in order to specify different margin sizes.
|
|
930
|
-
*/
|
|
931
|
-
margin?: Space$1 | Margin;
|
|
932
857
|
/**
|
|
933
858
|
* Size of the component.
|
|
934
859
|
*/
|
|
@@ -938,14 +863,15 @@ type Props$y = {
|
|
|
938
863
|
*/
|
|
939
864
|
tabIndex?: number;
|
|
940
865
|
/**
|
|
941
|
-
*
|
|
866
|
+
* Will be passed to the value attribute of the html input element.
|
|
867
|
+
* When inside a form, this value will be only submitted if the checkbox is checked.
|
|
942
868
|
*/
|
|
943
|
-
|
|
869
|
+
value?: string;
|
|
944
870
|
};
|
|
945
871
|
|
|
946
|
-
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$
|
|
872
|
+
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$x & react.RefAttributes<HTMLDivElement>>;
|
|
947
873
|
|
|
948
|
-
type Props$
|
|
874
|
+
type Props$w = {
|
|
949
875
|
/**
|
|
950
876
|
* Text to be placed on the chip.
|
|
951
877
|
*/
|
|
@@ -981,15 +907,15 @@ type Props$x = {
|
|
|
981
907
|
tabIndex?: number;
|
|
982
908
|
};
|
|
983
909
|
|
|
984
|
-
declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: Props$
|
|
910
|
+
declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: Props$w) => react_jsx_runtime.JSX.Element;
|
|
985
911
|
|
|
986
|
-
type Space =
|
|
987
|
-
top?:
|
|
988
|
-
right?:
|
|
989
|
-
bottom?:
|
|
990
|
-
left?:
|
|
912
|
+
type Space = {
|
|
913
|
+
top?: string;
|
|
914
|
+
right?: string;
|
|
915
|
+
bottom?: string;
|
|
916
|
+
left?: string;
|
|
991
917
|
};
|
|
992
|
-
type Inset
|
|
918
|
+
type Inset = {
|
|
993
919
|
top?: string;
|
|
994
920
|
right?: string;
|
|
995
921
|
bottom?: string;
|
|
@@ -998,7 +924,7 @@ type Inset$1 = {
|
|
|
998
924
|
type Background = {
|
|
999
925
|
attachment?: string;
|
|
1000
926
|
clip?: string;
|
|
1001
|
-
color?:
|
|
927
|
+
color?: string;
|
|
1002
928
|
image?: string;
|
|
1003
929
|
origin?: string;
|
|
1004
930
|
position?: string;
|
|
@@ -1007,8 +933,8 @@ type Background = {
|
|
|
1007
933
|
};
|
|
1008
934
|
type BorderProperties = {
|
|
1009
935
|
width?: string;
|
|
1010
|
-
style?:
|
|
1011
|
-
color?:
|
|
936
|
+
style?: string;
|
|
937
|
+
color?: string;
|
|
1012
938
|
};
|
|
1013
939
|
type Border = BorderProperties | {
|
|
1014
940
|
top?: BorderProperties;
|
|
@@ -1024,7 +950,7 @@ type Overflow = OverflowValues | {
|
|
|
1024
950
|
x?: OverflowValues;
|
|
1025
951
|
y?: OverflowValues;
|
|
1026
952
|
};
|
|
1027
|
-
type Props$
|
|
953
|
+
type Props$v = {
|
|
1028
954
|
/**
|
|
1029
955
|
* Based on the CSS property background allows configuring all properties related to the background of a container.
|
|
1030
956
|
*
|
|
@@ -1056,7 +982,7 @@ type Props$w = {
|
|
|
1056
982
|
/**
|
|
1057
983
|
* Custom content inside the container.
|
|
1058
984
|
*/
|
|
1059
|
-
children
|
|
985
|
+
children?: ReactNode;
|
|
1060
986
|
/**
|
|
1061
987
|
* Sets the display CSS property.
|
|
1062
988
|
* The set of values is limited to the ones related to the outer display type.
|
|
@@ -1082,19 +1008,11 @@ type Props$w = {
|
|
|
1082
1008
|
* Based on the CSS property inset this prop is a shorthand that corresponds
|
|
1083
1009
|
* to the top, right, bottom, and/or left properties.
|
|
1084
1010
|
*/
|
|
1085
|
-
inset?: Inset
|
|
1086
|
-
/**
|
|
1087
|
-
* Size of the margin to be applied to the component.
|
|
1088
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
1089
|
-
* in order to specify different margin sizes.
|
|
1090
|
-
*/
|
|
1091
|
-
margin?: Space;
|
|
1011
|
+
inset?: Inset;
|
|
1092
1012
|
/**
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1095
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/max-height
|
|
1013
|
+
* Size of the margin to be applied to the container.
|
|
1096
1014
|
*/
|
|
1097
|
-
|
|
1015
|
+
margin?: string | Space;
|
|
1098
1016
|
/**
|
|
1099
1017
|
* Sets the max-width CSS property.
|
|
1100
1018
|
*
|
|
@@ -1102,17 +1020,23 @@ type Props$w = {
|
|
|
1102
1020
|
*/
|
|
1103
1021
|
maxHeight?: string;
|
|
1104
1022
|
/**
|
|
1105
|
-
* Sets the
|
|
1023
|
+
* Sets the max-height CSS property.
|
|
1106
1024
|
*
|
|
1107
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/
|
|
1025
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/max-height
|
|
1108
1026
|
*/
|
|
1109
|
-
|
|
1027
|
+
maxWidth?: string;
|
|
1110
1028
|
/**
|
|
1111
1029
|
* Sets the min-width CSS property.
|
|
1112
1030
|
*
|
|
1113
1031
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/min-width
|
|
1114
1032
|
*/
|
|
1115
1033
|
minHeight?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* Sets the min-height CSS property.
|
|
1036
|
+
*
|
|
1037
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/min-height
|
|
1038
|
+
*/
|
|
1039
|
+
minWidth?: string;
|
|
1116
1040
|
/**
|
|
1117
1041
|
* Based on the CSS property outline allows configuring all properties related
|
|
1118
1042
|
* to the outline of a container.
|
|
@@ -1125,11 +1049,9 @@ type Props$w = {
|
|
|
1125
1049
|
*/
|
|
1126
1050
|
overflow?: Overflow;
|
|
1127
1051
|
/**
|
|
1128
|
-
* Size of the
|
|
1129
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
1130
|
-
* in order to specify different margin sizes.
|
|
1052
|
+
* Size of the padding to be applied to the container.
|
|
1131
1053
|
*/
|
|
1132
|
-
padding?: Space;
|
|
1054
|
+
padding?: string | Space;
|
|
1133
1055
|
/**
|
|
1134
1056
|
* Sets the position CSS property.
|
|
1135
1057
|
*
|
|
@@ -1150,7 +1072,7 @@ type Props$w = {
|
|
|
1150
1072
|
zIndex?: "auto" | number;
|
|
1151
1073
|
};
|
|
1152
1074
|
|
|
1153
|
-
declare function DxcContainer({ display, width, height, overflow, ...props }: Props$
|
|
1075
|
+
declare function DxcContainer({ display, width, height, overflow, ...props }: Props$v): react_jsx_runtime.JSX.Element;
|
|
1154
1076
|
|
|
1155
1077
|
type CommonItemProps = {
|
|
1156
1078
|
badge?: ReactElement;
|
|
@@ -1168,7 +1090,7 @@ type Section = {
|
|
|
1168
1090
|
items: (Item | GroupItem)[];
|
|
1169
1091
|
title?: string;
|
|
1170
1092
|
};
|
|
1171
|
-
type Props$
|
|
1093
|
+
type Props$u = {
|
|
1172
1094
|
/**
|
|
1173
1095
|
* Array of items to be displayed in the Contextual menu.
|
|
1174
1096
|
* Each item can be a single/simple item, a group item or a section.
|
|
@@ -1176,27 +1098,32 @@ type Props$v = {
|
|
|
1176
1098
|
items: (Item | GroupItem)[] | Section[];
|
|
1177
1099
|
};
|
|
1178
1100
|
|
|
1179
|
-
declare function DxcContextualMenu({ items }: Props$
|
|
1101
|
+
declare function DxcContextualMenu({ items }: Props$u): react_jsx_runtime.JSX.Element;
|
|
1180
1102
|
|
|
1181
|
-
type
|
|
1182
|
-
|
|
1103
|
+
type BaseActionCell = {
|
|
1104
|
+
disabled?: boolean;
|
|
1105
|
+
tabIndex?: number;
|
|
1106
|
+
title: string;
|
|
1183
1107
|
};
|
|
1184
|
-
type
|
|
1108
|
+
type ActionCell = BaseActionCell & ({
|
|
1185
1109
|
icon: string | SVG;
|
|
1186
|
-
title: string;
|
|
1187
1110
|
onClick: () => void;
|
|
1188
|
-
disabled?: boolean;
|
|
1189
|
-
tabIndex?: number;
|
|
1190
1111
|
options?: never;
|
|
1191
1112
|
} | {
|
|
1192
1113
|
icon?: never;
|
|
1193
|
-
title: string;
|
|
1194
1114
|
onClick: (value?: string) => void;
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1115
|
+
options: Option$2[];
|
|
1116
|
+
});
|
|
1117
|
+
type ActionsCellPropsType = {
|
|
1118
|
+
/**
|
|
1119
|
+
* It represents a list of interactive elements that will work as buttons or as a dropdown. Those with an icon from Material Symbols
|
|
1120
|
+
* or a SVG are treated as buttons. If any element lacks an icon and includes options, it is interpreted as a dropdown.
|
|
1121
|
+
* Only the first action with options will be displayed and only up to 3 actions.
|
|
1122
|
+
* In the case of the dropdown the click function will pass the value assigned to the option.
|
|
1123
|
+
*/
|
|
1124
|
+
actions: ActionCell[];
|
|
1125
|
+
};
|
|
1126
|
+
type Props$t = {
|
|
1200
1127
|
/**
|
|
1201
1128
|
* The center section of the table. Can be used to render custom
|
|
1202
1129
|
* content in this area.
|
|
@@ -1265,6 +1192,7 @@ type HierarchyGridRow = GridRow & {
|
|
|
1265
1192
|
type ExpandableGridRow = GridRow & {
|
|
1266
1193
|
expandedContent?: ReactNode;
|
|
1267
1194
|
expandedContentHeight?: number;
|
|
1195
|
+
contentIsExpanded?: boolean;
|
|
1268
1196
|
};
|
|
1269
1197
|
type ExpandableRows = {
|
|
1270
1198
|
rows: ExpandableGridRow[];
|
|
@@ -1341,6 +1269,10 @@ type PaginatedProps$1 = {
|
|
|
1341
1269
|
* Function called whenever the current page is changed.
|
|
1342
1270
|
*/
|
|
1343
1271
|
onPageChange?: (_page: number) => void;
|
|
1272
|
+
/**
|
|
1273
|
+
* Default page in which the datagrid is rendered
|
|
1274
|
+
*/
|
|
1275
|
+
defaultPage?: number;
|
|
1344
1276
|
};
|
|
1345
1277
|
type NonPaginatedProps$1 = {
|
|
1346
1278
|
/**
|
|
@@ -1372,6 +1304,10 @@ type NonPaginatedProps$1 = {
|
|
|
1372
1304
|
* Function called whenever the current page is changed.
|
|
1373
1305
|
*/
|
|
1374
1306
|
onPageChange?: never;
|
|
1307
|
+
/**
|
|
1308
|
+
* Default page in which the datagrid is rendered
|
|
1309
|
+
*/
|
|
1310
|
+
defaultPage?: never;
|
|
1375
1311
|
};
|
|
1376
1312
|
type CommonProps$6 = {
|
|
1377
1313
|
columns: GridColumn[];
|
|
@@ -1396,14 +1332,14 @@ type BasicGridProps = {
|
|
|
1396
1332
|
*/
|
|
1397
1333
|
expandable?: false;
|
|
1398
1334
|
};
|
|
1399
|
-
type Props$
|
|
1335
|
+
type Props$s = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((BasicGridProps & SelectableGridProps) | (ExpandableRows & SelectableGridProps) | (HierarchyRows & SelectableGridProps));
|
|
1400
1336
|
|
|
1401
1337
|
declare const DxcDataGrid: {
|
|
1402
|
-
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, }: Props$
|
|
1403
|
-
ActionsCell: ({ actions }:
|
|
1338
|
+
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$s): JSX.Element;
|
|
1339
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
1404
1340
|
};
|
|
1405
1341
|
|
|
1406
|
-
type Props$
|
|
1342
|
+
type Props$r = {
|
|
1407
1343
|
/**
|
|
1408
1344
|
* Initial value of the input element, only when it is uncontrolled.
|
|
1409
1345
|
*/
|
|
@@ -1509,9 +1445,9 @@ type Props$s = {
|
|
|
1509
1445
|
ariaLabel?: string;
|
|
1510
1446
|
};
|
|
1511
1447
|
|
|
1512
|
-
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$
|
|
1448
|
+
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$r & react.RefAttributes<HTMLDivElement>>;
|
|
1513
1449
|
|
|
1514
|
-
type Props$
|
|
1450
|
+
type Props$q = {
|
|
1515
1451
|
/**
|
|
1516
1452
|
* If true, the close button will be visible.
|
|
1517
1453
|
*/
|
|
@@ -1546,9 +1482,9 @@ type Props$r = {
|
|
|
1546
1482
|
tabIndex?: number;
|
|
1547
1483
|
};
|
|
1548
1484
|
|
|
1549
|
-
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, }: Props$
|
|
1485
|
+
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, }: Props$q) => JSX.Element;
|
|
1550
1486
|
|
|
1551
|
-
type Props$
|
|
1487
|
+
type Props$p = {
|
|
1552
1488
|
/**
|
|
1553
1489
|
* The divider can be shown in horizontal or vertical.
|
|
1554
1490
|
*/
|
|
@@ -1569,9 +1505,9 @@ type Props$q = {
|
|
|
1569
1505
|
decorative?: boolean;
|
|
1570
1506
|
};
|
|
1571
1507
|
|
|
1572
|
-
declare
|
|
1508
|
+
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$p): react_jsx_runtime.JSX.Element;
|
|
1573
1509
|
|
|
1574
|
-
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$
|
|
1510
|
+
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$F) => react_jsx_runtime.JSX.Element;
|
|
1575
1511
|
|
|
1576
1512
|
type FileData = {
|
|
1577
1513
|
/**
|
|
@@ -1672,17 +1608,17 @@ type FileModeProps = CommonProps$5 & {
|
|
|
1672
1608
|
*/
|
|
1673
1609
|
dropAreaLabel?: never;
|
|
1674
1610
|
};
|
|
1675
|
-
type Props$
|
|
1611
|
+
type Props$o = DropModeProps | FileModeProps;
|
|
1676
1612
|
|
|
1677
|
-
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$
|
|
1613
|
+
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$o & react.RefAttributes<HTMLDivElement>>;
|
|
1678
1614
|
|
|
1679
1615
|
type Gap$1 = {
|
|
1680
|
-
rowGap:
|
|
1681
|
-
columnGap?:
|
|
1616
|
+
rowGap: string;
|
|
1617
|
+
columnGap?: string;
|
|
1682
1618
|
} | {
|
|
1683
|
-
rowGap?:
|
|
1684
|
-
columnGap:
|
|
1685
|
-
} |
|
|
1619
|
+
rowGap?: string;
|
|
1620
|
+
columnGap: string;
|
|
1621
|
+
} | string;
|
|
1686
1622
|
type CommonProps$4 = {
|
|
1687
1623
|
/**
|
|
1688
1624
|
* Sets the justify-content CSS property.
|
|
@@ -1709,7 +1645,7 @@ type CommonProps$4 = {
|
|
|
1709
1645
|
*/
|
|
1710
1646
|
alignSelf?: "auto" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
|
|
1711
1647
|
};
|
|
1712
|
-
type Props$
|
|
1648
|
+
type Props$n = CommonProps$4 & {
|
|
1713
1649
|
/**
|
|
1714
1650
|
* Sets the flex-direction CSS property.
|
|
1715
1651
|
*
|
|
@@ -1762,49 +1698,51 @@ type Props$o = CommonProps$4 & {
|
|
|
1762
1698
|
children: ReactNode;
|
|
1763
1699
|
};
|
|
1764
1700
|
|
|
1765
|
-
declare const DxcFlex: ({ basis, direction, gap, grow, order, shrink, wrap, ...props }: Props$
|
|
1701
|
+
declare const DxcFlex: ({ basis, direction, gap, grow, order, shrink, wrap, ...props }: Props$n) => react_jsx_runtime.JSX.Element;
|
|
1766
1702
|
|
|
1767
|
-
type Gap = {
|
|
1768
|
-
|
|
1769
|
-
|
|
1703
|
+
type Gap = string | {
|
|
1704
|
+
columnGap?: string;
|
|
1705
|
+
rowGap: string;
|
|
1770
1706
|
} | {
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
}
|
|
1707
|
+
columnGap: string;
|
|
1708
|
+
rowGap?: string;
|
|
1709
|
+
};
|
|
1774
1710
|
type GridCell = {
|
|
1775
|
-
start: number | string;
|
|
1776
1711
|
end: number | string;
|
|
1712
|
+
start: number | string;
|
|
1777
1713
|
};
|
|
1778
|
-
type PlaceSelfValues = "auto" | "
|
|
1779
|
-
type PlaceContentValues = "
|
|
1780
|
-
type PlaceItemsValues = "
|
|
1714
|
+
type PlaceSelfValues = "auto" | "baseline" | "center" | "end" | "start" | "stretch";
|
|
1715
|
+
type PlaceContentValues = "baseline" | "center" | "end" | "normal" | "space-around" | "space-between" | "space-evenly" | "start" | "stretch";
|
|
1716
|
+
type PlaceItemsValues = "baseline" | "center" | "end" | "normal" | "start" | "stretch";
|
|
1781
1717
|
type PlaceObject<Type, Suffix extends string> = {
|
|
1782
1718
|
[Property in keyof Type as `${string & Property}${Capitalize<string & Suffix>}`]: Type[Property];
|
|
1783
1719
|
};
|
|
1784
1720
|
type PlaceGeneric<PlaceValues, Element extends string> = PlaceObject<{
|
|
1785
|
-
justify?: PlaceValues;
|
|
1786
1721
|
align: PlaceValues;
|
|
1722
|
+
justify?: PlaceValues;
|
|
1787
1723
|
}, Element> | PlaceObject<{
|
|
1788
|
-
justify: PlaceValues;
|
|
1789
1724
|
align?: PlaceValues;
|
|
1725
|
+
justify: PlaceValues;
|
|
1790
1726
|
}, Element> | PlaceValues;
|
|
1791
1727
|
type GridItemProps = {
|
|
1792
1728
|
/**
|
|
1793
1729
|
* Sets the name of an item so that it can be referenced by a template created with the grid-template-areas property.
|
|
1794
1730
|
*/
|
|
1795
1731
|
areaName?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* Sets a custom HTML tag.
|
|
1734
|
+
*/
|
|
1735
|
+
as?: keyof HTMLElementTagNameMap;
|
|
1736
|
+
/**
|
|
1737
|
+
* Custom content inside the grid container.
|
|
1738
|
+
*/
|
|
1739
|
+
children: ReactNode;
|
|
1796
1740
|
/**
|
|
1797
1741
|
* Sets the grid-column CSS property.
|
|
1798
1742
|
*
|
|
1799
1743
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
|
|
1800
1744
|
*/
|
|
1801
1745
|
column?: number | string | GridCell;
|
|
1802
|
-
/**
|
|
1803
|
-
* Sets the grid-row CSS property.
|
|
1804
|
-
*
|
|
1805
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
1806
|
-
*/
|
|
1807
|
-
row?: number | string | GridCell;
|
|
1808
1746
|
/**
|
|
1809
1747
|
* Sets the place-self CSS property.
|
|
1810
1748
|
*
|
|
@@ -1812,15 +1750,13 @@ type GridItemProps = {
|
|
|
1812
1750
|
*/
|
|
1813
1751
|
placeSelf?: PlaceGeneric<PlaceSelfValues, "self">;
|
|
1814
1752
|
/**
|
|
1815
|
-
* Sets
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
/**
|
|
1819
|
-
* Custom content inside the grid container.
|
|
1753
|
+
* Sets the grid-row CSS property.
|
|
1754
|
+
*
|
|
1755
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
1820
1756
|
*/
|
|
1821
|
-
|
|
1757
|
+
row?: number | string | GridCell;
|
|
1822
1758
|
};
|
|
1823
|
-
type Props$
|
|
1759
|
+
type Props$m = GridItemProps & {
|
|
1824
1760
|
/**
|
|
1825
1761
|
* Sets the grid-auto-columns CSS property.
|
|
1826
1762
|
*
|
|
@@ -1844,7 +1780,7 @@ type Props$n = GridItemProps & {
|
|
|
1844
1780
|
*
|
|
1845
1781
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/gap
|
|
1846
1782
|
*/
|
|
1847
|
-
gap?:
|
|
1783
|
+
gap?: Gap;
|
|
1848
1784
|
/**
|
|
1849
1785
|
* Sets the place-content CSS property.
|
|
1850
1786
|
*
|
|
@@ -1878,17 +1814,17 @@ type Props$n = GridItemProps & {
|
|
|
1878
1814
|
};
|
|
1879
1815
|
|
|
1880
1816
|
declare const DxcGrid: {
|
|
1881
|
-
(props: Props$
|
|
1817
|
+
(props: Props$m): react_jsx_runtime.JSX.Element;
|
|
1882
1818
|
Item: styled_components.StyledComponent<"div", any, GridItemProps, never>;
|
|
1883
1819
|
};
|
|
1884
1820
|
|
|
1885
|
-
type Props$
|
|
1821
|
+
type Props$l = {
|
|
1886
1822
|
/**
|
|
1887
1823
|
* Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
|
|
1888
1824
|
* The html tag of the heading will be the one specified in the 'as' prop.
|
|
1889
1825
|
* If 'as' is not specified, the html tag of the heading is the one specified in the 'level' prop.
|
|
1890
1826
|
*/
|
|
1891
|
-
level?: 1 | 2 | 3 | 4 | 5;
|
|
1827
|
+
level?: 1 | 2 | 3 | 4 | 5 | 6;
|
|
1892
1828
|
/**
|
|
1893
1829
|
* Heading text.
|
|
1894
1830
|
*/
|
|
@@ -1896,11 +1832,11 @@ type Props$m = {
|
|
|
1896
1832
|
/**
|
|
1897
1833
|
* Modifies the default weight of the heading.
|
|
1898
1834
|
*/
|
|
1899
|
-
weight?: "light" | "
|
|
1835
|
+
weight?: "light" | "default" | "regular";
|
|
1900
1836
|
/**
|
|
1901
1837
|
* Specifies the HTML tag of the heading.
|
|
1902
1838
|
*/
|
|
1903
|
-
as?: "h1" | "h2" | "h3" | "h4" | "h5";
|
|
1839
|
+
as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
1904
1840
|
/**
|
|
1905
1841
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1906
1842
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
@@ -1908,9 +1844,9 @@ type Props$m = {
|
|
|
1908
1844
|
margin?: Space$1 | Margin;
|
|
1909
1845
|
};
|
|
1910
1846
|
|
|
1911
|
-
declare
|
|
1847
|
+
declare function DxcHeading({ as, level, margin, text, weight }: Props$l): react_jsx_runtime.JSX.Element;
|
|
1912
1848
|
|
|
1913
|
-
type Props$
|
|
1849
|
+
type Props$k = {
|
|
1914
1850
|
/**
|
|
1915
1851
|
* Alternative text description displayed when the specified image is not loaded.
|
|
1916
1852
|
*
|
|
@@ -1923,21 +1859,35 @@ type Props$l = {
|
|
|
1923
1859
|
* which is required regardless of the presence of the caption or not.
|
|
1924
1860
|
*/
|
|
1925
1861
|
caption?: string;
|
|
1862
|
+
/**
|
|
1863
|
+
* Sets the rendered height of the image.
|
|
1864
|
+
*/
|
|
1865
|
+
height?: string;
|
|
1926
1866
|
/**
|
|
1927
1867
|
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
1928
1868
|
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
1929
1869
|
*/
|
|
1930
1870
|
lazyLoading?: boolean;
|
|
1931
1871
|
/**
|
|
1932
|
-
*
|
|
1872
|
+
* Sets the object-fit CSS property.
|
|
1873
|
+
*
|
|
1874
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1933
1875
|
*/
|
|
1934
|
-
|
|
1876
|
+
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
1935
1877
|
/**
|
|
1936
|
-
*
|
|
1878
|
+
* Sets the object-position CSS property.
|
|
1937
1879
|
*
|
|
1938
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/
|
|
1880
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
1939
1881
|
*/
|
|
1940
|
-
|
|
1882
|
+
objectPosition?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* This function will be called when the image fails to load.
|
|
1885
|
+
*/
|
|
1886
|
+
onError?: ReactEventHandler<HTMLImageElement>;
|
|
1887
|
+
/**
|
|
1888
|
+
* This function will be called when the image is loaded.
|
|
1889
|
+
*/
|
|
1890
|
+
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
1941
1891
|
/**
|
|
1942
1892
|
* One or more strings separated by commas, indicating a set of source sizes.
|
|
1943
1893
|
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
@@ -1947,73 +1897,59 @@ type Props$l = {
|
|
|
1947
1897
|
*/
|
|
1948
1898
|
sizes?: string;
|
|
1949
1899
|
/**
|
|
1950
|
-
*
|
|
1951
|
-
*/
|
|
1952
|
-
width?: string;
|
|
1953
|
-
/**
|
|
1954
|
-
* Sets the rendered height of the image.
|
|
1955
|
-
*/
|
|
1956
|
-
height?: string;
|
|
1957
|
-
/**
|
|
1958
|
-
* Sets the object-fit CSS property.
|
|
1959
|
-
*
|
|
1960
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1900
|
+
* URL of the image. This prop is required and must be valid.
|
|
1961
1901
|
*/
|
|
1962
|
-
|
|
1902
|
+
src: string;
|
|
1963
1903
|
/**
|
|
1964
|
-
*
|
|
1904
|
+
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
1965
1905
|
*
|
|
1966
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/
|
|
1967
|
-
*/
|
|
1968
|
-
objectPosition?: string;
|
|
1969
|
-
/**
|
|
1970
|
-
* This function will be called when the image is loaded.
|
|
1906
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
1971
1907
|
*/
|
|
1972
|
-
|
|
1908
|
+
srcSet?: string;
|
|
1973
1909
|
/**
|
|
1974
|
-
*
|
|
1910
|
+
* Sets the rendered width of the image.
|
|
1975
1911
|
*/
|
|
1976
|
-
|
|
1912
|
+
width?: string;
|
|
1977
1913
|
};
|
|
1978
1914
|
|
|
1979
|
-
declare function DxcImage({ alt, caption,
|
|
1915
|
+
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$k): react_jsx_runtime.JSX.Element;
|
|
1980
1916
|
|
|
1981
|
-
type Props$
|
|
1917
|
+
type Props$j = {
|
|
1982
1918
|
/**
|
|
1983
|
-
* Applies the spacing scale to
|
|
1919
|
+
* Applies the spacing scale to the bottom side.
|
|
1984
1920
|
*/
|
|
1985
|
-
|
|
1921
|
+
bottom?: string;
|
|
1986
1922
|
/**
|
|
1987
|
-
*
|
|
1923
|
+
* Custom content inside the inset.
|
|
1988
1924
|
*/
|
|
1989
|
-
|
|
1925
|
+
children: ReactNode;
|
|
1990
1926
|
/**
|
|
1991
|
-
* Applies the spacing scale to the
|
|
1927
|
+
* Applies the spacing scale to the left and right sides.
|
|
1992
1928
|
*/
|
|
1993
|
-
|
|
1929
|
+
horizontal?: string;
|
|
1994
1930
|
/**
|
|
1995
|
-
* Applies the spacing scale to the
|
|
1931
|
+
* Applies the spacing scale to the left side.
|
|
1996
1932
|
*/
|
|
1997
|
-
|
|
1933
|
+
left?: string;
|
|
1998
1934
|
/**
|
|
1999
1935
|
* Applies the spacing scale to the right side.
|
|
2000
1936
|
*/
|
|
2001
|
-
right?:
|
|
1937
|
+
right?: string;
|
|
2002
1938
|
/**
|
|
2003
|
-
* Applies the spacing scale to
|
|
1939
|
+
* Applies the spacing scale to all sides.
|
|
2004
1940
|
*/
|
|
2005
|
-
|
|
1941
|
+
space?: string;
|
|
2006
1942
|
/**
|
|
2007
|
-
* Applies the spacing scale to the
|
|
1943
|
+
* Applies the spacing scale to the top side.
|
|
2008
1944
|
*/
|
|
2009
|
-
|
|
1945
|
+
top?: string;
|
|
2010
1946
|
/**
|
|
2011
|
-
*
|
|
1947
|
+
* Applies the spacing scale to the top and bottom sides.
|
|
2012
1948
|
*/
|
|
2013
|
-
|
|
1949
|
+
vertical?: string;
|
|
2014
1950
|
};
|
|
2015
1951
|
|
|
2016
|
-
declare
|
|
1952
|
+
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$j): react_jsx_runtime.JSX.Element;
|
|
2017
1953
|
|
|
2018
1954
|
type LinkProps = {
|
|
2019
1955
|
/**
|
|
@@ -2092,7 +2028,7 @@ type TabProps$1 = {
|
|
|
2092
2028
|
*/
|
|
2093
2029
|
children: string;
|
|
2094
2030
|
};
|
|
2095
|
-
type Props$
|
|
2031
|
+
type Props$i = {
|
|
2096
2032
|
/**
|
|
2097
2033
|
* Whether the icon should appear above or to the left of the label.
|
|
2098
2034
|
*/
|
|
@@ -2108,11 +2044,11 @@ type Props$j = {
|
|
|
2108
2044
|
};
|
|
2109
2045
|
|
|
2110
2046
|
declare const DxcNavTabs: {
|
|
2111
|
-
({ iconPosition, tabIndex, children }: Props$
|
|
2047
|
+
({ iconPosition, tabIndex, children }: Props$i): JSX.Element;
|
|
2112
2048
|
Tab: react.ForwardRefExoticComponent<TabProps$1 & react.RefAttributes<HTMLAnchorElement>>;
|
|
2113
2049
|
};
|
|
2114
2050
|
|
|
2115
|
-
type Props$
|
|
2051
|
+
type Props$h = {
|
|
2116
2052
|
/**
|
|
2117
2053
|
* Text to be placed above the number.
|
|
2118
2054
|
*/
|
|
@@ -2239,9 +2175,9 @@ type Props$i = {
|
|
|
2239
2175
|
showControls?: boolean;
|
|
2240
2176
|
};
|
|
2241
2177
|
|
|
2242
|
-
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$
|
|
2178
|
+
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$h & react.RefAttributes<HTMLDivElement>>;
|
|
2243
2179
|
|
|
2244
|
-
type Props$
|
|
2180
|
+
type Props$g = {
|
|
2245
2181
|
/**
|
|
2246
2182
|
* Number of the current selected page.
|
|
2247
2183
|
*/
|
|
@@ -2279,13 +2215,13 @@ type Props$h = {
|
|
|
2279
2215
|
tabIndex?: number;
|
|
2280
2216
|
};
|
|
2281
2217
|
|
|
2282
|
-
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$
|
|
2218
|
+
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$g) => JSX.Element;
|
|
2283
2219
|
|
|
2284
2220
|
declare function DxcParagraph({ children }: {
|
|
2285
2221
|
children: ReactNode;
|
|
2286
2222
|
}): react_jsx_runtime.JSX.Element;
|
|
2287
2223
|
|
|
2288
|
-
type Props$
|
|
2224
|
+
type Props$f = {
|
|
2289
2225
|
/**
|
|
2290
2226
|
* Text to be placed above the password input.
|
|
2291
2227
|
*/
|
|
@@ -2389,7 +2325,7 @@ type Props$g = {
|
|
|
2389
2325
|
ariaLabel?: string;
|
|
2390
2326
|
};
|
|
2391
2327
|
|
|
2392
|
-
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$
|
|
2328
|
+
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$f & react.RefAttributes<HTMLDivElement>>;
|
|
2393
2329
|
|
|
2394
2330
|
type Size$1 = {
|
|
2395
2331
|
top?: Space$1;
|
|
@@ -2397,7 +2333,7 @@ type Size$1 = {
|
|
|
2397
2333
|
left?: Space$1;
|
|
2398
2334
|
right?: Space$1;
|
|
2399
2335
|
};
|
|
2400
|
-
type Props$
|
|
2336
|
+
type Props$e = {
|
|
2401
2337
|
/**
|
|
2402
2338
|
* Text to be placed above the progress bar.
|
|
2403
2339
|
*/
|
|
@@ -2431,7 +2367,7 @@ type Props$f = {
|
|
|
2431
2367
|
ariaLabel?: string;
|
|
2432
2368
|
};
|
|
2433
2369
|
|
|
2434
|
-
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$
|
|
2370
|
+
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$e) => JSX.Element;
|
|
2435
2371
|
|
|
2436
2372
|
type Link = {
|
|
2437
2373
|
/**
|
|
@@ -2443,7 +2379,7 @@ type Link = {
|
|
|
2443
2379
|
*/
|
|
2444
2380
|
links?: Link[];
|
|
2445
2381
|
};
|
|
2446
|
-
type Props$
|
|
2382
|
+
type Props$d = {
|
|
2447
2383
|
/**
|
|
2448
2384
|
* Title of the quick nav component.
|
|
2449
2385
|
*/
|
|
@@ -2454,9 +2390,9 @@ type Props$e = {
|
|
|
2454
2390
|
links: Link[];
|
|
2455
2391
|
};
|
|
2456
2392
|
|
|
2457
|
-
declare
|
|
2393
|
+
declare function DxcQuickNav({ links, title }: Props$d): react_jsx_runtime.JSX.Element;
|
|
2458
2394
|
|
|
2459
|
-
type
|
|
2395
|
+
type Option$1 = {
|
|
2460
2396
|
/**
|
|
2461
2397
|
* Label of the option placed next to the radio input.
|
|
2462
2398
|
*/
|
|
@@ -2474,26 +2410,39 @@ type RadioOption = {
|
|
|
2474
2410
|
};
|
|
2475
2411
|
type RadioGroupProps = {
|
|
2476
2412
|
/**
|
|
2477
|
-
*
|
|
2413
|
+
* Specifies a string to be used as the name for the radio group when no `label` is provided.
|
|
2478
2414
|
*/
|
|
2479
|
-
|
|
2415
|
+
ariaLabel?: string;
|
|
2480
2416
|
/**
|
|
2481
|
-
*
|
|
2482
|
-
* to find the component's value during the submit event.
|
|
2417
|
+
* Initial value of the radio group, only when it is uncontrolled.
|
|
2483
2418
|
*/
|
|
2484
|
-
|
|
2419
|
+
defaultValue?: string;
|
|
2420
|
+
/**
|
|
2421
|
+
* If true, the component will be disabled.
|
|
2422
|
+
*/
|
|
2423
|
+
disabled?: boolean;
|
|
2424
|
+
/**
|
|
2425
|
+
* If it is a defined value and also a truthy string, the component will
|
|
2426
|
+
* change its appearance, showing the error below the radio group. If the
|
|
2427
|
+
* defined value is an empty string, it will reserve a space below the
|
|
2428
|
+
* component for a future error, but it would not change its look. In
|
|
2429
|
+
* case of being undefined or null, both the appearance and the space for
|
|
2430
|
+
* the error message would not be modified.
|
|
2431
|
+
*/
|
|
2432
|
+
error?: string;
|
|
2485
2433
|
/**
|
|
2486
2434
|
* Helper text to be placed above the radio group.
|
|
2487
2435
|
*/
|
|
2488
2436
|
helperText?: string;
|
|
2489
2437
|
/**
|
|
2490
|
-
*
|
|
2438
|
+
* Text to be placed above the radio group.
|
|
2491
2439
|
*/
|
|
2492
|
-
|
|
2440
|
+
label?: string;
|
|
2493
2441
|
/**
|
|
2494
|
-
*
|
|
2442
|
+
* Name attribute of the input element. This attribute will allow users
|
|
2443
|
+
* to find the component's value during the submit event.
|
|
2495
2444
|
*/
|
|
2496
|
-
|
|
2445
|
+
name?: string;
|
|
2497
2446
|
/**
|
|
2498
2447
|
* If true, the radio group will be optional, showing
|
|
2499
2448
|
* (Optional) next to the label and adding a default last
|
|
@@ -2507,28 +2456,9 @@ type RadioGroupProps = {
|
|
|
2507
2456
|
*/
|
|
2508
2457
|
optionalItemLabel?: string;
|
|
2509
2458
|
/**
|
|
2510
|
-
*
|
|
2511
|
-
*/
|
|
2512
|
-
readOnly?: boolean;
|
|
2513
|
-
/**
|
|
2514
|
-
* Sets the orientation of the options within the radio group.
|
|
2515
|
-
*/
|
|
2516
|
-
stacking?: "row" | "column";
|
|
2517
|
-
/**
|
|
2518
|
-
* Initial value of the radio group, only when it is uncontrolled.
|
|
2519
|
-
*/
|
|
2520
|
-
defaultValue?: string;
|
|
2521
|
-
/**
|
|
2522
|
-
* Value of the radio group. If undefined, the component will be
|
|
2523
|
-
* uncontrolled and the value will be managed internally by the
|
|
2524
|
-
* component.
|
|
2525
|
-
*/
|
|
2526
|
-
value?: string;
|
|
2527
|
-
/**
|
|
2528
|
-
* This function will be called when the user chooses an option. The new
|
|
2529
|
-
* value will be passed to this function.
|
|
2459
|
+
* An array of objects representing the selectable options.
|
|
2530
2460
|
*/
|
|
2531
|
-
|
|
2461
|
+
options: Option$1[];
|
|
2532
2462
|
/**
|
|
2533
2463
|
* This function will be called when the radio group loses the focus. An
|
|
2534
2464
|
* object including the value and the error will be passed to this
|
|
@@ -2539,22 +2469,28 @@ type RadioGroupProps = {
|
|
|
2539
2469
|
error?: string;
|
|
2540
2470
|
}) => void;
|
|
2541
2471
|
/**
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
* defined value is an empty string, it will reserve a space below the
|
|
2545
|
-
* component for a future error, but it would not change its look. In
|
|
2546
|
-
* case of being undefined or null, both the appearance and the space for
|
|
2547
|
-
* the error message would not be modified.
|
|
2472
|
+
* This function will be called when the user chooses an option. The new
|
|
2473
|
+
* value will be passed to this function.
|
|
2548
2474
|
*/
|
|
2549
|
-
|
|
2475
|
+
onChange?: (value: string) => void;
|
|
2476
|
+
/**
|
|
2477
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
2478
|
+
*/
|
|
2479
|
+
readOnly?: boolean;
|
|
2480
|
+
/**
|
|
2481
|
+
* Sets the orientation of the options within the radio group.
|
|
2482
|
+
*/
|
|
2483
|
+
stacking?: "row" | "column";
|
|
2550
2484
|
/**
|
|
2551
2485
|
* Value of the tabindex attribute.
|
|
2552
2486
|
*/
|
|
2553
2487
|
tabIndex?: number;
|
|
2554
2488
|
/**
|
|
2555
|
-
*
|
|
2489
|
+
* Value of the radio group. If undefined, the component will be
|
|
2490
|
+
* uncontrolled and the value will be managed internally by the
|
|
2491
|
+
* component.
|
|
2556
2492
|
*/
|
|
2557
|
-
|
|
2493
|
+
value?: string;
|
|
2558
2494
|
};
|
|
2559
2495
|
|
|
2560
2496
|
declare const DxcRadioGroup: react.ForwardRefExoticComponent<RadioGroupProps & react.RefAttributes<HTMLDivElement>>;
|
|
@@ -2650,23 +2586,13 @@ type NonPaginatedProps = CommonProps$3 & {
|
|
|
2650
2586
|
*/
|
|
2651
2587
|
itemsPerPageFunction?: never;
|
|
2652
2588
|
};
|
|
2653
|
-
type Props$
|
|
2589
|
+
type Props$c = PaginatedProps | NonPaginatedProps;
|
|
2654
2590
|
|
|
2655
2591
|
declare const DxcResultsetTable: {
|
|
2656
|
-
({ columns,
|
|
2657
|
-
ActionsCell: ({ actions }:
|
|
2592
|
+
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, }: Props$c): react_jsx_runtime.JSX.Element;
|
|
2593
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
2658
2594
|
};
|
|
2659
2595
|
|
|
2660
|
-
type ListOptionGroupType = {
|
|
2661
|
-
/**
|
|
2662
|
-
* Label of the group to be shown in the select's listbox.
|
|
2663
|
-
*/
|
|
2664
|
-
label: string;
|
|
2665
|
-
/**
|
|
2666
|
-
* List of the grouped options.
|
|
2667
|
-
*/
|
|
2668
|
-
options: ListOptionType[];
|
|
2669
|
-
};
|
|
2670
2596
|
type ListOptionType = {
|
|
2671
2597
|
/**
|
|
2672
2598
|
* Element used as the icon that will be placed before the option label.
|
|
@@ -2686,6 +2612,16 @@ type ListOptionType = {
|
|
|
2686
2612
|
*/
|
|
2687
2613
|
value: string;
|
|
2688
2614
|
};
|
|
2615
|
+
type ListOptionGroupType = {
|
|
2616
|
+
/**
|
|
2617
|
+
* Label of the group to be shown in the select's listbox.
|
|
2618
|
+
*/
|
|
2619
|
+
label: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* List of the grouped options.
|
|
2622
|
+
*/
|
|
2623
|
+
options: ListOptionType[];
|
|
2624
|
+
};
|
|
2689
2625
|
type CommonProps$2 = {
|
|
2690
2626
|
/**
|
|
2691
2627
|
* Text to be placed above the select.
|
|
@@ -2755,6 +2691,10 @@ type CommonProps$2 = {
|
|
|
2755
2691
|
ariaLabel?: string;
|
|
2756
2692
|
};
|
|
2757
2693
|
type SingleSelect = CommonProps$2 & {
|
|
2694
|
+
/**
|
|
2695
|
+
* Enables users to select multiple items from the list.
|
|
2696
|
+
*/
|
|
2697
|
+
enableSelectAll?: never;
|
|
2758
2698
|
/**
|
|
2759
2699
|
* If true, the select component will support multiple selected options.
|
|
2760
2700
|
* In that case, value will be an array of strings with each selected
|
|
@@ -2791,6 +2731,10 @@ type SingleSelect = CommonProps$2 & {
|
|
|
2791
2731
|
}) => void;
|
|
2792
2732
|
};
|
|
2793
2733
|
type MultipleSelect = CommonProps$2 & {
|
|
2734
|
+
/**
|
|
2735
|
+
* Enables users to select multiple items from the list.
|
|
2736
|
+
*/
|
|
2737
|
+
enableSelectAll?: boolean;
|
|
2794
2738
|
/**
|
|
2795
2739
|
* If true, the select component will support multiple selected options.
|
|
2796
2740
|
* In that case, value will be an array of strings with each selected
|
|
@@ -2826,59 +2770,57 @@ type MultipleSelect = CommonProps$2 & {
|
|
|
2826
2770
|
error?: string;
|
|
2827
2771
|
}) => void;
|
|
2828
2772
|
};
|
|
2829
|
-
type Props$
|
|
2773
|
+
type Props$b = SingleSelect | MultipleSelect;
|
|
2830
2774
|
|
|
2831
|
-
declare const DxcSelect: react.ForwardRefExoticComponent<Props$
|
|
2775
|
+
declare const DxcSelect: react.ForwardRefExoticComponent<Props$b & react.RefAttributes<HTMLDivElement>>;
|
|
2832
2776
|
|
|
2833
|
-
type Props$
|
|
2834
|
-
/**
|
|
2835
|
-
* Text to be placed above the slider.
|
|
2836
|
-
*/
|
|
2837
|
-
label?: string;
|
|
2777
|
+
type Props$a = {
|
|
2838
2778
|
/**
|
|
2839
|
-
*
|
|
2779
|
+
* Specifies a string to be used as the name for the slider element when no `label` is provided.
|
|
2840
2780
|
*/
|
|
2841
|
-
|
|
2781
|
+
ariaLabel?: string;
|
|
2842
2782
|
/**
|
|
2843
2783
|
* Initial value of the slider, only when it is uncontrolled.
|
|
2844
2784
|
*/
|
|
2845
2785
|
defaultValue?: number;
|
|
2846
2786
|
/**
|
|
2847
|
-
*
|
|
2787
|
+
* If true, the component will be disabled.
|
|
2848
2788
|
*/
|
|
2849
|
-
|
|
2789
|
+
disabled?: boolean;
|
|
2850
2790
|
/**
|
|
2851
2791
|
* Helper text to be placed above the slider.
|
|
2852
2792
|
*/
|
|
2853
2793
|
helperText?: string;
|
|
2854
2794
|
/**
|
|
2855
|
-
*
|
|
2795
|
+
* Text to be placed above the slider.
|
|
2856
2796
|
*/
|
|
2857
|
-
|
|
2797
|
+
label?: string;
|
|
2858
2798
|
/**
|
|
2859
|
-
*
|
|
2799
|
+
* This function will be used to format the labels displayed next to the slider.
|
|
2800
|
+
* The value will be passed as parameter and the function must return the formatted value.
|
|
2860
2801
|
*/
|
|
2861
|
-
|
|
2802
|
+
labelFormatCallback?: (value: number) => string;
|
|
2862
2803
|
/**
|
|
2863
|
-
*
|
|
2804
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2805
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2864
2806
|
*/
|
|
2865
|
-
|
|
2807
|
+
margin?: Space$1 | Margin;
|
|
2866
2808
|
/**
|
|
2867
|
-
* Whether the
|
|
2809
|
+
* Whether the marks between each step should be shown or not.
|
|
2868
2810
|
*/
|
|
2869
|
-
|
|
2811
|
+
marks?: boolean;
|
|
2870
2812
|
/**
|
|
2871
|
-
*
|
|
2813
|
+
* The maximum value available for selection.
|
|
2872
2814
|
*/
|
|
2873
|
-
|
|
2815
|
+
maxValue?: number;
|
|
2874
2816
|
/**
|
|
2875
|
-
*
|
|
2817
|
+
* The minimum value available for selection.
|
|
2876
2818
|
*/
|
|
2877
|
-
|
|
2819
|
+
minValue?: number;
|
|
2878
2820
|
/**
|
|
2879
|
-
*
|
|
2821
|
+
* Name attribute of the input element.
|
|
2880
2822
|
*/
|
|
2881
|
-
|
|
2823
|
+
name?: string;
|
|
2882
2824
|
/**
|
|
2883
2825
|
* This function will be called when the slider changes its value, as it's being dragged.
|
|
2884
2826
|
* The new value will be passed as a parameter when this function is executed.
|
|
@@ -2890,61 +2832,68 @@ type Props$b = {
|
|
|
2890
2832
|
*/
|
|
2891
2833
|
onDragEnd?: (value: number) => void;
|
|
2892
2834
|
/**
|
|
2893
|
-
*
|
|
2894
|
-
* The value will be passed as parameter and the function must return the formatted value.
|
|
2835
|
+
* Whether the input element for displaying/controlling the slider value should be displayed next to the slider.
|
|
2895
2836
|
*/
|
|
2896
|
-
|
|
2837
|
+
showInput?: boolean;
|
|
2897
2838
|
/**
|
|
2898
|
-
*
|
|
2899
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2839
|
+
* Whether the min/max value labels should be displayed next to the slider
|
|
2900
2840
|
*/
|
|
2901
|
-
|
|
2841
|
+
showLimitsValues?: boolean;
|
|
2902
2842
|
/**
|
|
2903
2843
|
* Size of the component.
|
|
2904
2844
|
*/
|
|
2905
2845
|
size?: "medium" | "large" | "fillParent";
|
|
2906
2846
|
/**
|
|
2907
|
-
*
|
|
2847
|
+
* The step interval between values available for selection.
|
|
2908
2848
|
*/
|
|
2909
|
-
|
|
2849
|
+
step?: number;
|
|
2850
|
+
/**
|
|
2851
|
+
* The selected value. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
2852
|
+
*/
|
|
2853
|
+
value?: number;
|
|
2910
2854
|
};
|
|
2911
2855
|
|
|
2912
|
-
declare const DxcSlider: react.ForwardRefExoticComponent<Props$
|
|
2856
|
+
declare const DxcSlider: react.ForwardRefExoticComponent<Props$a & react.RefAttributes<HTMLDivElement>>;
|
|
2913
2857
|
|
|
2914
|
-
type Props$
|
|
2858
|
+
type Props$9 = {
|
|
2915
2859
|
/**
|
|
2916
|
-
*
|
|
2860
|
+
* Specifies a string to be used as the name for the spinner element when no `label` is provided or the `mode` is set to small.
|
|
2917
2861
|
*/
|
|
2918
|
-
|
|
2862
|
+
ariaLabel?: string;
|
|
2919
2863
|
/**
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2864
|
+
* If true, the color is inherited from the closest parent with a defined color. This allows users to adapt the spinner
|
|
2865
|
+
* to the semantic color of the use case in which it is used.
|
|
2922
2866
|
*/
|
|
2923
|
-
|
|
2867
|
+
inheritColor?: boolean;
|
|
2924
2868
|
/**
|
|
2925
|
-
*
|
|
2869
|
+
* Text to be placed inside the spinner.
|
|
2926
2870
|
*/
|
|
2927
|
-
|
|
2871
|
+
label?: string;
|
|
2872
|
+
/**
|
|
2873
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2874
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2875
|
+
*/
|
|
2876
|
+
margin?: Space$1 | Margin;
|
|
2928
2877
|
/**
|
|
2929
2878
|
* Available modes of the spinner.
|
|
2930
2879
|
*/
|
|
2931
2880
|
mode?: "large" | "small" | "overlay";
|
|
2932
2881
|
/**
|
|
2933
|
-
*
|
|
2934
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2882
|
+
* If true, the value is displayed inside the spinner..
|
|
2935
2883
|
*/
|
|
2936
|
-
|
|
2884
|
+
showValue?: boolean;
|
|
2937
2885
|
/**
|
|
2938
|
-
*
|
|
2886
|
+
* The value of the progress indicator. If it's received the
|
|
2887
|
+
* component is determinate, otherwise is indeterminate.
|
|
2939
2888
|
*/
|
|
2940
|
-
|
|
2889
|
+
value?: number;
|
|
2941
2890
|
};
|
|
2942
2891
|
|
|
2943
|
-
declare const DxcSpinner: ({
|
|
2892
|
+
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$9) => react_jsx_runtime.JSX.Element;
|
|
2944
2893
|
|
|
2945
2894
|
type Mode = "default" | "info" | "success" | "warning" | "error";
|
|
2946
2895
|
type Size = "small" | "medium" | "large";
|
|
2947
|
-
type Props$
|
|
2896
|
+
type Props$8 = {
|
|
2948
2897
|
/**
|
|
2949
2898
|
* It will define the color of the light based on its semantic meaning.
|
|
2950
2899
|
*/
|
|
@@ -2959,23 +2908,26 @@ type Props$9 = {
|
|
|
2959
2908
|
size?: Size;
|
|
2960
2909
|
};
|
|
2961
2910
|
|
|
2962
|
-
declare
|
|
2911
|
+
declare function DxcStatusLight({ label, mode, size }: Props$8): react_jsx_runtime.JSX.Element;
|
|
2963
2912
|
|
|
2964
|
-
type Props$
|
|
2913
|
+
type Props$7 = {
|
|
2965
2914
|
/**
|
|
2966
|
-
*
|
|
2915
|
+
* Specifies a string to be used as the name for the switch element when no `label` is provided.
|
|
2967
2916
|
*/
|
|
2968
|
-
|
|
2917
|
+
ariaLabel?: string;
|
|
2969
2918
|
/**
|
|
2970
2919
|
* If true, the component is checked. If undefined, the component will be uncontrolled
|
|
2971
2920
|
* and the checked attribute will be managed internally by the component.
|
|
2972
2921
|
*/
|
|
2973
2922
|
checked?: boolean;
|
|
2974
2923
|
/**
|
|
2975
|
-
*
|
|
2976
|
-
* this value will be only submitted if the switch is checked.
|
|
2924
|
+
* Initial state of the switch, only when it is uncontrolled.
|
|
2977
2925
|
*/
|
|
2978
|
-
|
|
2926
|
+
defaultChecked?: boolean;
|
|
2927
|
+
/**
|
|
2928
|
+
* If true, the component will be disabled.
|
|
2929
|
+
*/
|
|
2930
|
+
disabled?: boolean;
|
|
2979
2931
|
/**
|
|
2980
2932
|
* Text to be placed next to the switch.
|
|
2981
2933
|
*/
|
|
@@ -2985,13 +2937,14 @@ type Props$8 = {
|
|
|
2985
2937
|
*/
|
|
2986
2938
|
labelPosition?: "before" | "after";
|
|
2987
2939
|
/**
|
|
2988
|
-
*
|
|
2940
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2941
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2989
2942
|
*/
|
|
2990
|
-
|
|
2943
|
+
margin?: Space$1 | Margin;
|
|
2991
2944
|
/**
|
|
2992
|
-
*
|
|
2945
|
+
* Name attribute of the input element.
|
|
2993
2946
|
*/
|
|
2994
|
-
|
|
2947
|
+
name?: string;
|
|
2995
2948
|
/**
|
|
2996
2949
|
* This function will be called when the user changes the state of the switch.
|
|
2997
2950
|
* The new value of the checked attribute will be passed as a parameter.
|
|
@@ -3001,11 +2954,6 @@ type Props$8 = {
|
|
|
3001
2954
|
* If true, the component will display '(Optional)' next to the label.
|
|
3002
2955
|
*/
|
|
3003
2956
|
optional?: boolean;
|
|
3004
|
-
/**
|
|
3005
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3006
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3007
|
-
*/
|
|
3008
|
-
margin?: Space$1 | Margin;
|
|
3009
2957
|
/**
|
|
3010
2958
|
* Size of the component.
|
|
3011
2959
|
*/
|
|
@@ -3015,16 +2963,17 @@ type Props$8 = {
|
|
|
3015
2963
|
*/
|
|
3016
2964
|
tabIndex?: number;
|
|
3017
2965
|
/**
|
|
3018
|
-
*
|
|
2966
|
+
* Will be passed to the value attribute of the html input element. When inside a form,
|
|
2967
|
+
* this value will be only submitted if the switch is checked.
|
|
3019
2968
|
*/
|
|
3020
|
-
|
|
2969
|
+
value?: string;
|
|
3021
2970
|
};
|
|
3022
2971
|
|
|
3023
|
-
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$
|
|
2972
|
+
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$7 & react.RefAttributes<HTMLDivElement>>;
|
|
3024
2973
|
|
|
3025
2974
|
declare const DxcTable: {
|
|
3026
|
-
({ children, margin, mode }: Props$
|
|
3027
|
-
ActionsCell: ({ actions }:
|
|
2975
|
+
({ children, margin, mode }: Props$t): react_jsx_runtime.JSX.Element;
|
|
2976
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
3028
2977
|
};
|
|
3029
2978
|
|
|
3030
2979
|
type TabCommonProps = {
|
|
@@ -3041,7 +2990,7 @@ type TabCommonProps = {
|
|
|
3041
2990
|
*/
|
|
3042
2991
|
notificationNumber?: boolean | number;
|
|
3043
2992
|
};
|
|
3044
|
-
type TabLabelProps =
|
|
2993
|
+
type TabLabelProps = {
|
|
3045
2994
|
/**
|
|
3046
2995
|
* Tab label.
|
|
3047
2996
|
*/
|
|
@@ -3051,7 +3000,7 @@ type TabLabelProps = TabCommonProps & {
|
|
|
3051
3000
|
*/
|
|
3052
3001
|
icon?: string | SVG;
|
|
3053
3002
|
};
|
|
3054
|
-
type TabIconProps =
|
|
3003
|
+
type TabIconProps = {
|
|
3055
3004
|
/**
|
|
3056
3005
|
* Tab label.
|
|
3057
3006
|
*/
|
|
@@ -3064,52 +3013,56 @@ type TabIconProps = TabCommonProps & {
|
|
|
3064
3013
|
type TabProps = {
|
|
3065
3014
|
defaultActive?: boolean;
|
|
3066
3015
|
active?: boolean;
|
|
3067
|
-
icon?: string | SVG;
|
|
3068
|
-
label: string;
|
|
3069
3016
|
title?: string;
|
|
3017
|
+
tabId?: string;
|
|
3070
3018
|
disabled?: boolean;
|
|
3071
3019
|
notificationNumber?: boolean | number;
|
|
3072
3020
|
children: ReactNode;
|
|
3073
3021
|
onClick?: () => void;
|
|
3074
3022
|
onHover?: () => void;
|
|
3075
|
-
};
|
|
3023
|
+
} & (TabLabelProps | TabIconProps);
|
|
3076
3024
|
type LegacyProps = {
|
|
3077
3025
|
/**
|
|
3078
|
-
*
|
|
3079
|
-
*/
|
|
3080
|
-
defaultActiveTabIndex?: number;
|
|
3081
|
-
/**
|
|
3026
|
+
* @deprecated This prop is deprecated and will be removed in future versions. Use the children prop instead.
|
|
3082
3027
|
* The index of the active tab. If undefined, the component will be
|
|
3083
3028
|
* uncontrolled and the active tab will be managed internally by the component.
|
|
3084
3029
|
*/
|
|
3085
3030
|
activeTabIndex?: number;
|
|
3086
3031
|
/**
|
|
3087
|
-
*
|
|
3032
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3033
|
+
* Initially active tab, only when it is uncontrolled.
|
|
3088
3034
|
*/
|
|
3089
|
-
|
|
3035
|
+
defaultActiveTabIndex?: number;
|
|
3090
3036
|
/**
|
|
3091
3037
|
* Whether the icon should appear above or to the left of the label.
|
|
3092
3038
|
*/
|
|
3093
3039
|
iconPosition?: "top" | "left";
|
|
3094
3040
|
/**
|
|
3041
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3042
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3043
|
+
*/
|
|
3044
|
+
margin?: Space$1 | Margin;
|
|
3045
|
+
/**
|
|
3046
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3095
3047
|
* This function will be called when the user clicks on a tab. The index of the
|
|
3096
3048
|
* clicked tab will be passed as a parameter.
|
|
3097
3049
|
*/
|
|
3098
3050
|
onTabClick?: (index: number) => void;
|
|
3099
3051
|
/**
|
|
3052
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3100
3053
|
* This function will be called when the user hovers a tab.The index of the
|
|
3101
3054
|
* hovered tab will be passed as a parameter.
|
|
3102
3055
|
*/
|
|
3103
3056
|
onTabHover?: (index: number | null) => void;
|
|
3104
|
-
/**
|
|
3105
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3106
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3107
|
-
*/
|
|
3108
|
-
margin?: Space$1 | Margin;
|
|
3109
3057
|
/**
|
|
3110
3058
|
* Value of the tabindex attribute applied to each tab.
|
|
3111
3059
|
*/
|
|
3112
3060
|
tabIndex?: number;
|
|
3061
|
+
/**
|
|
3062
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3063
|
+
* An array of objects representing the tabs.
|
|
3064
|
+
*/
|
|
3065
|
+
tabs?: (TabCommonProps & (TabLabelProps | TabIconProps))[];
|
|
3113
3066
|
};
|
|
3114
3067
|
type NewProps = {
|
|
3115
3068
|
/**
|
|
@@ -3130,129 +3083,87 @@ type NewProps = {
|
|
|
3130
3083
|
*/
|
|
3131
3084
|
children?: ReactNode;
|
|
3132
3085
|
};
|
|
3133
|
-
type Props$
|
|
3086
|
+
type Props$6 = LegacyProps & NewProps;
|
|
3134
3087
|
|
|
3135
3088
|
declare const DxcTabs: {
|
|
3136
|
-
({
|
|
3089
|
+
({ activeTabIndex, children, defaultActiveTabIndex, iconPosition, margin, onTabClick, onTabHover, tabIndex, tabs, }: Props$6): false | react_jsx_runtime.JSX.Element;
|
|
3137
3090
|
Tab: react.ForwardRefExoticComponent<TabProps & react.RefAttributes<HTMLButtonElement>>;
|
|
3138
3091
|
};
|
|
3139
3092
|
|
|
3140
|
-
type TagCommonProps = {
|
|
3141
|
-
/**
|
|
3142
|
-
* If defined, the tag will be displayed as an anchor, using this prop as "href".
|
|
3143
|
-
* Component will show some visual feedback on hover.
|
|
3144
|
-
*/
|
|
3145
|
-
linkHref?: string;
|
|
3146
|
-
/**
|
|
3147
|
-
* If defined, the tag will be displayed as a button. This function will
|
|
3148
|
-
* be called when the user clicks the tag. Component will show some
|
|
3149
|
-
* visual feedback on hover.
|
|
3150
|
-
*/
|
|
3151
|
-
onClick?: () => void;
|
|
3152
|
-
/**
|
|
3153
|
-
* Background color of the icon section of the tag.
|
|
3154
|
-
*/
|
|
3155
|
-
iconBgColor?: string;
|
|
3156
|
-
/**
|
|
3157
|
-
* Whether the label should appear after or before the icon.
|
|
3158
|
-
*/
|
|
3159
|
-
labelPosition?: "before" | "after";
|
|
3160
|
-
/**
|
|
3161
|
-
* If true, the page is opened in a new browser tab.
|
|
3162
|
-
*/
|
|
3163
|
-
newWindow?: boolean;
|
|
3164
|
-
/**
|
|
3165
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3166
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3167
|
-
*/
|
|
3168
|
-
margin?: Space$1 | Margin;
|
|
3169
|
-
/**
|
|
3170
|
-
* Size of the component.
|
|
3171
|
-
*/
|
|
3172
|
-
size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
3173
|
-
/**
|
|
3174
|
-
* Value of the tabindex attribute.
|
|
3175
|
-
*/
|
|
3176
|
-
tabIndex?: number;
|
|
3177
|
-
};
|
|
3178
|
-
type TagLabelProps = TagCommonProps & {
|
|
3179
|
-
/**
|
|
3180
|
-
* Material Symbol name or SVG element used as the icon that will be placed next to the label.
|
|
3181
|
-
*/
|
|
3182
|
-
icon?: string | SVG;
|
|
3183
|
-
/**
|
|
3184
|
-
* Text to be placed next inside the tag.
|
|
3185
|
-
*/
|
|
3186
|
-
label: string;
|
|
3187
|
-
};
|
|
3188
|
-
type TagIconProps = TagCommonProps & {
|
|
3189
|
-
/**
|
|
3190
|
-
* Material Symbol name or SVG element used as the icon that will be placed next to the label.
|
|
3191
|
-
*/
|
|
3192
|
-
icon: string | SVG;
|
|
3193
|
-
/**
|
|
3194
|
-
* Text to be placed next inside the tag.
|
|
3195
|
-
*/
|
|
3196
|
-
label?: string;
|
|
3197
|
-
};
|
|
3198
|
-
type Props$6 = TagLabelProps | TagIconProps;
|
|
3199
|
-
|
|
3200
|
-
/**
|
|
3201
|
-
* @deprecated
|
|
3202
|
-
*/
|
|
3203
|
-
declare const DxcTag: ({ icon, label, linkHref, onClick, iconBgColor, labelPosition, newWindow, margin, size, tabIndex, }: Props$6) => JSX.Element;
|
|
3204
|
-
|
|
3205
3093
|
type Props$5 = {
|
|
3206
3094
|
/**
|
|
3207
|
-
*
|
|
3095
|
+
* Specifies a string to be used as the name for the textarea element when no `label` is provided.
|
|
3208
3096
|
*/
|
|
3209
|
-
|
|
3097
|
+
ariaLabel?: string;
|
|
3210
3098
|
/**
|
|
3211
|
-
*
|
|
3099
|
+
* HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
|
|
3100
|
+
* Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
|
|
3212
3101
|
*/
|
|
3213
|
-
|
|
3102
|
+
autocomplete?: string;
|
|
3103
|
+
/**
|
|
3104
|
+
* If true, the component will be disabled.
|
|
3105
|
+
*/
|
|
3106
|
+
disabled?: boolean;
|
|
3214
3107
|
/**
|
|
3215
3108
|
* Initial value of the textarea, only when it is uncontrolled.
|
|
3216
3109
|
*/
|
|
3217
3110
|
defaultValue?: string;
|
|
3218
3111
|
/**
|
|
3219
|
-
*
|
|
3112
|
+
* If it is a defined value and also a truthy string, the component will
|
|
3113
|
+
* change its appearance, showing the error below the textarea. If the
|
|
3114
|
+
* defined value is an empty string, it will reserve a space below the
|
|
3115
|
+
* component for a future error, but it would not change its look. In
|
|
3116
|
+
* case of being undefined or null, both the appearance and the space for
|
|
3117
|
+
* the error message would not be modified.
|
|
3220
3118
|
*/
|
|
3221
|
-
|
|
3119
|
+
error?: string;
|
|
3222
3120
|
/**
|
|
3223
3121
|
* Helper text to be placed above the textarea.
|
|
3224
3122
|
*/
|
|
3225
3123
|
helperText?: string;
|
|
3226
3124
|
/**
|
|
3227
|
-
* Text to be
|
|
3125
|
+
* Text to be placed above the textarea.
|
|
3228
3126
|
*/
|
|
3229
|
-
|
|
3127
|
+
label?: string;
|
|
3230
3128
|
/**
|
|
3231
|
-
*
|
|
3129
|
+
* Specifies the maximum length allowed by the textarea.
|
|
3130
|
+
* This will be checked both when the textarea loses the
|
|
3131
|
+
* focus and while typing within it. If the string entered does not
|
|
3132
|
+
* comply the maximum length, the onBlur and onChange functions will be called
|
|
3133
|
+
* with the current value and an internal error informing that the value
|
|
3134
|
+
* length does not comply the specified range. If a valid length is
|
|
3135
|
+
* reached, the error parameter of both events will not be defined.
|
|
3232
3136
|
*/
|
|
3233
|
-
|
|
3137
|
+
maxLength?: number;
|
|
3234
3138
|
/**
|
|
3235
|
-
*
|
|
3139
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3140
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3236
3141
|
*/
|
|
3237
|
-
|
|
3142
|
+
margin?: Space$1 | Margin;
|
|
3238
3143
|
/**
|
|
3239
|
-
*
|
|
3240
|
-
*
|
|
3241
|
-
* and
|
|
3242
|
-
*
|
|
3144
|
+
* Specifies the minimum length allowed by the textarea.
|
|
3145
|
+
* This will be checked both when the textarea loses the
|
|
3146
|
+
* focus and while typing within it. If the string entered does not
|
|
3147
|
+
* comply the minimum length, the onBlur and onChange functions will be called
|
|
3148
|
+
* with the current value and an internal error informing that the value
|
|
3149
|
+
* length does not comply the specified range. If a valid length is
|
|
3150
|
+
* reached, the error parameter of both events will not be defined.
|
|
3243
3151
|
*/
|
|
3244
|
-
|
|
3152
|
+
minLength?: number;
|
|
3245
3153
|
/**
|
|
3246
|
-
*
|
|
3247
|
-
* - 'auto': The textarea grows or shrinks automatically in order to fit the content.
|
|
3248
|
-
* - 'manual': The height of the textarea is enabled to be manually modified.
|
|
3249
|
-
* - 'none': The textarea has a fixed height and can't be modified.
|
|
3154
|
+
* Name attribute of the textarea element.
|
|
3250
3155
|
*/
|
|
3251
|
-
|
|
3156
|
+
name?: string;
|
|
3252
3157
|
/**
|
|
3253
|
-
*
|
|
3158
|
+
* This function will be called when the textarea loses the focus. An
|
|
3159
|
+
* object including the textarea value and the error (if the value entered
|
|
3160
|
+
* is not valid) will be passed to this function. If there is no error,
|
|
3161
|
+
* error will not be defined.
|
|
3254
3162
|
*/
|
|
3255
|
-
|
|
3163
|
+
onBlur?: (val: {
|
|
3164
|
+
value: string;
|
|
3165
|
+
error?: string;
|
|
3166
|
+
}) => void;
|
|
3256
3167
|
/**
|
|
3257
3168
|
* This function will be called when the user types within the textarea.
|
|
3258
3169
|
* An object including the current value and the error (if the value
|
|
@@ -3264,24 +3175,12 @@ type Props$5 = {
|
|
|
3264
3175
|
error?: string;
|
|
3265
3176
|
}) => void;
|
|
3266
3177
|
/**
|
|
3267
|
-
*
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3270
|
-
*
|
|
3271
|
-
*/
|
|
3272
|
-
onBlur?: (val: {
|
|
3273
|
-
value: string;
|
|
3274
|
-
error?: string;
|
|
3275
|
-
}) => void;
|
|
3276
|
-
/**
|
|
3277
|
-
* If it is a defined value and also a truthy string, the component will
|
|
3278
|
-
* change its appearance, showing the error below the textarea. If the
|
|
3279
|
-
* defined value is an empty string, it will reserve a space below the
|
|
3280
|
-
* component for a future error, but it would not change its look. In
|
|
3281
|
-
* case of being undefined or null, both the appearance and the space for
|
|
3282
|
-
* the error message would not be modified.
|
|
3178
|
+
* If true, the textarea will be optional, showing '(Optional)'
|
|
3179
|
+
* next to the label. Otherwise, the field will be considered required
|
|
3180
|
+
* and an error will be passed as a parameter to the OnBlur and onChange functions
|
|
3181
|
+
* when it has not been filled.
|
|
3283
3182
|
*/
|
|
3284
|
-
|
|
3183
|
+
optional?: boolean;
|
|
3285
3184
|
/**
|
|
3286
3185
|
* Regular expression that defines the valid format allowed by the
|
|
3287
3186
|
* textarea. This will be checked both when the textarea loses the focus
|
|
@@ -3293,35 +3192,17 @@ type Props$5 = {
|
|
|
3293
3192
|
*/
|
|
3294
3193
|
pattern?: string;
|
|
3295
3194
|
/**
|
|
3296
|
-
*
|
|
3297
|
-
* This will be checked both when the textarea loses the
|
|
3298
|
-
* focus and while typing within it. If the string entered does not
|
|
3299
|
-
* comply the minimum length, the onBlur and onChange functions will be called
|
|
3300
|
-
* with the current value and an internal error informing that the value
|
|
3301
|
-
* length does not comply the specified range. If a valid length is
|
|
3302
|
-
* reached, the error parameter of both events will not be defined.
|
|
3303
|
-
*/
|
|
3304
|
-
minLength?: number;
|
|
3305
|
-
/**
|
|
3306
|
-
* Specifies the maximum length allowed by the textarea.
|
|
3307
|
-
* This will be checked both when the textarea loses the
|
|
3308
|
-
* focus and while typing within it. If the string entered does not
|
|
3309
|
-
* comply the maximum length, the onBlur and onChange functions will be called
|
|
3310
|
-
* with the current value and an internal error informing that the value
|
|
3311
|
-
* length does not comply the specified range. If a valid length is
|
|
3312
|
-
* reached, the error parameter of both events will not be defined.
|
|
3195
|
+
* Text to be put as placeholder of the textarea.
|
|
3313
3196
|
*/
|
|
3314
|
-
|
|
3197
|
+
placeholder?: string;
|
|
3315
3198
|
/**
|
|
3316
|
-
*
|
|
3317
|
-
* Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
|
|
3199
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3318
3200
|
*/
|
|
3319
|
-
|
|
3201
|
+
readOnly?: boolean;
|
|
3320
3202
|
/**
|
|
3321
|
-
*
|
|
3322
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3203
|
+
* Number of rows of the textarea.
|
|
3323
3204
|
*/
|
|
3324
|
-
|
|
3205
|
+
rows?: number;
|
|
3325
3206
|
/**
|
|
3326
3207
|
* Size of the component.
|
|
3327
3208
|
*/
|
|
@@ -3331,9 +3212,16 @@ type Props$5 = {
|
|
|
3331
3212
|
*/
|
|
3332
3213
|
tabIndex?: number;
|
|
3333
3214
|
/**
|
|
3334
|
-
*
|
|
3215
|
+
* Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
|
|
3335
3216
|
*/
|
|
3336
|
-
|
|
3217
|
+
value?: string;
|
|
3218
|
+
/**
|
|
3219
|
+
* Defines the textarea's ability to resize vertically. It can be:
|
|
3220
|
+
* - 'auto': The textarea grows or shrinks automatically in order to fit the content.
|
|
3221
|
+
* - 'manual': The height of the textarea is enabled to be manually modified.
|
|
3222
|
+
* - 'none': The textarea has a fixed height and can't be modified.
|
|
3223
|
+
*/
|
|
3224
|
+
verticalGrow?: "auto" | "manual" | "none";
|
|
3337
3225
|
};
|
|
3338
3226
|
|
|
3339
3227
|
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$5 & react.RefAttributes<HTMLDivElement>>;
|
|
@@ -3547,28 +3435,28 @@ type SemanticToast = CommonProps$1 & {
|
|
|
3547
3435
|
hideSemanticIcon?: boolean;
|
|
3548
3436
|
};
|
|
3549
3437
|
type ToastsQueuePropsType = {
|
|
3438
|
+
/**
|
|
3439
|
+
* Tree of components from which the useToast hook can be triggered.
|
|
3440
|
+
*/
|
|
3441
|
+
children: ReactNode;
|
|
3550
3442
|
/**
|
|
3551
3443
|
* Duration in milliseconds before a toast automatically hides itself.
|
|
3552
3444
|
* The range goes from 3000ms to 5000ms, any other value will not be taken into consideration.
|
|
3553
3445
|
*/
|
|
3554
3446
|
duration?: number;
|
|
3555
|
-
/**
|
|
3556
|
-
* Tree of components from which the useToast hook can be triggered.
|
|
3557
|
-
*/
|
|
3558
|
-
children: ReactNode;
|
|
3559
3447
|
};
|
|
3560
3448
|
|
|
3561
|
-
declare
|
|
3449
|
+
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType): react_jsx_runtime.JSX.Element;
|
|
3562
3450
|
|
|
3563
3451
|
type OptionIcon = {
|
|
3564
|
-
/**
|
|
3565
|
-
* String with the option display value.
|
|
3566
|
-
*/
|
|
3567
|
-
label?: never;
|
|
3568
3452
|
/**
|
|
3569
3453
|
* Material Symbols icon or SVG element. Icon and label can't be used at same time.
|
|
3570
3454
|
*/
|
|
3571
3455
|
icon: string | SVG;
|
|
3456
|
+
/**
|
|
3457
|
+
* String with the option display value.
|
|
3458
|
+
*/
|
|
3459
|
+
label?: never;
|
|
3572
3460
|
/**
|
|
3573
3461
|
* Value for the HTML properties title and aria-label.
|
|
3574
3462
|
* When a label is defined, this prop can not be use.
|
|
@@ -3576,14 +3464,14 @@ type OptionIcon = {
|
|
|
3576
3464
|
title: string;
|
|
3577
3465
|
};
|
|
3578
3466
|
type OptionLabel = {
|
|
3579
|
-
/**
|
|
3580
|
-
* String with the option display value.
|
|
3581
|
-
*/
|
|
3582
|
-
label: string;
|
|
3583
3467
|
/**
|
|
3584
3468
|
* Material Symbols icon or SVG element. Icon and label can't be used at same time.
|
|
3585
3469
|
*/
|
|
3586
3470
|
icon?: string | SVG;
|
|
3471
|
+
/**
|
|
3472
|
+
* String with the option display value.
|
|
3473
|
+
*/
|
|
3474
|
+
label: string;
|
|
3587
3475
|
/**
|
|
3588
3476
|
* Value for the HTML properties title and aria-label.
|
|
3589
3477
|
* When a label is defined, this prop can not be use.
|
|
@@ -3591,6 +3479,10 @@ type OptionLabel = {
|
|
|
3591
3479
|
title?: never;
|
|
3592
3480
|
};
|
|
3593
3481
|
type Option = {
|
|
3482
|
+
/**
|
|
3483
|
+
* If true, the option will be disabled.
|
|
3484
|
+
*/
|
|
3485
|
+
disabled?: boolean;
|
|
3594
3486
|
/**
|
|
3595
3487
|
* Number with the option inner value.
|
|
3596
3488
|
*/
|
|
@@ -3598,88 +3490,80 @@ type Option = {
|
|
|
3598
3490
|
} & (OptionIcon | OptionLabel);
|
|
3599
3491
|
type CommonProps = {
|
|
3600
3492
|
/**
|
|
3601
|
-
*
|
|
3602
|
-
|
|
3603
|
-
label?: string;
|
|
3604
|
-
/**
|
|
3605
|
-
* Helper text to be placed above the component.
|
|
3606
|
-
*/
|
|
3607
|
-
helperText?: string;
|
|
3608
|
-
/**
|
|
3609
|
-
* If true, the component will be disabled.
|
|
3493
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3494
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3610
3495
|
*/
|
|
3611
|
-
|
|
3496
|
+
margin?: Space$1 | Margin;
|
|
3612
3497
|
/**
|
|
3613
3498
|
* An array of objects representing the selectable options.
|
|
3614
3499
|
*/
|
|
3615
3500
|
options: Option[];
|
|
3616
3501
|
/**
|
|
3617
|
-
*
|
|
3618
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3502
|
+
* The orientation of the toggle group.
|
|
3619
3503
|
*/
|
|
3620
|
-
|
|
3504
|
+
orientation?: "horizontal" | "vertical";
|
|
3621
3505
|
/**
|
|
3622
3506
|
* Value of the tabindex.
|
|
3623
3507
|
*/
|
|
3624
3508
|
tabIndex?: number;
|
|
3625
3509
|
};
|
|
3626
|
-
type
|
|
3510
|
+
type MultipleSelectionToggleGroup = {
|
|
3511
|
+
/**
|
|
3512
|
+
* The array of keys with the initially selected values.
|
|
3513
|
+
*/
|
|
3514
|
+
defaultValue?: number[];
|
|
3627
3515
|
/**
|
|
3628
3516
|
* If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
|
|
3629
3517
|
*/
|
|
3630
|
-
multiple
|
|
3518
|
+
multiple: true;
|
|
3631
3519
|
/**
|
|
3632
|
-
*
|
|
3520
|
+
* This function will be called every time the selection changes. An array with the key of
|
|
3521
|
+
* the selected values will be passed as a parameter to this function.
|
|
3633
3522
|
*/
|
|
3634
|
-
|
|
3523
|
+
onChange?: (optionIndex: number[]) => void;
|
|
3635
3524
|
/**
|
|
3636
|
-
*
|
|
3525
|
+
* An array with the keys of the selected values.
|
|
3637
3526
|
* If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3638
3527
|
*/
|
|
3639
|
-
value?: number;
|
|
3528
|
+
value?: number[];
|
|
3529
|
+
};
|
|
3530
|
+
type SingleSelectionToggleGroup = {
|
|
3640
3531
|
/**
|
|
3641
|
-
*
|
|
3642
|
-
* value will be passed as a parameter to this function.
|
|
3532
|
+
* The key of the initially selected value.
|
|
3643
3533
|
*/
|
|
3644
|
-
|
|
3645
|
-
};
|
|
3646
|
-
type MultipleSelectionToggleGroup = CommonProps & {
|
|
3534
|
+
defaultValue?: number;
|
|
3647
3535
|
/**
|
|
3648
3536
|
* If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
|
|
3649
3537
|
*/
|
|
3650
|
-
multiple
|
|
3538
|
+
multiple?: false;
|
|
3651
3539
|
/**
|
|
3652
|
-
*
|
|
3540
|
+
* This function will be called every time the selection changes. The number with the key of the selected
|
|
3541
|
+
* value will be passed as a parameter to this function.
|
|
3653
3542
|
*/
|
|
3654
|
-
|
|
3543
|
+
onChange?: (optionIndex: number) => void;
|
|
3655
3544
|
/**
|
|
3656
|
-
*
|
|
3545
|
+
* The key of the selected value. If the component allows multiple selection, value must be an array.
|
|
3657
3546
|
* If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3658
3547
|
*/
|
|
3659
|
-
value?: number
|
|
3660
|
-
/**
|
|
3661
|
-
* This function will be called every time the selection changes. An array with the key of
|
|
3662
|
-
* the selected values will be passed as a parameter to this function.
|
|
3663
|
-
*/
|
|
3664
|
-
onChange?: (optionIndex: number[]) => void;
|
|
3548
|
+
value?: number;
|
|
3665
3549
|
};
|
|
3666
|
-
type Props$3 =
|
|
3550
|
+
type Props$3 = CommonProps & (MultipleSelectionToggleGroup | SingleSelectionToggleGroup);
|
|
3667
3551
|
|
|
3668
|
-
declare
|
|
3552
|
+
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3): react_jsx_runtime.JSX.Element;
|
|
3669
3553
|
|
|
3670
3554
|
type Props$2 = {
|
|
3671
3555
|
/**
|
|
3672
|
-
*
|
|
3556
|
+
* Content in which the Tooltip will be displayed.
|
|
3673
3557
|
*/
|
|
3674
|
-
|
|
3558
|
+
children: ReactNode;
|
|
3675
3559
|
/**
|
|
3676
3560
|
* Text to be displayed inside the tooltip.
|
|
3677
3561
|
*/
|
|
3678
3562
|
label?: string;
|
|
3679
3563
|
/**
|
|
3680
|
-
*
|
|
3564
|
+
* Preferred position for displaying the tooltip. It may adjust automatically based on available space.
|
|
3681
3565
|
*/
|
|
3682
|
-
|
|
3566
|
+
position?: "bottom" | "top" | "left" | "right";
|
|
3683
3567
|
};
|
|
3684
3568
|
|
|
3685
3569
|
declare function DxcTooltip(props: Props$2): react_jsx_runtime.JSX.Element;
|
|
@@ -3758,7 +3642,7 @@ type Props = {
|
|
|
3758
3642
|
tabIndex?: number;
|
|
3759
3643
|
};
|
|
3760
3644
|
|
|
3761
|
-
declare
|
|
3645
|
+
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props): react_jsx_runtime.JSX.Element;
|
|
3762
3646
|
|
|
3763
3647
|
declare const componentTokens: {
|
|
3764
3648
|
accordion: {
|
|
@@ -4804,23 +4688,6 @@ declare const componentTokens: {
|
|
|
4804
4688
|
focusOutline: string;
|
|
4805
4689
|
scrollButtonsWidth: string;
|
|
4806
4690
|
};
|
|
4807
|
-
tag: {
|
|
4808
|
-
fontFamily: string;
|
|
4809
|
-
fontColor: string;
|
|
4810
|
-
fontSize: string;
|
|
4811
|
-
fontStyle: string;
|
|
4812
|
-
fontWeight: string;
|
|
4813
|
-
labelPaddingTop: string;
|
|
4814
|
-
labelPaddingBottom: string;
|
|
4815
|
-
labelPaddingLeft: string;
|
|
4816
|
-
labelPaddingRight: string;
|
|
4817
|
-
height: string;
|
|
4818
|
-
iconColor: string;
|
|
4819
|
-
iconSectionWidth: string;
|
|
4820
|
-
iconHeight: string;
|
|
4821
|
-
iconWidth: string;
|
|
4822
|
-
focusColor: string;
|
|
4823
|
-
};
|
|
4824
4691
|
textarea: {
|
|
4825
4692
|
fontFamily: string;
|
|
4826
4693
|
enabledBorderColor: string;
|
|
@@ -5168,10 +5035,6 @@ type OpinionatedTheme = {
|
|
|
5168
5035
|
tabs: {
|
|
5169
5036
|
baseColor: string;
|
|
5170
5037
|
};
|
|
5171
|
-
tag: {
|
|
5172
|
-
fontColor: string;
|
|
5173
|
-
iconColor: string;
|
|
5174
|
-
};
|
|
5175
5038
|
textarea: {
|
|
5176
5039
|
fontColor: string;
|
|
5177
5040
|
hoverBorderColor: string;
|
|
@@ -5262,9 +5125,10 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
5262
5125
|
optionalItemLabelDefault: string;
|
|
5263
5126
|
};
|
|
5264
5127
|
select: {
|
|
5265
|
-
noMatchesErrorMessage: string;
|
|
5266
5128
|
actionClearSelectionTitle: string;
|
|
5267
5129
|
actionClearSearchTitle: string;
|
|
5130
|
+
noMatchesErrorMessage: string;
|
|
5131
|
+
selectAllLabel: string;
|
|
5268
5132
|
};
|
|
5269
5133
|
tabs: {
|
|
5270
5134
|
scrollLeft: string;
|
|
@@ -6332,23 +6196,6 @@ declare const HalstackContext: react.Context<{
|
|
|
6332
6196
|
focusOutline: string;
|
|
6333
6197
|
scrollButtonsWidth: string;
|
|
6334
6198
|
};
|
|
6335
|
-
tag: {
|
|
6336
|
-
fontFamily: string;
|
|
6337
|
-
fontColor: string;
|
|
6338
|
-
fontSize: string;
|
|
6339
|
-
fontStyle: string;
|
|
6340
|
-
fontWeight: string;
|
|
6341
|
-
labelPaddingTop: string;
|
|
6342
|
-
labelPaddingBottom: string;
|
|
6343
|
-
labelPaddingLeft: string;
|
|
6344
|
-
labelPaddingRight: string;
|
|
6345
|
-
height: string;
|
|
6346
|
-
iconColor: string;
|
|
6347
|
-
iconSectionWidth: string;
|
|
6348
|
-
iconHeight: string;
|
|
6349
|
-
iconWidth: string;
|
|
6350
|
-
focusColor: string;
|
|
6351
|
-
};
|
|
6352
6199
|
textarea: {
|
|
6353
6200
|
fontFamily: string;
|
|
6354
6201
|
enabledBorderColor: string;
|
|
@@ -6634,9 +6481,10 @@ declare const HalstackLanguageContext: react.Context<{
|
|
|
6634
6481
|
optionalItemLabelDefault: string;
|
|
6635
6482
|
};
|
|
6636
6483
|
select: {
|
|
6637
|
-
noMatchesErrorMessage: string;
|
|
6638
6484
|
actionClearSelectionTitle: string;
|
|
6639
6485
|
actionClearSearchTitle: string;
|
|
6486
|
+
noMatchesErrorMessage: string;
|
|
6487
|
+
selectAllLabel: string;
|
|
6640
6488
|
};
|
|
6641
6489
|
tabs: {
|
|
6642
6490
|
scrollLeft: string;
|
|
@@ -6659,7 +6507,7 @@ type HalstackProviderPropsType = {
|
|
|
6659
6507
|
};
|
|
6660
6508
|
declare const HalstackProvider: ({ theme, advancedTheme, labels, children }: HalstackProviderPropsType) => JSX.Element;
|
|
6661
6509
|
|
|
6662
|
-
declare
|
|
6510
|
+
declare function useToast(): {
|
|
6663
6511
|
default: (toast: DefaultToast) => (() => void) | undefined;
|
|
6664
6512
|
success: (toast: SemanticToast) => (() => void) | undefined;
|
|
6665
6513
|
warning: (toast: SemanticToast) => (() => void) | undefined;
|
|
@@ -6667,4 +6515,4 @@ declare const useToast: () => {
|
|
|
6667
6515
|
loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
|
|
6668
6516
|
};
|
|
6669
6517
|
|
|
6670
|
-
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcBadge,
|
|
6518
|
+
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcBadge, DxcBleed, DxcBreadcrumbs, DxcBulletedList, DxcButton, DxcCard, DxcCheckbox, DxcChip, DxcContainer, DxcContextualMenu, DxcDataGrid, DxcDateInput, DxcDialog, DxcDivider, DxcDropdown, DxcFileInput, DxcFlex, DxcGrid, DxcHeading, DxcImage, DxcInset, DxcLink, DxcNavTabs, DxcNumberInput, DxcPaginator, DxcParagraph, DxcPasswordInput, DxcProgressBar, DxcQuickNav, DxcRadioGroup, DxcResultsetTable, DxcSelect, DxcSlider, DxcSpinner, DxcStatusLight, DxcSwitch, DxcTable, DxcTabs, DxcTextInput, DxcTextarea, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackContext, HalstackLanguageContext, HalstackProvider, useToast };
|