@dxc-technology/halstack-react 16.1.0 → 17.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.d.mts +449 -196
- package/dist/index.d.ts +449 -196
- package/dist/index.js +4124 -2500
- package/dist/index.mjs +4002 -2380
- package/package.json +6 -5
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
2
|
import { ReactNode, SVGProps, ReactElement, ReactEventHandler } from 'react';
|
|
3
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
3
|
import { SortColumn } from 'react-data-grid';
|
|
5
4
|
import * as _emotion_styled from '@emotion/styled';
|
|
6
5
|
import * as _emotion_react from '@emotion/react';
|
|
@@ -59,7 +58,7 @@ type AccordionItemProps = {
|
|
|
59
58
|
*/
|
|
60
59
|
tabIndex?: number;
|
|
61
60
|
};
|
|
62
|
-
type CommonProps$
|
|
61
|
+
type CommonProps$a = {
|
|
63
62
|
/**
|
|
64
63
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
65
64
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
@@ -70,7 +69,7 @@ type CommonProps$9 = {
|
|
|
70
69
|
*/
|
|
71
70
|
children: ReactElement<AccordionItemProps>[] | ReactElement<AccordionItemProps>;
|
|
72
71
|
};
|
|
73
|
-
type IndependentProps = CommonProps$
|
|
72
|
+
type IndependentProps = CommonProps$a & {
|
|
74
73
|
/**
|
|
75
74
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
76
75
|
*/
|
|
@@ -91,7 +90,7 @@ type IndependentProps = CommonProps$9 & {
|
|
|
91
90
|
*/
|
|
92
91
|
onActiveChange?: (index: number) => void;
|
|
93
92
|
};
|
|
94
|
-
type NonIndependentProps = CommonProps$
|
|
93
|
+
type NonIndependentProps = CommonProps$a & {
|
|
95
94
|
/**
|
|
96
95
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
97
96
|
*/
|
|
@@ -112,10 +111,10 @@ type NonIndependentProps = CommonProps$9 & {
|
|
|
112
111
|
*/
|
|
113
112
|
onActiveChange?: (index: number[]) => void;
|
|
114
113
|
};
|
|
115
|
-
type Props$
|
|
114
|
+
type Props$L = IndependentProps | NonIndependentProps;
|
|
116
115
|
|
|
117
116
|
declare const DxcAccordion: {
|
|
118
|
-
(props: Props$
|
|
117
|
+
(props: Props$L): JSX.Element;
|
|
119
118
|
AccordionItem: ({ label, subLabel, badge, statusLight, icon, assistiveText, disabled, children, tabIndex, }: AccordionItemProps) => JSX.Element;
|
|
120
119
|
};
|
|
121
120
|
|
|
@@ -145,7 +144,7 @@ type Message = {
|
|
|
145
144
|
*/
|
|
146
145
|
text: ReactNode;
|
|
147
146
|
};
|
|
148
|
-
type CommonProps$
|
|
147
|
+
type CommonProps$9 = {
|
|
149
148
|
/**
|
|
150
149
|
* If true, the alert will have a close button that will remove the message from the alert,
|
|
151
150
|
* only in banner and inline modes. The rest of the functionality will depend
|
|
@@ -198,9 +197,40 @@ type ModeSpecificProps = {
|
|
|
198
197
|
*/
|
|
199
198
|
mode: "modal";
|
|
200
199
|
};
|
|
201
|
-
type Props$
|
|
200
|
+
type Props$K = CommonProps$9 & ModeSpecificProps;
|
|
202
201
|
|
|
203
|
-
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$
|
|
202
|
+
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$K) => react.JSX.Element;
|
|
203
|
+
|
|
204
|
+
type SearchBarProps = {
|
|
205
|
+
/**
|
|
206
|
+
* If true, the search bar input will be focused when rendered.
|
|
207
|
+
*/
|
|
208
|
+
autoFocus?: boolean;
|
|
209
|
+
/**
|
|
210
|
+
* If true, the component will be disabled.
|
|
211
|
+
*/
|
|
212
|
+
disabled?: boolean;
|
|
213
|
+
/**
|
|
214
|
+
* Function invoked when the search bar loses focus.
|
|
215
|
+
*/
|
|
216
|
+
onBlur?: (value: string) => void;
|
|
217
|
+
/**
|
|
218
|
+
* Function invoked when the user cancels the search.
|
|
219
|
+
*/
|
|
220
|
+
onCancel?: () => void;
|
|
221
|
+
/**
|
|
222
|
+
* Function invoked when the user changes the input value.
|
|
223
|
+
*/
|
|
224
|
+
onChange?: (value: string) => void;
|
|
225
|
+
/**
|
|
226
|
+
* Function invoked when the Enter key is pressed.
|
|
227
|
+
*/
|
|
228
|
+
onEnter?: (value: string) => void;
|
|
229
|
+
/**
|
|
230
|
+
* Placeholder text displayed in the search bar input field.
|
|
231
|
+
*/
|
|
232
|
+
placeholder?: string;
|
|
233
|
+
};
|
|
204
234
|
|
|
205
235
|
type CommonItemProps = {
|
|
206
236
|
badge?: ReactElement;
|
|
@@ -217,12 +247,13 @@ type Item$1 = CommonItemProps & {
|
|
|
217
247
|
};
|
|
218
248
|
type GroupItem$1 = CommonItemProps & {
|
|
219
249
|
items: (Item$1 | GroupItem$1)[];
|
|
250
|
+
defaultOpen?: boolean;
|
|
220
251
|
};
|
|
221
252
|
type Section$1 = {
|
|
222
253
|
items: (Item$1 | GroupItem$1)[];
|
|
223
254
|
title?: string;
|
|
224
255
|
};
|
|
225
|
-
type Props$
|
|
256
|
+
type Props$J = {
|
|
226
257
|
/**
|
|
227
258
|
* Array of items to be displayed in the menu.
|
|
228
259
|
* Each item can be a single/simple item, a group item or a section.
|
|
@@ -254,7 +285,8 @@ type Section = {
|
|
|
254
285
|
items: (Item$1 | GroupItem$1)[];
|
|
255
286
|
title?: string;
|
|
256
287
|
};
|
|
257
|
-
type
|
|
288
|
+
type SearchbarSidenavProps = Omit<SearchBarProps, "autoFocus" | "disabled" | "onCancel">;
|
|
289
|
+
type Props$I = {
|
|
258
290
|
/**
|
|
259
291
|
* The content rendered in the bottom part of the sidenav, under the navigation menu.
|
|
260
292
|
*/
|
|
@@ -285,6 +317,10 @@ type Props$H = {
|
|
|
285
317
|
* Function called when the expansion state of the sidenav changes.
|
|
286
318
|
*/
|
|
287
319
|
onExpandedChange?: (value: boolean) => void;
|
|
320
|
+
/**
|
|
321
|
+
* When provided, a search bar will be rendered at the top of the sidenav.
|
|
322
|
+
*/
|
|
323
|
+
searchBar?: SearchbarSidenavProps;
|
|
288
324
|
/**
|
|
289
325
|
* The additional content rendered in the upper part of the sidenav, under the branding.
|
|
290
326
|
*/
|
|
@@ -295,10 +331,12 @@ type GroupItem = CommonItemProps & {
|
|
|
295
331
|
items: Item$1[];
|
|
296
332
|
};
|
|
297
333
|
type MainNavPropsType = (GroupItem | Item$1)[];
|
|
298
|
-
type
|
|
334
|
+
type SearchBarHeaderProps = Omit<SearchBarProps, "autoFocus" | "disabled">;
|
|
335
|
+
type Props$H = {
|
|
299
336
|
appTitle?: string;
|
|
300
337
|
navItems?: MainNavPropsType;
|
|
301
338
|
responsiveBottomContent?: ReactNode;
|
|
339
|
+
searchBar?: SearchBarHeaderProps;
|
|
302
340
|
sideContent?: ReactNode | ((isResponsive: boolean) => ReactNode);
|
|
303
341
|
};
|
|
304
342
|
|
|
@@ -426,9 +464,9 @@ type ApplicationLayoutPropsType = {
|
|
|
426
464
|
declare const DxcApplicationLayout: {
|
|
427
465
|
({ logo, header, sidenav, footer, children }: ApplicationLayoutPropsType): JSX.Element;
|
|
428
466
|
Footer: ({ bottomLinks, copyright, leftContent, logo, mode, rightContent, socialLinks, tabIndex, }: FooterPropsType) => JSX.Element;
|
|
429
|
-
Header: ({ appTitle, navItems, sideContent,
|
|
467
|
+
Header: ({ appTitle, navItems, responsiveBottomContent, searchBar, sideContent, }: Props$H) => JSX.Element;
|
|
430
468
|
Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
|
|
431
|
-
Sidenav: ({ topContent, bottomContent, navItems, appTitle, displayGroupLines, expanded, defaultExpanded, onExpandedChange, }: Props$
|
|
469
|
+
Sidenav: ({ topContent, bottomContent, navItems, appTitle, displayGroupLines, expanded, defaultExpanded, onExpandedChange, searchBar, }: Props$I) => JSX.Element;
|
|
432
470
|
};
|
|
433
471
|
|
|
434
472
|
type Size$5 = "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
@@ -438,7 +476,7 @@ interface Status {
|
|
|
438
476
|
mode: "default" | "info" | "success" | "warning" | "error";
|
|
439
477
|
position: "top" | "bottom";
|
|
440
478
|
}
|
|
441
|
-
type Props$
|
|
479
|
+
type Props$G = {
|
|
442
480
|
/**
|
|
443
481
|
* Affects the visual style of the avatar. It can be used following semantic purposes or not.
|
|
444
482
|
*/
|
|
@@ -499,7 +537,7 @@ type Props$F = {
|
|
|
499
537
|
title?: string;
|
|
500
538
|
};
|
|
501
539
|
|
|
502
|
-
declare const DxcAvatar: react.MemoExoticComponent<({ color, disabled, icon, imageSrc, label, linkHref, onClick, primaryText, secondaryText, shape, size, status, tabIndex, title, }: Props$
|
|
540
|
+
declare const DxcAvatar: react.MemoExoticComponent<({ color, disabled, icon, imageSrc, label, linkHref, onClick, primaryText, secondaryText, shape, size, status, tabIndex, title, }: Props$G) => react.JSX.Element>;
|
|
503
541
|
|
|
504
542
|
type ContextualProps = {
|
|
505
543
|
/**
|
|
@@ -537,7 +575,7 @@ type NotificationProps = {
|
|
|
537
575
|
*/
|
|
538
576
|
color?: never;
|
|
539
577
|
};
|
|
540
|
-
type CommonProps$
|
|
578
|
+
type CommonProps$8 = {
|
|
541
579
|
/**
|
|
542
580
|
* Text representing advisory information related to the badge. Under the hood, this prop also serves as an accessible label for the component.
|
|
543
581
|
*/
|
|
@@ -551,11 +589,11 @@ type CommonProps$7 = {
|
|
|
551
589
|
*/
|
|
552
590
|
size?: "small" | "medium" | "large";
|
|
553
591
|
};
|
|
554
|
-
type Props$
|
|
592
|
+
type Props$F = (ContextualProps | NotificationProps) & CommonProps$8;
|
|
555
593
|
|
|
556
|
-
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$
|
|
594
|
+
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$F) => JSX.Element;
|
|
557
595
|
|
|
558
|
-
type Props$
|
|
596
|
+
type Props$E = {
|
|
559
597
|
/**
|
|
560
598
|
* Applies the spacing scale to all sides.
|
|
561
599
|
*/
|
|
@@ -590,13 +628,13 @@ type Props$D = {
|
|
|
590
628
|
children: ReactNode;
|
|
591
629
|
};
|
|
592
630
|
|
|
593
|
-
declare const DxcBleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$
|
|
631
|
+
declare const DxcBleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$E) => react.JSX.Element;
|
|
594
632
|
|
|
595
633
|
type Item = {
|
|
596
634
|
href?: string;
|
|
597
635
|
label: string;
|
|
598
636
|
};
|
|
599
|
-
type Props$
|
|
637
|
+
type Props$D = {
|
|
600
638
|
/**
|
|
601
639
|
* Provides a label that describes the type of navigation enabled by
|
|
602
640
|
* the component.
|
|
@@ -628,7 +666,7 @@ type Props$C = {
|
|
|
628
666
|
showRoot?: boolean;
|
|
629
667
|
};
|
|
630
668
|
|
|
631
|
-
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$
|
|
669
|
+
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$D) => react.JSX.Element;
|
|
632
670
|
|
|
633
671
|
type IconProps = {
|
|
634
672
|
/**
|
|
@@ -658,7 +696,7 @@ type OtherProps = {
|
|
|
658
696
|
*/
|
|
659
697
|
children: ReactNode;
|
|
660
698
|
};
|
|
661
|
-
type Props$
|
|
699
|
+
type Props$C = IconProps | OtherProps;
|
|
662
700
|
type BulletedListItemPropsType = {
|
|
663
701
|
/**
|
|
664
702
|
* Text to be shown in the list.
|
|
@@ -667,7 +705,7 @@ type BulletedListItemPropsType = {
|
|
|
667
705
|
};
|
|
668
706
|
|
|
669
707
|
declare const DxcBulletedList: {
|
|
670
|
-
({ children, type, icon }: Props$
|
|
708
|
+
({ children, type, icon }: Props$C): JSX.Element;
|
|
671
709
|
Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
|
|
672
710
|
};
|
|
673
711
|
|
|
@@ -680,7 +718,7 @@ type Size$4 = {
|
|
|
680
718
|
height?: "small" | "medium" | "large";
|
|
681
719
|
width?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
682
720
|
};
|
|
683
|
-
type Props$
|
|
721
|
+
type Props$B = {
|
|
684
722
|
/**
|
|
685
723
|
* Text to be placed in the button.
|
|
686
724
|
*/
|
|
@@ -732,69 +770,167 @@ type Props$A = {
|
|
|
732
770
|
tabIndex?: number;
|
|
733
771
|
};
|
|
734
772
|
|
|
735
|
-
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$
|
|
773
|
+
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$B) => JSX.Element;
|
|
774
|
+
|
|
775
|
+
type Props$A = {
|
|
776
|
+
/**
|
|
777
|
+
* Alternative text description displayed when the specified image is not loaded.
|
|
778
|
+
*
|
|
779
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
780
|
+
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
781
|
+
*/
|
|
782
|
+
alt: string;
|
|
783
|
+
/**
|
|
784
|
+
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
785
|
+
* which is required regardless of the presence of the caption or not.
|
|
786
|
+
*/
|
|
787
|
+
caption?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Sets the rendered height of the image.
|
|
790
|
+
*/
|
|
791
|
+
height?: string;
|
|
792
|
+
/**
|
|
793
|
+
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
794
|
+
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
795
|
+
*/
|
|
796
|
+
lazyLoading?: boolean;
|
|
797
|
+
/**
|
|
798
|
+
* Sets the object-fit CSS property.
|
|
799
|
+
*
|
|
800
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
801
|
+
*/
|
|
802
|
+
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
803
|
+
/**
|
|
804
|
+
* Sets the object-position CSS property.
|
|
805
|
+
*
|
|
806
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
807
|
+
*/
|
|
808
|
+
objectPosition?: string;
|
|
809
|
+
/**
|
|
810
|
+
* This function will be called when the image fails to load.
|
|
811
|
+
*/
|
|
812
|
+
onError?: ReactEventHandler<HTMLImageElement>;
|
|
813
|
+
/**
|
|
814
|
+
* This function will be called when the image is loaded.
|
|
815
|
+
*/
|
|
816
|
+
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
817
|
+
/**
|
|
818
|
+
* One or more strings separated by commas, indicating a set of source sizes.
|
|
819
|
+
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
820
|
+
* then this attribute has no effect.
|
|
821
|
+
*
|
|
822
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
823
|
+
*/
|
|
824
|
+
sizes?: string;
|
|
825
|
+
/**
|
|
826
|
+
* URL of the image. This prop is required and must be valid.
|
|
827
|
+
*/
|
|
828
|
+
src: string;
|
|
829
|
+
/**
|
|
830
|
+
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
831
|
+
*
|
|
832
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
833
|
+
*/
|
|
834
|
+
srcSet?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Sets the rendered width of the image.
|
|
837
|
+
*/
|
|
838
|
+
width?: string;
|
|
839
|
+
};
|
|
736
840
|
|
|
737
841
|
type Size$3 = {
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
left?: Space$1;
|
|
741
|
-
right?: Space$1;
|
|
842
|
+
width?: "fillParent" | "fitContent";
|
|
843
|
+
height?: "fillParent" | "fitContent";
|
|
742
844
|
};
|
|
743
845
|
type Props$z = {
|
|
744
846
|
/**
|
|
745
|
-
*
|
|
746
|
-
* In case of omission, the image container will not appear and
|
|
747
|
-
* the content will occupy its space.
|
|
847
|
+
* Custom content that will be placed inside the component.
|
|
748
848
|
*/
|
|
749
|
-
|
|
849
|
+
children?: ReactNode;
|
|
850
|
+
/**
|
|
851
|
+
* Initial state of the checkbox, only when it is uncontrolled.
|
|
852
|
+
*/
|
|
853
|
+
defaultSelected?: boolean;
|
|
854
|
+
/**
|
|
855
|
+
* Defines the direction of the content inside the card. It can be set to "row" or "column". The default value is "column".
|
|
856
|
+
*/
|
|
857
|
+
direction?: "row" | "column";
|
|
750
858
|
/**
|
|
751
|
-
*
|
|
859
|
+
* Defines the size of the card when it is empty.
|
|
752
860
|
*/
|
|
753
|
-
|
|
861
|
+
emptySize?: {
|
|
862
|
+
width?: string;
|
|
863
|
+
height?: string;
|
|
864
|
+
iconSize?: "small" | "medium" | "large";
|
|
865
|
+
};
|
|
754
866
|
/**
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
* and 'right' properties in order to specify different padding sizes.
|
|
867
|
+
* URL to navigate to when the card is clicked.
|
|
868
|
+
* If href is defined selectable will be ignored and the link will be always considered as an anchor.
|
|
758
869
|
*/
|
|
759
|
-
|
|
870
|
+
href?: string;
|
|
760
871
|
/**
|
|
761
|
-
*
|
|
872
|
+
* Image to be displayed inside the card.
|
|
873
|
+
*/
|
|
874
|
+
image?: Props$A;
|
|
875
|
+
/**
|
|
876
|
+
* Position of the image inside the card. It can be set to "before" or "after" the content.
|
|
762
877
|
*/
|
|
763
878
|
imagePosition?: "before" | "after";
|
|
764
879
|
/**
|
|
765
|
-
* If
|
|
766
|
-
* as "href". Component will show some visual feedback on hover.
|
|
880
|
+
* If true, the card will be displayed as empty state.
|
|
767
881
|
*/
|
|
768
|
-
|
|
882
|
+
isEmpty?: boolean;
|
|
769
883
|
/**
|
|
770
|
-
*
|
|
771
|
-
* will show some visual feedback on hover.
|
|
884
|
+
* If true, a loading state will be displayed inside the card.
|
|
772
885
|
*/
|
|
773
|
-
|
|
886
|
+
isLoading?: boolean;
|
|
774
887
|
/**
|
|
775
|
-
*
|
|
888
|
+
* Defines the size of the loading card when isLoading is true.
|
|
776
889
|
*/
|
|
777
|
-
|
|
890
|
+
loadingSize?: {
|
|
891
|
+
width?: string;
|
|
892
|
+
height?: string;
|
|
893
|
+
};
|
|
778
894
|
/**
|
|
779
|
-
*
|
|
780
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
895
|
+
* Defines the visual style of the card. It can be set to "elevated" or "outlined".
|
|
781
896
|
*/
|
|
782
|
-
|
|
897
|
+
mode?: "elevated" | "outlined";
|
|
783
898
|
/**
|
|
784
|
-
*
|
|
899
|
+
* If true, the link will open in a new window. href must be provided for this to work.
|
|
785
900
|
*/
|
|
786
|
-
|
|
901
|
+
newWindow?: boolean;
|
|
787
902
|
/**
|
|
788
|
-
*
|
|
903
|
+
* Callback function that is called when the card is clicked.
|
|
904
|
+
* It receives a boolean value indicating whether the card is selected or not.
|
|
905
|
+
* selectable must be true for this to work.
|
|
789
906
|
*/
|
|
790
|
-
|
|
907
|
+
onSelectionChange?: (selected: boolean) => void;
|
|
791
908
|
/**
|
|
792
|
-
*
|
|
909
|
+
* Callback function that is called when the card is clicked.
|
|
793
910
|
*/
|
|
794
|
-
|
|
911
|
+
onClick?: (event: React.MouseEvent | React.KeyboardEvent) => void;
|
|
912
|
+
/**
|
|
913
|
+
* If true, the card can be selected. When the card is clicked, the onSelectionChange callback will be called with the new selected state of the card.
|
|
914
|
+
* If href is defined, the card won't be selectable, even if this prop is true.
|
|
915
|
+
*/
|
|
916
|
+
selectable?: boolean;
|
|
917
|
+
/**
|
|
918
|
+
* If true, the card is selected and if defined it will behave as a controlled component.
|
|
919
|
+
*/
|
|
920
|
+
selected?: boolean;
|
|
921
|
+
/**
|
|
922
|
+
* Defines the size of the card. Width and height can be set to "fillParent" or "fitContent".
|
|
923
|
+
* The default value is { width: "fitContent", height: "fitContent" }.
|
|
924
|
+
*/
|
|
925
|
+
size?: Size$3;
|
|
926
|
+
/**
|
|
927
|
+
* Specifies the tab index of the card.
|
|
928
|
+
* The default value is 0.
|
|
929
|
+
*/
|
|
930
|
+
tabIndex?: number;
|
|
795
931
|
};
|
|
796
932
|
|
|
797
|
-
declare const DxcCard:
|
|
933
|
+
declare const DxcCard: react.ForwardRefExoticComponent<Props$z & react.RefAttributes<HTMLAnchorElement>>;
|
|
798
934
|
|
|
799
935
|
type Props$y = {
|
|
800
936
|
/**
|
|
@@ -863,43 +999,80 @@ type Props$y = {
|
|
|
863
999
|
|
|
864
1000
|
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$y & react.RefAttributes<HTMLDivElement>>;
|
|
865
1001
|
|
|
866
|
-
type
|
|
1002
|
+
type ChipAvatarType = {
|
|
1003
|
+
color: Props$G["color"];
|
|
1004
|
+
profileName?: Props$G["label"];
|
|
1005
|
+
imageSrc?: Props$G["imageSrc"];
|
|
1006
|
+
icon?: Props$G["icon"];
|
|
1007
|
+
};
|
|
1008
|
+
type CommonProps$7 = {
|
|
867
1009
|
/**
|
|
868
|
-
*
|
|
1010
|
+
* Function to be called when the chip is clicked or the dismiss action is triggered.
|
|
869
1011
|
*/
|
|
870
|
-
|
|
1012
|
+
onClick?: () => void;
|
|
1013
|
+
/**
|
|
1014
|
+
* Value of the tabindex attribute.
|
|
1015
|
+
*/
|
|
1016
|
+
tabIndex?: number;
|
|
1017
|
+
};
|
|
1018
|
+
type SelectableChipProps = CommonProps$7 & {
|
|
1019
|
+
/**
|
|
1020
|
+
* If true, the component will be disabled.
|
|
1021
|
+
*/
|
|
1022
|
+
disabled?: boolean;
|
|
1023
|
+
/**
|
|
1024
|
+
* The whole chip is an interactive element that allows users to activate or clear options directly within the interface.
|
|
1025
|
+
*/
|
|
1026
|
+
mode?: "selectable";
|
|
1027
|
+
/**
|
|
1028
|
+
* If true, the component will be selected. This property is only applicable when the mode is "selectable".
|
|
1029
|
+
* If undefined, the component manages its own internal state (uncontrolled mode).
|
|
1030
|
+
*/
|
|
1031
|
+
selected?: boolean;
|
|
1032
|
+
} & ({
|
|
1033
|
+
/**
|
|
1034
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
1035
|
+
*/
|
|
1036
|
+
prefix: ChipAvatarType;
|
|
871
1037
|
/**
|
|
872
|
-
*
|
|
1038
|
+
* Text to be placed on the chip. Required when using an avatar prefix.
|
|
873
1039
|
*/
|
|
874
|
-
|
|
1040
|
+
label: string;
|
|
1041
|
+
} | {
|
|
875
1042
|
/**
|
|
876
1043
|
* Element or path used as icon to be placed before the chip label.
|
|
877
1044
|
*/
|
|
878
|
-
|
|
1045
|
+
prefix: string | SVG;
|
|
879
1046
|
/**
|
|
880
|
-
*
|
|
1047
|
+
* Text to be placed on the chip. Optional when using an icon prefix.
|
|
881
1048
|
*/
|
|
882
|
-
|
|
1049
|
+
label?: string;
|
|
1050
|
+
} | {
|
|
1051
|
+
prefix?: undefined;
|
|
883
1052
|
/**
|
|
884
|
-
*
|
|
1053
|
+
* Text to be placed on the chip.
|
|
885
1054
|
*/
|
|
886
|
-
|
|
1055
|
+
label: string;
|
|
1056
|
+
});
|
|
1057
|
+
type DismissibleChipProps = CommonProps$7 & {
|
|
887
1058
|
/**
|
|
888
|
-
*
|
|
1059
|
+
* Dismissible chip is used to represent information generated by user input within an interface.
|
|
889
1060
|
*/
|
|
890
|
-
|
|
1061
|
+
mode: "dismissible";
|
|
891
1062
|
/**
|
|
892
|
-
*
|
|
893
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1063
|
+
* Text to be placed on the chip.
|
|
894
1064
|
*/
|
|
895
|
-
|
|
1065
|
+
label: string;
|
|
896
1066
|
/**
|
|
897
|
-
*
|
|
1067
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
898
1068
|
*/
|
|
899
|
-
|
|
1069
|
+
prefix?: string | SVG | ChipAvatarType;
|
|
1070
|
+
selected?: never;
|
|
1071
|
+
disabled?: never;
|
|
900
1072
|
};
|
|
1073
|
+
type Props$x = SelectableChipProps | DismissibleChipProps;
|
|
901
1074
|
|
|
902
|
-
declare const DxcChip: ({
|
|
1075
|
+
declare const DxcChip: ({ disabled, label, mode, onClick, prefix, selected, tabIndex, }: Props$x) => react.JSX.Element | null;
|
|
903
1076
|
|
|
904
1077
|
type Space = {
|
|
905
1078
|
top?: string;
|
|
@@ -1066,9 +1239,9 @@ type Props$w = {
|
|
|
1066
1239
|
|
|
1067
1240
|
declare const DxcContainer: react.ForwardRefExoticComponent<Props$w & react.RefAttributes<HTMLDivElement>>;
|
|
1068
1241
|
|
|
1069
|
-
type Props$v = Omit<Props$
|
|
1242
|
+
type Props$v = Omit<Props$J, "displayBorder" | "displayGroupLines" | "displayControlsAfter" | "hasPopOver">;
|
|
1070
1243
|
|
|
1071
|
-
declare function DxcContextualMenu({ items }: Props$v):
|
|
1244
|
+
declare function DxcContextualMenu({ items }: Props$v): react.JSX.Element;
|
|
1072
1245
|
|
|
1073
1246
|
type Size$2 = "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
1074
1247
|
type Option$2 = {
|
|
@@ -1406,7 +1579,7 @@ type Props$s = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((Basi
|
|
|
1406
1579
|
|
|
1407
1580
|
declare const DxcDataGrid: {
|
|
1408
1581
|
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$s): JSX.Element;
|
|
1409
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
1582
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react.JSX.Element;
|
|
1410
1583
|
};
|
|
1411
1584
|
|
|
1412
1585
|
type Props$r = {
|
|
@@ -1580,9 +1753,9 @@ type Props$p = {
|
|
|
1580
1753
|
decorative?: boolean;
|
|
1581
1754
|
};
|
|
1582
1755
|
|
|
1583
|
-
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$p):
|
|
1756
|
+
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$p): react.JSX.Element;
|
|
1584
1757
|
|
|
1585
|
-
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$u) =>
|
|
1758
|
+
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$u) => react.JSX.Element;
|
|
1586
1759
|
|
|
1587
1760
|
type FileData = {
|
|
1588
1761
|
/**
|
|
@@ -1786,7 +1959,7 @@ type Props$n = CommonProps$4 & {
|
|
|
1786
1959
|
children: ReactNode;
|
|
1787
1960
|
};
|
|
1788
1961
|
|
|
1789
|
-
declare const DxcFlex: ({ basis, direction, fullHeight, gap, grow, order, shrink, wrap, ...props }: Props$n) =>
|
|
1962
|
+
declare const DxcFlex: ({ basis, direction, fullHeight, gap, grow, order, shrink, wrap, ...props }: Props$n) => react.JSX.Element;
|
|
1790
1963
|
|
|
1791
1964
|
type Gap = string | {
|
|
1792
1965
|
columnGap?: string;
|
|
@@ -1902,7 +2075,7 @@ type Props$m = GridItemProps & {
|
|
|
1902
2075
|
};
|
|
1903
2076
|
|
|
1904
2077
|
declare const DxcGrid: {
|
|
1905
|
-
(props: Props$m):
|
|
2078
|
+
(props: Props$m): react.JSX.Element;
|
|
1906
2079
|
Item: _emotion_styled.StyledComponent<{
|
|
1907
2080
|
theme?: _emotion_react.Theme;
|
|
1908
2081
|
as?: React.ElementType;
|
|
@@ -1935,77 +2108,11 @@ type Props$l = {
|
|
|
1935
2108
|
margin?: Space$1 | Margin;
|
|
1936
2109
|
};
|
|
1937
2110
|
|
|
1938
|
-
declare function DxcHeading({ as, level, margin, text, weight }: Props$l):
|
|
1939
|
-
|
|
1940
|
-
type Props$k = {
|
|
1941
|
-
/**
|
|
1942
|
-
* Alternative text description displayed when the specified image is not loaded.
|
|
1943
|
-
*
|
|
1944
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
1945
|
-
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
1946
|
-
*/
|
|
1947
|
-
alt: string;
|
|
1948
|
-
/**
|
|
1949
|
-
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
1950
|
-
* which is required regardless of the presence of the caption or not.
|
|
1951
|
-
*/
|
|
1952
|
-
caption?: string;
|
|
1953
|
-
/**
|
|
1954
|
-
* Sets the rendered height of the image.
|
|
1955
|
-
*/
|
|
1956
|
-
height?: string;
|
|
1957
|
-
/**
|
|
1958
|
-
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
1959
|
-
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
1960
|
-
*/
|
|
1961
|
-
lazyLoading?: boolean;
|
|
1962
|
-
/**
|
|
1963
|
-
* Sets the object-fit CSS property.
|
|
1964
|
-
*
|
|
1965
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1966
|
-
*/
|
|
1967
|
-
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
1968
|
-
/**
|
|
1969
|
-
* Sets the object-position CSS property.
|
|
1970
|
-
*
|
|
1971
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
1972
|
-
*/
|
|
1973
|
-
objectPosition?: string;
|
|
1974
|
-
/**
|
|
1975
|
-
* This function will be called when the image fails to load.
|
|
1976
|
-
*/
|
|
1977
|
-
onError?: ReactEventHandler<HTMLImageElement>;
|
|
1978
|
-
/**
|
|
1979
|
-
* This function will be called when the image is loaded.
|
|
1980
|
-
*/
|
|
1981
|
-
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
1982
|
-
/**
|
|
1983
|
-
* One or more strings separated by commas, indicating a set of source sizes.
|
|
1984
|
-
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
1985
|
-
* then this attribute has no effect.
|
|
1986
|
-
*
|
|
1987
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
1988
|
-
*/
|
|
1989
|
-
sizes?: string;
|
|
1990
|
-
/**
|
|
1991
|
-
* URL of the image. This prop is required and must be valid.
|
|
1992
|
-
*/
|
|
1993
|
-
src: string;
|
|
1994
|
-
/**
|
|
1995
|
-
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
1996
|
-
*
|
|
1997
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
1998
|
-
*/
|
|
1999
|
-
srcSet?: string;
|
|
2000
|
-
/**
|
|
2001
|
-
* Sets the rendered width of the image.
|
|
2002
|
-
*/
|
|
2003
|
-
width?: string;
|
|
2004
|
-
};
|
|
2111
|
+
declare function DxcHeading({ as, level, margin, text, weight }: Props$l): react.JSX.Element;
|
|
2005
2112
|
|
|
2006
|
-
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$
|
|
2113
|
+
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$A): react.JSX.Element;
|
|
2007
2114
|
|
|
2008
|
-
type Props$
|
|
2115
|
+
type Props$k = {
|
|
2009
2116
|
/**
|
|
2010
2117
|
* Applies the spacing scale to the bottom side.
|
|
2011
2118
|
*/
|
|
@@ -2040,7 +2147,7 @@ type Props$j = {
|
|
|
2040
2147
|
vertical?: string;
|
|
2041
2148
|
};
|
|
2042
2149
|
|
|
2043
|
-
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$
|
|
2150
|
+
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$k): react.JSX.Element;
|
|
2044
2151
|
|
|
2045
2152
|
type LinkProps = {
|
|
2046
2153
|
/**
|
|
@@ -2123,7 +2230,7 @@ type TabProps$1 = {
|
|
|
2123
2230
|
*/
|
|
2124
2231
|
notificationNumber?: boolean | number;
|
|
2125
2232
|
};
|
|
2126
|
-
type Props$
|
|
2233
|
+
type Props$j = {
|
|
2127
2234
|
/**
|
|
2128
2235
|
* Contains one or more DxcNavTabs.Tab.
|
|
2129
2236
|
*/
|
|
@@ -2139,11 +2246,11 @@ type Props$i = {
|
|
|
2139
2246
|
};
|
|
2140
2247
|
|
|
2141
2248
|
declare const DxcNavTabs: {
|
|
2142
|
-
({ iconPosition, tabIndex, children }: Props$
|
|
2249
|
+
({ iconPosition, tabIndex, children }: Props$j): JSX.Element;
|
|
2143
2250
|
Tab: react.ForwardRefExoticComponent<TabProps$1 & react.RefAttributes<HTMLDivElement | HTMLAnchorElement>>;
|
|
2144
2251
|
};
|
|
2145
2252
|
|
|
2146
|
-
type Props$
|
|
2253
|
+
type Props$i = {
|
|
2147
2254
|
/**
|
|
2148
2255
|
* Text to be placed above the number.
|
|
2149
2256
|
*/
|
|
@@ -2270,9 +2377,9 @@ type Props$h = {
|
|
|
2270
2377
|
showControls?: boolean;
|
|
2271
2378
|
};
|
|
2272
2379
|
|
|
2273
|
-
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$
|
|
2380
|
+
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$i & react.RefAttributes<HTMLDivElement>>;
|
|
2274
2381
|
|
|
2275
|
-
type Props$
|
|
2382
|
+
type Props$h = {
|
|
2276
2383
|
/**
|
|
2277
2384
|
* Number of the current selected page.
|
|
2278
2385
|
*/
|
|
@@ -2310,13 +2417,13 @@ type Props$g = {
|
|
|
2310
2417
|
tabIndex?: number;
|
|
2311
2418
|
};
|
|
2312
2419
|
|
|
2313
|
-
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$
|
|
2420
|
+
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$h) => JSX.Element;
|
|
2314
2421
|
|
|
2315
2422
|
declare function DxcParagraph({ children }: {
|
|
2316
2423
|
children: ReactNode;
|
|
2317
|
-
}):
|
|
2424
|
+
}): react.JSX.Element;
|
|
2318
2425
|
|
|
2319
|
-
type Props$
|
|
2426
|
+
type Props$g = {
|
|
2320
2427
|
/**
|
|
2321
2428
|
* Text to be placed above the password input.
|
|
2322
2429
|
*/
|
|
@@ -2420,7 +2527,35 @@ type Props$f = {
|
|
|
2420
2527
|
ariaLabel?: string;
|
|
2421
2528
|
};
|
|
2422
2529
|
|
|
2423
|
-
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$
|
|
2530
|
+
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$g & react.RefAttributes<HTMLDivElement>>;
|
|
2531
|
+
|
|
2532
|
+
type PopoverPropsType = {
|
|
2533
|
+
/** Action that triggers the popover to open. */
|
|
2534
|
+
actionToOpen?: "click" | "hover";
|
|
2535
|
+
/** Alignment of the popover relative to the trigger element. */
|
|
2536
|
+
align?: "start" | "center" | "end";
|
|
2537
|
+
/** Set to true if child controls the events. It will render the child directly without wrapping it. */
|
|
2538
|
+
asChild?: boolean;
|
|
2539
|
+
/** Element that triggers the popover and works as the anchor. */
|
|
2540
|
+
children: React.ReactNode;
|
|
2541
|
+
/** Whether the popover should display a tip (arrow). */
|
|
2542
|
+
hasTip?: boolean;
|
|
2543
|
+
/** Controlled open state of the popover. If it is left undefined, it will be uncontrolled. */
|
|
2544
|
+
isOpen?: boolean;
|
|
2545
|
+
/** Distance in pixels from the trigger element to the popover. */
|
|
2546
|
+
offset?: number;
|
|
2547
|
+
/** Callback function when the popover is opened.
|
|
2548
|
+
* Used only in controlled mode and if the trigger lacks the events to manage the controlled behavior. */
|
|
2549
|
+
onOpen?: () => void;
|
|
2550
|
+
/** Callback function when the popover is closed. */
|
|
2551
|
+
onClose?: () => void;
|
|
2552
|
+
/** Content to be displayed inside the popover. */
|
|
2553
|
+
popoverContent: React.ReactNode;
|
|
2554
|
+
/** Side of the trigger where the popover will appear. */
|
|
2555
|
+
side?: "top" | "bottom" | "left" | "right";
|
|
2556
|
+
};
|
|
2557
|
+
|
|
2558
|
+
declare const DxcPopover: ({ actionToOpen, align, asChild, children, hasTip, isOpen, offset, onOpen, onClose, popoverContent, side, }: PopoverPropsType) => JSX.Element;
|
|
2424
2559
|
|
|
2425
2560
|
type Size$1 = {
|
|
2426
2561
|
top?: Space$1;
|
|
@@ -2428,7 +2563,7 @@ type Size$1 = {
|
|
|
2428
2563
|
left?: Space$1;
|
|
2429
2564
|
right?: Space$1;
|
|
2430
2565
|
};
|
|
2431
|
-
type Props$
|
|
2566
|
+
type Props$f = {
|
|
2432
2567
|
/**
|
|
2433
2568
|
* Text to be placed above the progress bar.
|
|
2434
2569
|
*/
|
|
@@ -2462,7 +2597,7 @@ type Props$e = {
|
|
|
2462
2597
|
ariaLabel?: string;
|
|
2463
2598
|
};
|
|
2464
2599
|
|
|
2465
|
-
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$
|
|
2600
|
+
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$f) => JSX.Element;
|
|
2466
2601
|
|
|
2467
2602
|
type Link = {
|
|
2468
2603
|
/**
|
|
@@ -2474,7 +2609,7 @@ type Link = {
|
|
|
2474
2609
|
*/
|
|
2475
2610
|
links?: Link[];
|
|
2476
2611
|
};
|
|
2477
|
-
type Props$
|
|
2612
|
+
type Props$e = {
|
|
2478
2613
|
/**
|
|
2479
2614
|
* Title of the quick nav component.
|
|
2480
2615
|
*/
|
|
@@ -2485,7 +2620,7 @@ type Props$d = {
|
|
|
2485
2620
|
links: Link[];
|
|
2486
2621
|
};
|
|
2487
2622
|
|
|
2488
|
-
declare function DxcQuickNav({ links, title }: Props$
|
|
2623
|
+
declare function DxcQuickNav({ links, title }: Props$e): react.JSX.Element;
|
|
2489
2624
|
|
|
2490
2625
|
type Option$1 = {
|
|
2491
2626
|
/**
|
|
@@ -2686,11 +2821,11 @@ type NonPaginatedProps = CommonProps$3 & {
|
|
|
2686
2821
|
*/
|
|
2687
2822
|
showGoToPage?: never;
|
|
2688
2823
|
};
|
|
2689
|
-
type Props$
|
|
2824
|
+
type Props$d = PaginatedProps | NonPaginatedProps;
|
|
2690
2825
|
|
|
2691
2826
|
declare const DxcResultsetTable: {
|
|
2692
|
-
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$
|
|
2693
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
2827
|
+
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$d): react.JSX.Element;
|
|
2828
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react.JSX.Element;
|
|
2694
2829
|
};
|
|
2695
2830
|
|
|
2696
2831
|
type ListOptionType = {
|
|
@@ -2881,11 +3016,11 @@ type MultipleSelect = CommonProps$2 & {
|
|
|
2881
3016
|
*/
|
|
2882
3017
|
value?: string[];
|
|
2883
3018
|
};
|
|
2884
|
-
type Props$
|
|
3019
|
+
type Props$c = SingleSelect | MultipleSelect;
|
|
2885
3020
|
|
|
2886
|
-
declare const DxcSelect: react.ForwardRefExoticComponent<Props$
|
|
3021
|
+
declare const DxcSelect: react.ForwardRefExoticComponent<Props$c & react.RefAttributes<HTMLDivElement>>;
|
|
2887
3022
|
|
|
2888
|
-
type Props$
|
|
3023
|
+
type Props$b = {
|
|
2889
3024
|
/**
|
|
2890
3025
|
* Specifies a string to be used as the name for the slider element when no `label` is provided.
|
|
2891
3026
|
*/
|
|
@@ -2964,9 +3099,9 @@ type Props$a = {
|
|
|
2964
3099
|
value?: number;
|
|
2965
3100
|
};
|
|
2966
3101
|
|
|
2967
|
-
declare const DxcSlider: react.ForwardRefExoticComponent<Props$
|
|
3102
|
+
declare const DxcSlider: react.ForwardRefExoticComponent<Props$b & react.RefAttributes<HTMLDivElement>>;
|
|
2968
3103
|
|
|
2969
|
-
type Props$
|
|
3104
|
+
type Props$a = {
|
|
2970
3105
|
/**
|
|
2971
3106
|
* 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.
|
|
2972
3107
|
*/
|
|
@@ -3000,11 +3135,11 @@ type Props$9 = {
|
|
|
3000
3135
|
value?: number;
|
|
3001
3136
|
};
|
|
3002
3137
|
|
|
3003
|
-
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$
|
|
3138
|
+
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$a) => react.JSX.Element;
|
|
3004
3139
|
|
|
3005
3140
|
type Mode = "default" | "info" | "success" | "warning" | "error";
|
|
3006
3141
|
type Size = "small" | "medium" | "large";
|
|
3007
|
-
type Props$
|
|
3142
|
+
type Props$9 = {
|
|
3008
3143
|
/**
|
|
3009
3144
|
* It will define the color of the light based on its semantic meaning.
|
|
3010
3145
|
*/
|
|
@@ -3019,9 +3154,9 @@ type Props$8 = {
|
|
|
3019
3154
|
size?: Size;
|
|
3020
3155
|
};
|
|
3021
3156
|
|
|
3022
|
-
declare function DxcStatusLight({ label, mode, size }: Props$
|
|
3157
|
+
declare function DxcStatusLight({ label, mode, size }: Props$9): react.JSX.Element;
|
|
3023
3158
|
|
|
3024
|
-
type Props$
|
|
3159
|
+
type Props$8 = {
|
|
3025
3160
|
/**
|
|
3026
3161
|
* Specifies a string to be used as the name for the switch element when no `label` is provided.
|
|
3027
3162
|
*/
|
|
@@ -3080,11 +3215,11 @@ type Props$7 = {
|
|
|
3080
3215
|
value?: string;
|
|
3081
3216
|
};
|
|
3082
3217
|
|
|
3083
|
-
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$
|
|
3218
|
+
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$8 & react.RefAttributes<HTMLDivElement>>;
|
|
3084
3219
|
|
|
3085
3220
|
declare const DxcTable: {
|
|
3086
|
-
({ children, margin, mode }: Props$t):
|
|
3087
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
3221
|
+
({ children, margin, mode }: Props$t): react.JSX.Element;
|
|
3222
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react.JSX.Element;
|
|
3088
3223
|
};
|
|
3089
3224
|
|
|
3090
3225
|
type CommonTabProps = {
|
|
@@ -3125,14 +3260,14 @@ type TabsProps = {
|
|
|
3125
3260
|
*/
|
|
3126
3261
|
children?: ReactNode;
|
|
3127
3262
|
};
|
|
3128
|
-
type Props$
|
|
3263
|
+
type Props$7 = TabsProps;
|
|
3129
3264
|
|
|
3130
3265
|
declare const DxcTabs: {
|
|
3131
|
-
({ children, iconPosition, margin, tabIndex }: Props$
|
|
3266
|
+
({ children, iconPosition, margin, tabIndex }: Props$7): react.JSX.Element;
|
|
3132
3267
|
Tab: react.ForwardRefExoticComponent<TabProps & react.RefAttributes<HTMLButtonElement>>;
|
|
3133
3268
|
};
|
|
3134
3269
|
|
|
3135
|
-
type Props$
|
|
3270
|
+
type Props$6 = {
|
|
3136
3271
|
/**
|
|
3137
3272
|
* Specifies a string to be used as the name for the textarea element when no `label` is provided.
|
|
3138
3273
|
*/
|
|
@@ -3266,7 +3401,7 @@ type Props$5 = {
|
|
|
3266
3401
|
verticalGrow?: "auto" | "manual" | "none";
|
|
3267
3402
|
};
|
|
3268
3403
|
|
|
3269
|
-
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$
|
|
3404
|
+
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$6 & react.RefAttributes<HTMLDivElement>>;
|
|
3270
3405
|
|
|
3271
3406
|
type Action$1 = {
|
|
3272
3407
|
/**
|
|
@@ -3284,7 +3419,7 @@ type Action$1 = {
|
|
|
3284
3419
|
*/
|
|
3285
3420
|
title?: string;
|
|
3286
3421
|
};
|
|
3287
|
-
type Props$
|
|
3422
|
+
type Props$5 = {
|
|
3288
3423
|
/**
|
|
3289
3424
|
* Sets the alignment inside the input.
|
|
3290
3425
|
*/
|
|
@@ -3437,7 +3572,96 @@ type Props$4 = {
|
|
|
3437
3572
|
ariaLabel?: string;
|
|
3438
3573
|
};
|
|
3439
3574
|
|
|
3440
|
-
declare const DxcTextInput: react.ForwardRefExoticComponent<Props$
|
|
3575
|
+
declare const DxcTextInput: react.ForwardRefExoticComponent<Props$5 & react.RefAttributes<HTMLDivElement>>;
|
|
3576
|
+
|
|
3577
|
+
type Props$4 = {
|
|
3578
|
+
/**
|
|
3579
|
+
* Specifies a string to be used as the name for the timeInput element when no `label` is provided.
|
|
3580
|
+
*/
|
|
3581
|
+
ariaLabel?: string;
|
|
3582
|
+
/**
|
|
3583
|
+
* If true, the input will have an action to clear the entered value.
|
|
3584
|
+
*/
|
|
3585
|
+
clearable?: boolean;
|
|
3586
|
+
/**
|
|
3587
|
+
* Initial value of the input, only when it is uncontrolled.
|
|
3588
|
+
*/
|
|
3589
|
+
defaultValue?: string;
|
|
3590
|
+
/**
|
|
3591
|
+
* If true, the component will be disabled.
|
|
3592
|
+
*/
|
|
3593
|
+
disabled?: boolean;
|
|
3594
|
+
/**
|
|
3595
|
+
* If it is a defined value and also a truthy string, the component will
|
|
3596
|
+
* change its appearance, showing the error below the input component. If
|
|
3597
|
+
* the defined value is an empty string, it will reserve a space below
|
|
3598
|
+
* the component for a future error, but it would not change its look. In
|
|
3599
|
+
* case of being undefined or null, both the appearance and the space for
|
|
3600
|
+
* the error message would not be modified.
|
|
3601
|
+
*/
|
|
3602
|
+
error?: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* Helper text to be placed above the input.
|
|
3605
|
+
*/
|
|
3606
|
+
helperText?: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* Text to be placed above the input.
|
|
3609
|
+
*/
|
|
3610
|
+
label?: string;
|
|
3611
|
+
/**
|
|
3612
|
+
* Name attribute of the input element.
|
|
3613
|
+
*/
|
|
3614
|
+
name?: string;
|
|
3615
|
+
/**
|
|
3616
|
+
* This function will be called when the input element loses the focus.
|
|
3617
|
+
* An object including the input value and the error (if the value
|
|
3618
|
+
* entered is not valid) will be passed to this function. If there is no error,
|
|
3619
|
+
* error will not be defined.
|
|
3620
|
+
*/
|
|
3621
|
+
onBlur?: (val: {
|
|
3622
|
+
value: string;
|
|
3623
|
+
error?: string;
|
|
3624
|
+
}) => void;
|
|
3625
|
+
/**
|
|
3626
|
+
* This function will be called when the user types within the input
|
|
3627
|
+
* or selects a value in the dropdown element of the component.
|
|
3628
|
+
*/
|
|
3629
|
+
onChange?: (value: string) => void;
|
|
3630
|
+
/**
|
|
3631
|
+
* If true, the input will be optional, showing '(Optional)'
|
|
3632
|
+
* next to the label. Otherwise, the field will be considered required and an error will be
|
|
3633
|
+
* passed as a parameter to the OnBlur function when it has
|
|
3634
|
+
* not been filled.
|
|
3635
|
+
*/
|
|
3636
|
+
optional?: boolean;
|
|
3637
|
+
/**
|
|
3638
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3639
|
+
* In addition, the clear action will not be displayed even if the flag is set to true.
|
|
3640
|
+
*/
|
|
3641
|
+
readOnly?: boolean;
|
|
3642
|
+
/**
|
|
3643
|
+
* If true, the component will display seconds and allow the user to input them. Otherwise, seconds will not be shown and the user will not be able to input them.
|
|
3644
|
+
*/
|
|
3645
|
+
showSeconds?: boolean;
|
|
3646
|
+
/**
|
|
3647
|
+
* Size of the component.
|
|
3648
|
+
*/
|
|
3649
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
3650
|
+
/**
|
|
3651
|
+
* Value of the tabindex attribute.
|
|
3652
|
+
*/
|
|
3653
|
+
tabIndex?: number;
|
|
3654
|
+
/**
|
|
3655
|
+
* Time format of the input. It can be either 12 or 24.
|
|
3656
|
+
*/
|
|
3657
|
+
timeFormat?: "12" | "24";
|
|
3658
|
+
/**
|
|
3659
|
+
* Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3660
|
+
*/
|
|
3661
|
+
value?: string;
|
|
3662
|
+
};
|
|
3663
|
+
|
|
3664
|
+
declare const DxcTimeInput: react.ForwardRefExoticComponent<Props$4 & react.RefAttributes<HTMLDivElement>>;
|
|
3441
3665
|
|
|
3442
3666
|
type Action = {
|
|
3443
3667
|
/**
|
|
@@ -3492,7 +3716,7 @@ type ToastsQueuePropsType = {
|
|
|
3492
3716
|
duration?: number;
|
|
3493
3717
|
};
|
|
3494
3718
|
|
|
3495
|
-
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType):
|
|
3719
|
+
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType): react.JSX.Element;
|
|
3496
3720
|
|
|
3497
3721
|
type OptionIcon = {
|
|
3498
3722
|
/**
|
|
@@ -3595,7 +3819,7 @@ type SingleSelectionToggleGroup = {
|
|
|
3595
3819
|
};
|
|
3596
3820
|
type Props$3 = CommonProps & (MultipleSelectionToggleGroup | SingleSelectionToggleGroup);
|
|
3597
3821
|
|
|
3598
|
-
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3):
|
|
3822
|
+
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3): react.JSX.Element;
|
|
3599
3823
|
|
|
3600
3824
|
type Props$2 = {
|
|
3601
3825
|
/**
|
|
@@ -3612,7 +3836,7 @@ type Props$2 = {
|
|
|
3612
3836
|
position?: "bottom" | "top" | "left" | "right";
|
|
3613
3837
|
};
|
|
3614
3838
|
|
|
3615
|
-
declare const DxcTooltip: (props: Props$2) =>
|
|
3839
|
+
declare const DxcTooltip: (props: Props$2) => react.JSX.Element;
|
|
3616
3840
|
|
|
3617
3841
|
type Props$1 = {
|
|
3618
3842
|
as?: "a" | "blockquote" | "cite" | "code" | "div" | "em" | "figcaption" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "pre" | "small" | "span" | "strong";
|
|
@@ -3631,7 +3855,7 @@ type Props$1 = {
|
|
|
3631
3855
|
whiteSpace?: "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap";
|
|
3632
3856
|
};
|
|
3633
3857
|
|
|
3634
|
-
declare function DxcTypography({ children, ...props }: Props$1):
|
|
3858
|
+
declare function DxcTypography({ children, ...props }: Props$1): react.JSX.Element;
|
|
3635
3859
|
|
|
3636
3860
|
type StepProps = {
|
|
3637
3861
|
/**
|
|
@@ -3688,7 +3912,7 @@ type Props = {
|
|
|
3688
3912
|
tabIndex?: number;
|
|
3689
3913
|
};
|
|
3690
3914
|
|
|
3691
|
-
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props):
|
|
3915
|
+
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props): react.JSX.Element;
|
|
3692
3916
|
|
|
3693
3917
|
declare const defaultTranslatedComponentLabels: {
|
|
3694
3918
|
applicationLayout: {
|
|
@@ -3706,8 +3930,12 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3706
3930
|
previousMonthTitle: string;
|
|
3707
3931
|
nextMonthTitle: string;
|
|
3708
3932
|
};
|
|
3933
|
+
card: {
|
|
3934
|
+
noContent: string;
|
|
3935
|
+
};
|
|
3709
3936
|
dateInput: {
|
|
3710
3937
|
invalidDateErrorMessage: string;
|
|
3938
|
+
datePickerActionTitle: string;
|
|
3711
3939
|
};
|
|
3712
3940
|
dialog: {
|
|
3713
3941
|
closeIconAriaLabel: string;
|
|
@@ -3763,6 +3991,12 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3763
3991
|
radioGroup: {
|
|
3764
3992
|
optionalItemLabelDefault: string;
|
|
3765
3993
|
};
|
|
3994
|
+
searchBar: {
|
|
3995
|
+
clearFieldActionTitle: string;
|
|
3996
|
+
inputAriaLabel: string;
|
|
3997
|
+
triggerTitle: string;
|
|
3998
|
+
cancelButtonLabel: string;
|
|
3999
|
+
};
|
|
3766
4000
|
select: {
|
|
3767
4001
|
actionClearSelectionTitle: string;
|
|
3768
4002
|
actionClearSearchTitle: string;
|
|
@@ -3778,6 +4012,9 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3778
4012
|
searchingMessage: string;
|
|
3779
4013
|
fetchingDataErrorMessage: string;
|
|
3780
4014
|
};
|
|
4015
|
+
timeInput: {
|
|
4016
|
+
timePickerActionTitle: string;
|
|
4017
|
+
};
|
|
3781
4018
|
toast: {
|
|
3782
4019
|
clearToastActionTitle: string;
|
|
3783
4020
|
};
|
|
@@ -3807,8 +4044,12 @@ declare const HalstackLanguageContext: react.Context<{
|
|
|
3807
4044
|
previousMonthTitle: string;
|
|
3808
4045
|
nextMonthTitle: string;
|
|
3809
4046
|
};
|
|
4047
|
+
card: {
|
|
4048
|
+
noContent: string;
|
|
4049
|
+
};
|
|
3810
4050
|
dateInput: {
|
|
3811
4051
|
invalidDateErrorMessage: string;
|
|
4052
|
+
datePickerActionTitle: string;
|
|
3812
4053
|
};
|
|
3813
4054
|
dialog: {
|
|
3814
4055
|
closeIconAriaLabel: string;
|
|
@@ -3864,6 +4105,12 @@ declare const HalstackLanguageContext: react.Context<{
|
|
|
3864
4105
|
radioGroup: {
|
|
3865
4106
|
optionalItemLabelDefault: string;
|
|
3866
4107
|
};
|
|
4108
|
+
searchBar: {
|
|
4109
|
+
clearFieldActionTitle: string;
|
|
4110
|
+
inputAriaLabel: string;
|
|
4111
|
+
triggerTitle: string;
|
|
4112
|
+
cancelButtonLabel: string;
|
|
4113
|
+
};
|
|
3867
4114
|
select: {
|
|
3868
4115
|
actionClearSelectionTitle: string;
|
|
3869
4116
|
actionClearSearchTitle: string;
|
|
@@ -3879,11 +4126,17 @@ declare const HalstackLanguageContext: react.Context<{
|
|
|
3879
4126
|
searchingMessage: string;
|
|
3880
4127
|
fetchingDataErrorMessage: string;
|
|
3881
4128
|
};
|
|
4129
|
+
timeInput: {
|
|
4130
|
+
timePickerActionTitle: string;
|
|
4131
|
+
};
|
|
3882
4132
|
toast: {
|
|
3883
4133
|
clearToastActionTitle: string;
|
|
3884
4134
|
};
|
|
3885
4135
|
}>;
|
|
3886
|
-
type ThemeType =
|
|
4136
|
+
type ThemeType = {
|
|
4137
|
+
tokens?: Record<string, string | number>;
|
|
4138
|
+
logos?: Record<string, string | undefined>;
|
|
4139
|
+
};
|
|
3887
4140
|
type HalstackProviderPropsType = {
|
|
3888
4141
|
labels?: DeepPartial<TranslatedLabels>;
|
|
3889
4142
|
children: ReactNode;
|
|
@@ -3899,4 +4152,4 @@ declare function useToast(): {
|
|
|
3899
4152
|
loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
|
|
3900
4153
|
};
|
|
3901
4154
|
|
|
3902
|
-
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcAvatar, 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, HalstackLanguageContext, HalstackProvider, useToast };
|
|
4155
|
+
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcAvatar, 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, DxcPopover, DxcProgressBar, DxcQuickNav, DxcRadioGroup, DxcResultsetTable, DxcSelect, DxcSlider, DxcSpinner, DxcStatusLight, DxcSwitch, DxcTable, DxcTabs, DxcTextInput, DxcTextarea, DxcTimeInput, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackLanguageContext, HalstackProvider, useToast };
|