@dxc-technology/halstack-react 0.0.0-aededfa → 0.0.0-af1f936
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 +611 -384
- package/dist/index.d.ts +611 -384
- package/dist/index.js +4557 -2432
- package/dist/index.mjs +4690 -2568
- package/package.json +7 -6
package/dist/index.d.mts
CHANGED
|
@@ -59,7 +59,7 @@ type AccordionItemProps = {
|
|
|
59
59
|
*/
|
|
60
60
|
tabIndex?: number;
|
|
61
61
|
};
|
|
62
|
-
type CommonProps$
|
|
62
|
+
type CommonProps$a = {
|
|
63
63
|
/**
|
|
64
64
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
65
65
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
@@ -70,7 +70,7 @@ type CommonProps$9 = {
|
|
|
70
70
|
*/
|
|
71
71
|
children: ReactElement<AccordionItemProps>[] | ReactElement<AccordionItemProps>;
|
|
72
72
|
};
|
|
73
|
-
type IndependentProps = CommonProps$
|
|
73
|
+
type IndependentProps = CommonProps$a & {
|
|
74
74
|
/**
|
|
75
75
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
76
76
|
*/
|
|
@@ -91,7 +91,7 @@ type IndependentProps = CommonProps$9 & {
|
|
|
91
91
|
*/
|
|
92
92
|
onActiveChange?: (index: number) => void;
|
|
93
93
|
};
|
|
94
|
-
type NonIndependentProps = CommonProps$
|
|
94
|
+
type NonIndependentProps = CommonProps$a & {
|
|
95
95
|
/**
|
|
96
96
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
97
97
|
*/
|
|
@@ -112,10 +112,10 @@ type NonIndependentProps = CommonProps$9 & {
|
|
|
112
112
|
*/
|
|
113
113
|
onActiveChange?: (index: number[]) => void;
|
|
114
114
|
};
|
|
115
|
-
type Props$
|
|
115
|
+
type Props$M = IndependentProps | NonIndependentProps;
|
|
116
116
|
|
|
117
117
|
declare const DxcAccordion: {
|
|
118
|
-
(props: Props$
|
|
118
|
+
(props: Props$M): JSX.Element;
|
|
119
119
|
AccordionItem: ({ label, subLabel, badge, statusLight, icon, assistiveText, disabled, children, tabIndex, }: AccordionItemProps) => JSX.Element;
|
|
120
120
|
};
|
|
121
121
|
|
|
@@ -145,7 +145,7 @@ type Message = {
|
|
|
145
145
|
*/
|
|
146
146
|
text: ReactNode;
|
|
147
147
|
};
|
|
148
|
-
type CommonProps$
|
|
148
|
+
type CommonProps$9 = {
|
|
149
149
|
/**
|
|
150
150
|
* If true, the alert will have a close button that will remove the message from the alert,
|
|
151
151
|
* only in banner and inline modes. The rest of the functionality will depend
|
|
@@ -198,9 +198,9 @@ type ModeSpecificProps = {
|
|
|
198
198
|
*/
|
|
199
199
|
mode: "modal";
|
|
200
200
|
};
|
|
201
|
-
type Props$
|
|
201
|
+
type Props$L = CommonProps$9 & ModeSpecificProps;
|
|
202
202
|
|
|
203
|
-
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$
|
|
203
|
+
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$L) => react_jsx_runtime.JSX.Element;
|
|
204
204
|
|
|
205
205
|
type SearchBarProps = {
|
|
206
206
|
/**
|
|
@@ -233,64 +233,6 @@ type SearchBarProps = {
|
|
|
233
233
|
placeholder?: string;
|
|
234
234
|
};
|
|
235
235
|
|
|
236
|
-
type Section$1 = {
|
|
237
|
-
items: (Item$2 | GroupItem$2)[];
|
|
238
|
-
title?: string;
|
|
239
|
-
};
|
|
240
|
-
type SearchbarSidenavProps = Omit<SearchBarProps, "autoFocus" | "disabled" | "onCancel">;
|
|
241
|
-
type Props$I = {
|
|
242
|
-
/**
|
|
243
|
-
* The content rendered in the bottom part of the sidenav, under the navigation menu.
|
|
244
|
-
*/
|
|
245
|
-
bottomContent?: ReactNode;
|
|
246
|
-
/**
|
|
247
|
-
* Object with the properties of the branding placed at the top of the sidenav.
|
|
248
|
-
*/
|
|
249
|
-
appTitle?: string | ReactNode;
|
|
250
|
-
/**
|
|
251
|
-
* Initial state of the expansion of the sidenav, only when it is uncontrolled.
|
|
252
|
-
*/
|
|
253
|
-
defaultExpanded?: boolean;
|
|
254
|
-
/**
|
|
255
|
-
* If true the nav menu will have lines marking the groups.
|
|
256
|
-
*/
|
|
257
|
-
displayGroupLines?: boolean;
|
|
258
|
-
/**
|
|
259
|
-
* If true, the sidenav is expanded.
|
|
260
|
-
* If undefined the component will be uncontrolled and the value will be managed internally by the component.
|
|
261
|
-
*/
|
|
262
|
-
expanded?: boolean;
|
|
263
|
-
/**
|
|
264
|
-
* Array of items to be displayed in the navigation menu.
|
|
265
|
-
* Each item can be a single/simple item, a group item or a section.
|
|
266
|
-
*/
|
|
267
|
-
navItems?: (Item$2 | GroupItem$2)[] | Section$1[];
|
|
268
|
-
/**
|
|
269
|
-
* Function called when the expansion state of the sidenav changes.
|
|
270
|
-
*/
|
|
271
|
-
onExpandedChange?: (value: boolean) => void;
|
|
272
|
-
/**
|
|
273
|
-
* When provided, a search bar will be rendered at the top of the sidenav.
|
|
274
|
-
*/
|
|
275
|
-
searchBar?: SearchbarSidenavProps;
|
|
276
|
-
/**
|
|
277
|
-
* The additional content rendered in the upper part of the sidenav, under the branding.
|
|
278
|
-
*/
|
|
279
|
-
topContent?: ReactNode;
|
|
280
|
-
};
|
|
281
|
-
type CommonItemProps$1 = {
|
|
282
|
-
badge?: ReactElement;
|
|
283
|
-
icon?: string | SVG;
|
|
284
|
-
label: string;
|
|
285
|
-
};
|
|
286
|
-
type Item$2 = CommonItemProps$1 & {
|
|
287
|
-
onSelect?: () => void;
|
|
288
|
-
selected?: boolean;
|
|
289
|
-
};
|
|
290
|
-
type GroupItem$2 = CommonItemProps$1 & {
|
|
291
|
-
items: (Item$2 | GroupItem$2)[];
|
|
292
|
-
};
|
|
293
|
-
|
|
294
236
|
type CommonItemProps = {
|
|
295
237
|
badge?: ReactElement;
|
|
296
238
|
icon?: string | SVG;
|
|
@@ -306,17 +248,18 @@ type Item$1 = CommonItemProps & {
|
|
|
306
248
|
};
|
|
307
249
|
type GroupItem$1 = CommonItemProps & {
|
|
308
250
|
items: (Item$1 | GroupItem$1)[];
|
|
251
|
+
defaultOpen?: boolean;
|
|
309
252
|
};
|
|
310
|
-
type Section = {
|
|
253
|
+
type Section$1 = {
|
|
311
254
|
items: (Item$1 | GroupItem$1)[];
|
|
312
255
|
title?: string;
|
|
313
256
|
};
|
|
314
|
-
type Props$
|
|
257
|
+
type Props$K = {
|
|
315
258
|
/**
|
|
316
259
|
* Array of items to be displayed in the menu.
|
|
317
260
|
* Each item can be a single/simple item, a group item or a section.
|
|
318
261
|
*/
|
|
319
|
-
items: (Item$1 | GroupItem$1)[] | Section[];
|
|
262
|
+
items: (Item$1 | GroupItem$1)[] | Section$1[];
|
|
320
263
|
/**
|
|
321
264
|
* If true the menu will be displayed with a border.
|
|
322
265
|
*/
|
|
@@ -337,6 +280,57 @@ type Props$H = {
|
|
|
337
280
|
* If true the menu will be displayed horizontally.
|
|
338
281
|
*/
|
|
339
282
|
isHorizontal?: boolean;
|
|
283
|
+
/**
|
|
284
|
+
* Function that will be called when an option is clicked.
|
|
285
|
+
* This is used to notify that an item has been selected to close any visible menu that is not managed by the navigation tree.
|
|
286
|
+
*/
|
|
287
|
+
onSelectItem?: () => void;
|
|
288
|
+
};
|
|
289
|
+
|
|
290
|
+
type Section = {
|
|
291
|
+
items: (Item$1 | GroupItem$1)[];
|
|
292
|
+
title?: string;
|
|
293
|
+
};
|
|
294
|
+
type SearchbarSidenavProps = Omit<SearchBarProps, "autoFocus" | "disabled" | "onCancel">;
|
|
295
|
+
type Props$J = {
|
|
296
|
+
/**
|
|
297
|
+
* The content rendered in the bottom part of the sidenav, under the navigation menu.
|
|
298
|
+
*/
|
|
299
|
+
bottomContent?: ReactNode;
|
|
300
|
+
/**
|
|
301
|
+
* Object with the properties of the branding placed at the top of the sidenav.
|
|
302
|
+
*/
|
|
303
|
+
appTitle?: string | ReactNode;
|
|
304
|
+
/**
|
|
305
|
+
* Initial state of the expansion of the sidenav, only when it is uncontrolled.
|
|
306
|
+
*/
|
|
307
|
+
defaultExpanded?: boolean;
|
|
308
|
+
/**
|
|
309
|
+
* If true the nav menu will have lines marking the groups.
|
|
310
|
+
*/
|
|
311
|
+
displayGroupLines?: boolean;
|
|
312
|
+
/**
|
|
313
|
+
* If true, the sidenav is expanded.
|
|
314
|
+
* If undefined the component will be uncontrolled and the value will be managed internally by the component.
|
|
315
|
+
*/
|
|
316
|
+
expanded?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* Array of items to be displayed in the navigation menu.
|
|
319
|
+
* Each item can be a single/simple item, a group item or a section.
|
|
320
|
+
*/
|
|
321
|
+
navItems?: (Item$1 | GroupItem$1)[] | Section[];
|
|
322
|
+
/**
|
|
323
|
+
* Function called when the expansion state of the sidenav changes.
|
|
324
|
+
*/
|
|
325
|
+
onExpandedChange?: (value: boolean) => void;
|
|
326
|
+
/**
|
|
327
|
+
* When provided, a search bar will be rendered at the top of the sidenav.
|
|
328
|
+
*/
|
|
329
|
+
searchBar?: SearchbarSidenavProps;
|
|
330
|
+
/**
|
|
331
|
+
* The additional content rendered in the upper part of the sidenav, under the branding.
|
|
332
|
+
*/
|
|
333
|
+
topContent?: ReactNode;
|
|
340
334
|
};
|
|
341
335
|
|
|
342
336
|
type GroupItem = CommonItemProps & {
|
|
@@ -344,7 +338,7 @@ type GroupItem = CommonItemProps & {
|
|
|
344
338
|
};
|
|
345
339
|
type MainNavPropsType = (GroupItem | Item$1)[];
|
|
346
340
|
type SearchBarHeaderProps = Omit<SearchBarProps, "autoFocus" | "disabled">;
|
|
347
|
-
type Props$
|
|
341
|
+
type Props$I = {
|
|
348
342
|
appTitle?: string;
|
|
349
343
|
navItems?: MainNavPropsType;
|
|
350
344
|
responsiveBottomContent?: ReactNode;
|
|
@@ -380,7 +374,7 @@ type Logo = {
|
|
|
380
374
|
/**
|
|
381
375
|
* Source of the logo image.
|
|
382
376
|
*/
|
|
383
|
-
src: string;
|
|
377
|
+
src: string | SVG;
|
|
384
378
|
/**
|
|
385
379
|
* Alternative text for the logo image.
|
|
386
380
|
*/
|
|
@@ -476,9 +470,9 @@ type ApplicationLayoutPropsType = {
|
|
|
476
470
|
declare const DxcApplicationLayout: {
|
|
477
471
|
({ logo, header, sidenav, footer, children }: ApplicationLayoutPropsType): JSX.Element;
|
|
478
472
|
Footer: ({ bottomLinks, copyright, leftContent, logo, mode, rightContent, socialLinks, tabIndex, }: FooterPropsType) => JSX.Element;
|
|
479
|
-
Header: ({ appTitle, navItems, responsiveBottomContent, searchBar, sideContent, }: Props$
|
|
473
|
+
Header: ({ appTitle, navItems, responsiveBottomContent, searchBar, sideContent, }: Props$I) => JSX.Element;
|
|
480
474
|
Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
|
|
481
|
-
Sidenav: ({ topContent, bottomContent, navItems, appTitle, displayGroupLines, expanded, defaultExpanded, onExpandedChange, searchBar, }: Props$
|
|
475
|
+
Sidenav: ({ topContent, bottomContent, navItems, appTitle, displayGroupLines, expanded, defaultExpanded, onExpandedChange, searchBar, }: Props$J) => JSX.Element;
|
|
482
476
|
};
|
|
483
477
|
|
|
484
478
|
type Size$5 = "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
@@ -488,7 +482,7 @@ interface Status {
|
|
|
488
482
|
mode: "default" | "info" | "success" | "warning" | "error";
|
|
489
483
|
position: "top" | "bottom";
|
|
490
484
|
}
|
|
491
|
-
type Props$
|
|
485
|
+
type Props$H = {
|
|
492
486
|
/**
|
|
493
487
|
* Affects the visual style of the avatar. It can be used following semantic purposes or not.
|
|
494
488
|
*/
|
|
@@ -549,7 +543,7 @@ type Props$F = {
|
|
|
549
543
|
title?: string;
|
|
550
544
|
};
|
|
551
545
|
|
|
552
|
-
declare const DxcAvatar: react.MemoExoticComponent<({ color, disabled, icon, imageSrc, label, linkHref, onClick, primaryText, secondaryText, shape, size, status, tabIndex, title, }: Props$
|
|
546
|
+
declare const DxcAvatar: react.MemoExoticComponent<({ color, disabled, icon, imageSrc, label, linkHref, onClick, primaryText, secondaryText, shape, size, status, tabIndex, title, }: Props$H) => react_jsx_runtime.JSX.Element>;
|
|
553
547
|
|
|
554
548
|
type ContextualProps = {
|
|
555
549
|
/**
|
|
@@ -587,7 +581,7 @@ type NotificationProps = {
|
|
|
587
581
|
*/
|
|
588
582
|
color?: never;
|
|
589
583
|
};
|
|
590
|
-
type CommonProps$
|
|
584
|
+
type CommonProps$8 = {
|
|
591
585
|
/**
|
|
592
586
|
* Text representing advisory information related to the badge. Under the hood, this prop also serves as an accessible label for the component.
|
|
593
587
|
*/
|
|
@@ -601,11 +595,11 @@ type CommonProps$7 = {
|
|
|
601
595
|
*/
|
|
602
596
|
size?: "small" | "medium" | "large";
|
|
603
597
|
};
|
|
604
|
-
type Props$
|
|
598
|
+
type Props$G = (ContextualProps | NotificationProps) & CommonProps$8;
|
|
605
599
|
|
|
606
|
-
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$
|
|
600
|
+
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$G) => JSX.Element;
|
|
607
601
|
|
|
608
|
-
type Props$
|
|
602
|
+
type Props$F = {
|
|
609
603
|
/**
|
|
610
604
|
* Applies the spacing scale to all sides.
|
|
611
605
|
*/
|
|
@@ -640,13 +634,13 @@ type Props$D = {
|
|
|
640
634
|
children: ReactNode;
|
|
641
635
|
};
|
|
642
636
|
|
|
643
|
-
declare const DxcBleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$
|
|
637
|
+
declare const DxcBleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$F) => react_jsx_runtime.JSX.Element;
|
|
644
638
|
|
|
645
639
|
type Item = {
|
|
646
640
|
href?: string;
|
|
647
641
|
label: string;
|
|
648
642
|
};
|
|
649
|
-
type Props$
|
|
643
|
+
type Props$E = {
|
|
650
644
|
/**
|
|
651
645
|
* Provides a label that describes the type of navigation enabled by
|
|
652
646
|
* the component.
|
|
@@ -678,7 +672,7 @@ type Props$C = {
|
|
|
678
672
|
showRoot?: boolean;
|
|
679
673
|
};
|
|
680
674
|
|
|
681
|
-
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$
|
|
675
|
+
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$E) => react_jsx_runtime.JSX.Element;
|
|
682
676
|
|
|
683
677
|
type IconProps = {
|
|
684
678
|
/**
|
|
@@ -708,7 +702,7 @@ type OtherProps = {
|
|
|
708
702
|
*/
|
|
709
703
|
children: ReactNode;
|
|
710
704
|
};
|
|
711
|
-
type Props$
|
|
705
|
+
type Props$D = IconProps | OtherProps;
|
|
712
706
|
type BulletedListItemPropsType = {
|
|
713
707
|
/**
|
|
714
708
|
* Text to be shown in the list.
|
|
@@ -717,7 +711,7 @@ type BulletedListItemPropsType = {
|
|
|
717
711
|
};
|
|
718
712
|
|
|
719
713
|
declare const DxcBulletedList: {
|
|
720
|
-
({ children, type, icon }: Props$
|
|
714
|
+
({ children, type, icon }: Props$D): JSX.Element;
|
|
721
715
|
Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
|
|
722
716
|
};
|
|
723
717
|
|
|
@@ -730,7 +724,7 @@ type Size$4 = {
|
|
|
730
724
|
height?: "small" | "medium" | "large";
|
|
731
725
|
width?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
732
726
|
};
|
|
733
|
-
type Props$
|
|
727
|
+
type Props$C = {
|
|
734
728
|
/**
|
|
735
729
|
* Text to be placed in the button.
|
|
736
730
|
*/
|
|
@@ -782,71 +776,169 @@ type Props$A = {
|
|
|
782
776
|
tabIndex?: number;
|
|
783
777
|
};
|
|
784
778
|
|
|
785
|
-
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$
|
|
779
|
+
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$C) => JSX.Element;
|
|
780
|
+
|
|
781
|
+
type Props$B = {
|
|
782
|
+
/**
|
|
783
|
+
* Alternative text description displayed when the specified image is not loaded.
|
|
784
|
+
*
|
|
785
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
786
|
+
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
787
|
+
*/
|
|
788
|
+
alt: string;
|
|
789
|
+
/**
|
|
790
|
+
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
791
|
+
* which is required regardless of the presence of the caption or not.
|
|
792
|
+
*/
|
|
793
|
+
caption?: string;
|
|
794
|
+
/**
|
|
795
|
+
* Sets the rendered height of the image.
|
|
796
|
+
*/
|
|
797
|
+
height?: string;
|
|
798
|
+
/**
|
|
799
|
+
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
800
|
+
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
801
|
+
*/
|
|
802
|
+
lazyLoading?: boolean;
|
|
803
|
+
/**
|
|
804
|
+
* Sets the object-fit CSS property.
|
|
805
|
+
*
|
|
806
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
807
|
+
*/
|
|
808
|
+
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
809
|
+
/**
|
|
810
|
+
* Sets the object-position CSS property.
|
|
811
|
+
*
|
|
812
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
813
|
+
*/
|
|
814
|
+
objectPosition?: string;
|
|
815
|
+
/**
|
|
816
|
+
* This function will be called when the image fails to load.
|
|
817
|
+
*/
|
|
818
|
+
onError?: ReactEventHandler<HTMLImageElement>;
|
|
819
|
+
/**
|
|
820
|
+
* This function will be called when the image is loaded.
|
|
821
|
+
*/
|
|
822
|
+
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
823
|
+
/**
|
|
824
|
+
* One or more strings separated by commas, indicating a set of source sizes.
|
|
825
|
+
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
826
|
+
* then this attribute has no effect.
|
|
827
|
+
*
|
|
828
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
829
|
+
*/
|
|
830
|
+
sizes?: string;
|
|
831
|
+
/**
|
|
832
|
+
* URL of the image. This prop is required and must be valid.
|
|
833
|
+
*/
|
|
834
|
+
src: string;
|
|
835
|
+
/**
|
|
836
|
+
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
837
|
+
*
|
|
838
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
839
|
+
*/
|
|
840
|
+
srcSet?: string;
|
|
841
|
+
/**
|
|
842
|
+
* Sets the rendered width of the image.
|
|
843
|
+
*/
|
|
844
|
+
width?: string;
|
|
845
|
+
};
|
|
786
846
|
|
|
787
847
|
type Size$3 = {
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
left?: Space$1;
|
|
791
|
-
right?: Space$1;
|
|
848
|
+
width?: "fillParent" | "fitContent";
|
|
849
|
+
height?: "fillParent" | "fitContent";
|
|
792
850
|
};
|
|
793
|
-
type Props$
|
|
851
|
+
type Props$A = {
|
|
794
852
|
/**
|
|
795
|
-
*
|
|
796
|
-
* In case of omission, the image container will not appear and
|
|
797
|
-
* the content will occupy its space.
|
|
853
|
+
* Custom content that will be placed inside the component.
|
|
798
854
|
*/
|
|
799
|
-
|
|
855
|
+
children?: ReactNode;
|
|
856
|
+
/**
|
|
857
|
+
* Initial state of the checkbox, only when it is uncontrolled.
|
|
858
|
+
*/
|
|
859
|
+
defaultSelected?: boolean;
|
|
800
860
|
/**
|
|
801
|
-
*
|
|
861
|
+
* Defines the direction of the content inside the card. It can be set to "row" or "column". The default value is "column".
|
|
802
862
|
*/
|
|
803
|
-
|
|
863
|
+
direction?: "row" | "column";
|
|
804
864
|
/**
|
|
805
|
-
*
|
|
806
|
-
* component. You can pass an object with 'top', 'bottom', 'left'
|
|
807
|
-
* and 'right' properties in order to specify different padding sizes.
|
|
865
|
+
* Defines the size of the card when it is empty.
|
|
808
866
|
*/
|
|
809
|
-
|
|
867
|
+
emptySize?: {
|
|
868
|
+
width?: string;
|
|
869
|
+
height?: string;
|
|
870
|
+
iconSize?: "small" | "medium" | "large";
|
|
871
|
+
};
|
|
810
872
|
/**
|
|
811
|
-
*
|
|
873
|
+
* URL to navigate to when the card is clicked.
|
|
874
|
+
* If href is defined selectable will be ignored and the link will be always considered as an anchor.
|
|
875
|
+
*/
|
|
876
|
+
href?: string;
|
|
877
|
+
/**
|
|
878
|
+
* Image to be displayed inside the card.
|
|
879
|
+
*/
|
|
880
|
+
image?: Props$B;
|
|
881
|
+
/**
|
|
882
|
+
* Position of the image inside the card. It can be set to "before" or "after" the content.
|
|
812
883
|
*/
|
|
813
884
|
imagePosition?: "before" | "after";
|
|
814
885
|
/**
|
|
815
|
-
* If
|
|
816
|
-
* as "href". Component will show some visual feedback on hover.
|
|
886
|
+
* If true, the card will be displayed as empty state.
|
|
817
887
|
*/
|
|
818
|
-
|
|
888
|
+
isEmpty?: boolean;
|
|
819
889
|
/**
|
|
820
|
-
*
|
|
821
|
-
* will show some visual feedback on hover.
|
|
890
|
+
* If true, a loading state will be displayed inside the card.
|
|
822
891
|
*/
|
|
823
|
-
|
|
892
|
+
isLoading?: boolean;
|
|
824
893
|
/**
|
|
825
|
-
*
|
|
894
|
+
* Defines the size of the loading card when isLoading is true.
|
|
826
895
|
*/
|
|
827
|
-
|
|
896
|
+
loadingSize?: {
|
|
897
|
+
width?: string;
|
|
898
|
+
height?: string;
|
|
899
|
+
};
|
|
828
900
|
/**
|
|
829
|
-
*
|
|
830
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
901
|
+
* Defines the visual style of the card. It can be set to "elevated" or "outlined".
|
|
831
902
|
*/
|
|
832
|
-
|
|
903
|
+
mode?: "elevated" | "outlined";
|
|
833
904
|
/**
|
|
834
|
-
*
|
|
905
|
+
* If true, the link will open in a new window. href must be provided for this to work.
|
|
835
906
|
*/
|
|
836
|
-
|
|
907
|
+
newWindow?: boolean;
|
|
837
908
|
/**
|
|
838
|
-
*
|
|
909
|
+
* Callback function that is called when the card is clicked.
|
|
910
|
+
* It receives a boolean value indicating whether the card is selected or not.
|
|
911
|
+
* selectable must be true for this to work.
|
|
839
912
|
*/
|
|
840
|
-
|
|
913
|
+
onSelectionChange?: (selected: boolean) => void;
|
|
841
914
|
/**
|
|
842
|
-
*
|
|
915
|
+
* Callback function that is called when the card is clicked.
|
|
843
916
|
*/
|
|
844
|
-
|
|
917
|
+
onClick?: (event: React.MouseEvent | React.KeyboardEvent) => void;
|
|
918
|
+
/**
|
|
919
|
+
* 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.
|
|
920
|
+
* If href is defined, the card won't be selectable, even if this prop is true.
|
|
921
|
+
*/
|
|
922
|
+
selectable?: boolean;
|
|
923
|
+
/**
|
|
924
|
+
* If true, the card is selected and if defined it will behave as a controlled component.
|
|
925
|
+
*/
|
|
926
|
+
selected?: boolean;
|
|
927
|
+
/**
|
|
928
|
+
* Defines the size of the card. Width and height can be set to "fillParent" or "fitContent".
|
|
929
|
+
* The default value is { width: "fitContent", height: "fitContent" }.
|
|
930
|
+
*/
|
|
931
|
+
size?: Size$3;
|
|
932
|
+
/**
|
|
933
|
+
* Specifies the tab index of the card.
|
|
934
|
+
* The default value is 0.
|
|
935
|
+
*/
|
|
936
|
+
tabIndex?: number;
|
|
845
937
|
};
|
|
846
938
|
|
|
847
|
-
declare const DxcCard:
|
|
939
|
+
declare const DxcCard: react.ForwardRefExoticComponent<Props$A & react.RefAttributes<HTMLAnchorElement>>;
|
|
848
940
|
|
|
849
|
-
type Props$
|
|
941
|
+
type Props$z = {
|
|
850
942
|
/**
|
|
851
943
|
* Specifies a string to be used as the name for the checkbox element when no `label` is provided.
|
|
852
944
|
*/
|
|
@@ -911,45 +1003,82 @@ type Props$y = {
|
|
|
911
1003
|
value?: string;
|
|
912
1004
|
};
|
|
913
1005
|
|
|
914
|
-
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$
|
|
1006
|
+
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$z & react.RefAttributes<HTMLDivElement>>;
|
|
915
1007
|
|
|
916
|
-
type
|
|
1008
|
+
type ChipAvatarType = {
|
|
1009
|
+
color: Props$H["color"];
|
|
1010
|
+
profileName?: Props$H["label"];
|
|
1011
|
+
imageSrc?: Props$H["imageSrc"];
|
|
1012
|
+
icon?: Props$H["icon"];
|
|
1013
|
+
};
|
|
1014
|
+
type CommonProps$7 = {
|
|
917
1015
|
/**
|
|
918
|
-
*
|
|
1016
|
+
* Function to be called when the chip is clicked or the dismiss action is triggered.
|
|
919
1017
|
*/
|
|
920
|
-
|
|
1018
|
+
onClick?: () => void;
|
|
1019
|
+
/**
|
|
1020
|
+
* Value of the tabindex attribute.
|
|
1021
|
+
*/
|
|
1022
|
+
tabIndex?: number;
|
|
1023
|
+
};
|
|
1024
|
+
type SelectableChipProps = CommonProps$7 & {
|
|
1025
|
+
/**
|
|
1026
|
+
* If true, the component will be disabled.
|
|
1027
|
+
*/
|
|
1028
|
+
disabled?: boolean;
|
|
1029
|
+
/**
|
|
1030
|
+
* The whole chip is an interactive element that allows users to activate or clear options directly within the interface.
|
|
1031
|
+
*/
|
|
1032
|
+
mode?: "selectable";
|
|
921
1033
|
/**
|
|
922
|
-
*
|
|
1034
|
+
* If true, the component will be selected. This property is only applicable when the mode is "selectable".
|
|
1035
|
+
* If undefined, the component manages its own internal state (uncontrolled mode).
|
|
923
1036
|
*/
|
|
924
|
-
|
|
1037
|
+
selected?: boolean;
|
|
1038
|
+
} & ({
|
|
1039
|
+
/**
|
|
1040
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
1041
|
+
*/
|
|
1042
|
+
prefix: ChipAvatarType;
|
|
1043
|
+
/**
|
|
1044
|
+
* Text to be placed on the chip. Required when using an avatar prefix.
|
|
1045
|
+
*/
|
|
1046
|
+
label: string;
|
|
1047
|
+
} | {
|
|
925
1048
|
/**
|
|
926
1049
|
* Element or path used as icon to be placed before the chip label.
|
|
927
1050
|
*/
|
|
928
|
-
|
|
1051
|
+
prefix: string | SVG;
|
|
929
1052
|
/**
|
|
930
|
-
*
|
|
1053
|
+
* Text to be placed on the chip. Optional when using an icon prefix.
|
|
931
1054
|
*/
|
|
932
|
-
|
|
1055
|
+
label?: string;
|
|
1056
|
+
} | {
|
|
1057
|
+
prefix?: undefined;
|
|
933
1058
|
/**
|
|
934
|
-
*
|
|
1059
|
+
* Text to be placed on the chip.
|
|
935
1060
|
*/
|
|
936
|
-
|
|
1061
|
+
label: string;
|
|
1062
|
+
});
|
|
1063
|
+
type DismissibleChipProps = CommonProps$7 & {
|
|
937
1064
|
/**
|
|
938
|
-
*
|
|
1065
|
+
* Dismissible chip is used to represent information generated by user input within an interface.
|
|
939
1066
|
*/
|
|
940
|
-
|
|
1067
|
+
mode: "dismissible";
|
|
941
1068
|
/**
|
|
942
|
-
*
|
|
943
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1069
|
+
* Text to be placed on the chip.
|
|
944
1070
|
*/
|
|
945
|
-
|
|
1071
|
+
label: string;
|
|
946
1072
|
/**
|
|
947
|
-
*
|
|
1073
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
948
1074
|
*/
|
|
949
|
-
|
|
1075
|
+
prefix?: string | SVG | ChipAvatarType;
|
|
1076
|
+
selected?: never;
|
|
1077
|
+
disabled?: never;
|
|
950
1078
|
};
|
|
1079
|
+
type Props$y = SelectableChipProps | DismissibleChipProps;
|
|
951
1080
|
|
|
952
|
-
declare const DxcChip: ({
|
|
1081
|
+
declare const DxcChip: ({ disabled, label, mode, onClick, prefix, selected, tabIndex, }: Props$y) => react_jsx_runtime.JSX.Element | null;
|
|
953
1082
|
|
|
954
1083
|
type Space = {
|
|
955
1084
|
top?: string;
|
|
@@ -992,7 +1121,7 @@ type Overflow = OverflowValues | {
|
|
|
992
1121
|
x?: OverflowValues;
|
|
993
1122
|
y?: OverflowValues;
|
|
994
1123
|
};
|
|
995
|
-
type Props$
|
|
1124
|
+
type Props$x = {
|
|
996
1125
|
/**
|
|
997
1126
|
* Based on the CSS property background allows configuring all properties related to the background of a container.
|
|
998
1127
|
*
|
|
@@ -1114,11 +1243,11 @@ type Props$w = {
|
|
|
1114
1243
|
zIndex?: "auto" | number;
|
|
1115
1244
|
};
|
|
1116
1245
|
|
|
1117
|
-
declare const DxcContainer: react.ForwardRefExoticComponent<Props$
|
|
1246
|
+
declare const DxcContainer: react.ForwardRefExoticComponent<Props$x & react.RefAttributes<HTMLDivElement>>;
|
|
1118
1247
|
|
|
1119
|
-
type Props$
|
|
1248
|
+
type Props$w = Omit<Props$K, "displayBorder" | "displayGroupLines" | "displayControlsAfter" | "hasPopOver">;
|
|
1120
1249
|
|
|
1121
|
-
declare function DxcContextualMenu({ items }: Props$
|
|
1250
|
+
declare function DxcContextualMenu({ items }: Props$w): react_jsx_runtime.JSX.Element;
|
|
1122
1251
|
|
|
1123
1252
|
type Size$2 = "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
1124
1253
|
type Option$2 = {
|
|
@@ -1135,7 +1264,7 @@ type Option$2 = {
|
|
|
1135
1264
|
*/
|
|
1136
1265
|
value: string;
|
|
1137
1266
|
};
|
|
1138
|
-
type Props$
|
|
1267
|
+
type Props$v = {
|
|
1139
1268
|
/**
|
|
1140
1269
|
* An array of objects representing the options.
|
|
1141
1270
|
*/
|
|
@@ -1218,7 +1347,7 @@ type ActionsCellPropsType = {
|
|
|
1218
1347
|
*/
|
|
1219
1348
|
actions: ActionCell[];
|
|
1220
1349
|
};
|
|
1221
|
-
type Props$
|
|
1350
|
+
type Props$u = {
|
|
1222
1351
|
/**
|
|
1223
1352
|
* The center section of the table. Can be used to render custom
|
|
1224
1353
|
* content in this area.
|
|
@@ -1452,14 +1581,14 @@ type BasicGridProps = {
|
|
|
1452
1581
|
*/
|
|
1453
1582
|
expandable?: false;
|
|
1454
1583
|
};
|
|
1455
|
-
type Props$
|
|
1584
|
+
type Props$t = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((BasicGridProps & SelectableGridProps) | (ExpandableRows & SelectableGridProps) | (HierarchyRows & SelectableGridProps));
|
|
1456
1585
|
|
|
1457
1586
|
declare const DxcDataGrid: {
|
|
1458
|
-
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$
|
|
1587
|
+
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$t): JSX.Element;
|
|
1459
1588
|
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
1460
1589
|
};
|
|
1461
1590
|
|
|
1462
|
-
type Props$
|
|
1591
|
+
type Props$s = {
|
|
1463
1592
|
/**
|
|
1464
1593
|
* Initial value of the input element, only when it is uncontrolled.
|
|
1465
1594
|
*/
|
|
@@ -1565,9 +1694,9 @@ type Props$r = {
|
|
|
1565
1694
|
ariaLabel?: string;
|
|
1566
1695
|
};
|
|
1567
1696
|
|
|
1568
|
-
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$
|
|
1697
|
+
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$s & react.RefAttributes<HTMLDivElement>>;
|
|
1569
1698
|
|
|
1570
|
-
type Props$
|
|
1699
|
+
type Props$r = {
|
|
1571
1700
|
/**
|
|
1572
1701
|
* If true, the close button will be visible.
|
|
1573
1702
|
*/
|
|
@@ -1607,9 +1736,9 @@ type Props$q = {
|
|
|
1607
1736
|
disableFocusLock?: boolean;
|
|
1608
1737
|
};
|
|
1609
1738
|
|
|
1610
|
-
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, disableFocusLock, }: Props$
|
|
1739
|
+
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, disableFocusLock, }: Props$r) => JSX.Element;
|
|
1611
1740
|
|
|
1612
|
-
type Props$
|
|
1741
|
+
type Props$q = {
|
|
1613
1742
|
/**
|
|
1614
1743
|
* The divider can be shown in horizontal or vertical.
|
|
1615
1744
|
*/
|
|
@@ -1630,9 +1759,9 @@ type Props$p = {
|
|
|
1630
1759
|
decorative?: boolean;
|
|
1631
1760
|
};
|
|
1632
1761
|
|
|
1633
|
-
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$
|
|
1762
|
+
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$q): react_jsx_runtime.JSX.Element;
|
|
1634
1763
|
|
|
1635
|
-
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$
|
|
1764
|
+
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$v) => react_jsx_runtime.JSX.Element;
|
|
1636
1765
|
|
|
1637
1766
|
type FileData = {
|
|
1638
1767
|
/**
|
|
@@ -1701,6 +1830,10 @@ type CommonProps$5 = {
|
|
|
1701
1830
|
* If true, if the file is an image, a preview of it will be shown. If not, an icon refering to the file type will be shown.
|
|
1702
1831
|
*/
|
|
1703
1832
|
showPreview?: boolean;
|
|
1833
|
+
/**
|
|
1834
|
+
* Size of the component.
|
|
1835
|
+
*/
|
|
1836
|
+
size?: "medium" | "fillParent";
|
|
1704
1837
|
/**
|
|
1705
1838
|
* Value of the tabindex attribute.
|
|
1706
1839
|
*/
|
|
@@ -1738,9 +1871,9 @@ type FileModeProps = CommonProps$5 & {
|
|
|
1738
1871
|
*/
|
|
1739
1872
|
mode?: "file";
|
|
1740
1873
|
};
|
|
1741
|
-
type Props$
|
|
1874
|
+
type Props$p = DropModeProps | FileModeProps;
|
|
1742
1875
|
|
|
1743
|
-
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$
|
|
1876
|
+
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$p & react.RefAttributes<HTMLDivElement>>;
|
|
1744
1877
|
|
|
1745
1878
|
type Gap$1 = {
|
|
1746
1879
|
rowGap: string;
|
|
@@ -1775,7 +1908,7 @@ type CommonProps$4 = {
|
|
|
1775
1908
|
*/
|
|
1776
1909
|
alignSelf?: "auto" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
|
|
1777
1910
|
};
|
|
1778
|
-
type Props$
|
|
1911
|
+
type Props$o = CommonProps$4 & {
|
|
1779
1912
|
/**
|
|
1780
1913
|
* Sets the flex-direction CSS property.
|
|
1781
1914
|
*
|
|
@@ -1832,7 +1965,7 @@ type Props$n = CommonProps$4 & {
|
|
|
1832
1965
|
children: ReactNode;
|
|
1833
1966
|
};
|
|
1834
1967
|
|
|
1835
|
-
declare const DxcFlex: ({ basis, direction, fullHeight, gap, grow, order, shrink, wrap, ...props }: Props$
|
|
1968
|
+
declare const DxcFlex: ({ basis, direction, fullHeight, gap, grow, order, shrink, wrap, ...props }: Props$o) => react_jsx_runtime.JSX.Element;
|
|
1836
1969
|
|
|
1837
1970
|
type Gap = string | {
|
|
1838
1971
|
columnGap?: string;
|
|
@@ -1890,7 +2023,7 @@ type GridItemProps = {
|
|
|
1890
2023
|
*/
|
|
1891
2024
|
row?: number | string | GridCell;
|
|
1892
2025
|
};
|
|
1893
|
-
type Props$
|
|
2026
|
+
type Props$n = GridItemProps & {
|
|
1894
2027
|
/**
|
|
1895
2028
|
* Sets the grid-auto-columns CSS property.
|
|
1896
2029
|
*
|
|
@@ -1948,14 +2081,14 @@ type Props$m = GridItemProps & {
|
|
|
1948
2081
|
};
|
|
1949
2082
|
|
|
1950
2083
|
declare const DxcGrid: {
|
|
1951
|
-
(props: Props$
|
|
2084
|
+
(props: Props$n): react_jsx_runtime.JSX.Element;
|
|
1952
2085
|
Item: _emotion_styled.StyledComponent<{
|
|
1953
2086
|
theme?: _emotion_react.Theme;
|
|
1954
2087
|
as?: React.ElementType;
|
|
1955
2088
|
} & GridItemProps, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
|
|
1956
2089
|
};
|
|
1957
2090
|
|
|
1958
|
-
type Props$
|
|
2091
|
+
type Props$m = {
|
|
1959
2092
|
/**
|
|
1960
2093
|
* Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
|
|
1961
2094
|
* The html tag of the heading will be the one specified in the 'as' prop.
|
|
@@ -1981,77 +2114,11 @@ type Props$l = {
|
|
|
1981
2114
|
margin?: Space$1 | Margin;
|
|
1982
2115
|
};
|
|
1983
2116
|
|
|
1984
|
-
declare function DxcHeading({ as, level, margin, text, weight }: Props$
|
|
1985
|
-
|
|
1986
|
-
type Props$k = {
|
|
1987
|
-
/**
|
|
1988
|
-
* Alternative text description displayed when the specified image is not loaded.
|
|
1989
|
-
*
|
|
1990
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
1991
|
-
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
1992
|
-
*/
|
|
1993
|
-
alt: string;
|
|
1994
|
-
/**
|
|
1995
|
-
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
1996
|
-
* which is required regardless of the presence of the caption or not.
|
|
1997
|
-
*/
|
|
1998
|
-
caption?: string;
|
|
1999
|
-
/**
|
|
2000
|
-
* Sets the rendered height of the image.
|
|
2001
|
-
*/
|
|
2002
|
-
height?: string;
|
|
2003
|
-
/**
|
|
2004
|
-
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
2005
|
-
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
2006
|
-
*/
|
|
2007
|
-
lazyLoading?: boolean;
|
|
2008
|
-
/**
|
|
2009
|
-
* Sets the object-fit CSS property.
|
|
2010
|
-
*
|
|
2011
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
2012
|
-
*/
|
|
2013
|
-
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
2014
|
-
/**
|
|
2015
|
-
* Sets the object-position CSS property.
|
|
2016
|
-
*
|
|
2017
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
2018
|
-
*/
|
|
2019
|
-
objectPosition?: string;
|
|
2020
|
-
/**
|
|
2021
|
-
* This function will be called when the image fails to load.
|
|
2022
|
-
*/
|
|
2023
|
-
onError?: ReactEventHandler<HTMLImageElement>;
|
|
2024
|
-
/**
|
|
2025
|
-
* This function will be called when the image is loaded.
|
|
2026
|
-
*/
|
|
2027
|
-
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
2028
|
-
/**
|
|
2029
|
-
* One or more strings separated by commas, indicating a set of source sizes.
|
|
2030
|
-
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
2031
|
-
* then this attribute has no effect.
|
|
2032
|
-
*
|
|
2033
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
2034
|
-
*/
|
|
2035
|
-
sizes?: string;
|
|
2036
|
-
/**
|
|
2037
|
-
* URL of the image. This prop is required and must be valid.
|
|
2038
|
-
*/
|
|
2039
|
-
src: string;
|
|
2040
|
-
/**
|
|
2041
|
-
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
2042
|
-
*
|
|
2043
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
2044
|
-
*/
|
|
2045
|
-
srcSet?: string;
|
|
2046
|
-
/**
|
|
2047
|
-
* Sets the rendered width of the image.
|
|
2048
|
-
*/
|
|
2049
|
-
width?: string;
|
|
2050
|
-
};
|
|
2117
|
+
declare function DxcHeading({ as, level, margin, text, weight }: Props$m): react_jsx_runtime.JSX.Element;
|
|
2051
2118
|
|
|
2052
|
-
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$
|
|
2119
|
+
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$B): react_jsx_runtime.JSX.Element;
|
|
2053
2120
|
|
|
2054
|
-
type Props$
|
|
2121
|
+
type Props$l = {
|
|
2055
2122
|
/**
|
|
2056
2123
|
* Applies the spacing scale to the bottom side.
|
|
2057
2124
|
*/
|
|
@@ -2086,7 +2153,7 @@ type Props$j = {
|
|
|
2086
2153
|
vertical?: string;
|
|
2087
2154
|
};
|
|
2088
2155
|
|
|
2089
|
-
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$
|
|
2156
|
+
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$l): react_jsx_runtime.JSX.Element;
|
|
2090
2157
|
|
|
2091
2158
|
type LinkProps = {
|
|
2092
2159
|
/**
|
|
@@ -2098,42 +2165,157 @@ type LinkProps = {
|
|
|
2098
2165
|
*/
|
|
2099
2166
|
inheritColor?: boolean;
|
|
2100
2167
|
/**
|
|
2101
|
-
* Material Symbol name or SVG element as the icon that will be placed next to the link text.
|
|
2168
|
+
* Material Symbol name or SVG element as the icon that will be placed next to the link text.
|
|
2169
|
+
*/
|
|
2170
|
+
icon?: string | SVG;
|
|
2171
|
+
/**
|
|
2172
|
+
* Indicates the position of the icon in the component.
|
|
2173
|
+
*/
|
|
2174
|
+
iconPosition?: "before" | "after";
|
|
2175
|
+
/**
|
|
2176
|
+
* Page to be opened when the user clicks on the link.
|
|
2177
|
+
*/
|
|
2178
|
+
href?: string;
|
|
2179
|
+
/**
|
|
2180
|
+
* If true, the page is opened in a new browser tab.
|
|
2181
|
+
*/
|
|
2182
|
+
newWindow?: boolean;
|
|
2183
|
+
/**
|
|
2184
|
+
* If defined, the link will be displayed as a button. This
|
|
2185
|
+
* function will be called when the user clicks the link.
|
|
2186
|
+
*/
|
|
2187
|
+
onClick?: () => void;
|
|
2188
|
+
/**
|
|
2189
|
+
* Text of the link.
|
|
2190
|
+
*/
|
|
2191
|
+
children: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2194
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2195
|
+
*/
|
|
2196
|
+
margin?: Space$1 | Margin;
|
|
2197
|
+
/**
|
|
2198
|
+
* Value of the tabindex.
|
|
2199
|
+
*/
|
|
2200
|
+
tabIndex?: number;
|
|
2201
|
+
};
|
|
2202
|
+
|
|
2203
|
+
declare const DxcLink: react.ForwardRefExoticComponent<LinkProps & react.RefAttributes<HTMLAnchorElement>>;
|
|
2204
|
+
|
|
2205
|
+
type SelectOption = {
|
|
2206
|
+
label?: string;
|
|
2207
|
+
value: string;
|
|
2208
|
+
onSelect: (value: string) => void;
|
|
2209
|
+
selected?: boolean;
|
|
2210
|
+
};
|
|
2211
|
+
type Props$k = {
|
|
2212
|
+
/**
|
|
2213
|
+
* If true, the voice recording button will be shown.
|
|
2214
|
+
*/
|
|
2215
|
+
allowRecording?: boolean;
|
|
2216
|
+
/**
|
|
2217
|
+
* This function will be called when the selection of top items changes.
|
|
2218
|
+
* If this function is provided the message input will allow file selection.
|
|
2219
|
+
*/
|
|
2220
|
+
callbackFile?: (files: File[]) => void;
|
|
2221
|
+
/**
|
|
2222
|
+
* Initial value of the input, only when it is uncontrolled.
|
|
2223
|
+
*/
|
|
2224
|
+
defaultValue?: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* If true, the component will be disabled.
|
|
2227
|
+
*/
|
|
2228
|
+
disabled?: boolean;
|
|
2229
|
+
/**
|
|
2230
|
+
* If it is a defined value and also a truthy string, the component will
|
|
2231
|
+
* change its appearance, showing the error below the input component. If
|
|
2232
|
+
* the defined value is an empty string, it will reserve a space below
|
|
2233
|
+
* the component for a future error, but it would not change its look. In
|
|
2234
|
+
* case of being undefined or null, both the appearance and the space for
|
|
2235
|
+
* the error message would not be modified.
|
|
2236
|
+
*/
|
|
2237
|
+
error?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* Items to be shown at the top.
|
|
2240
|
+
*/
|
|
2241
|
+
files?: File[];
|
|
2242
|
+
/**
|
|
2243
|
+
* If true, it indicates that a request is being processed after the user submits a query.
|
|
2244
|
+
*/
|
|
2245
|
+
isGenerating?: boolean;
|
|
2246
|
+
/**
|
|
2247
|
+
* Specifies the maximum length allowed by the input.
|
|
2248
|
+
* This will be checked both when the input element loses the
|
|
2249
|
+
* focus and while typing within it. If the string entered does not
|
|
2250
|
+
* comply the maximum length, the onBlur and onChange functions will be called
|
|
2251
|
+
* with the current value and an internal error informing that the value
|
|
2252
|
+
* length does not comply the specified range. If a valid length is
|
|
2253
|
+
* reached, the error parameter of both events will not be defined.
|
|
2254
|
+
*/
|
|
2255
|
+
maxLength?: number;
|
|
2256
|
+
/**
|
|
2257
|
+
* Specifies the minimum length allowed by the input.
|
|
2258
|
+
* This will be checked both when the input element loses the
|
|
2259
|
+
* focus and while typing within it. If the string entered does not
|
|
2260
|
+
* comply the minimum length, the onBlur and onChange functions will be called
|
|
2261
|
+
* with the current value and an internal error informing that the value
|
|
2262
|
+
* length does not comply the specified range. If a valid length is
|
|
2263
|
+
* reached, the error parameter of both events will not be defined.
|
|
2102
2264
|
*/
|
|
2103
|
-
|
|
2265
|
+
minLength?: number;
|
|
2104
2266
|
/**
|
|
2105
|
-
*
|
|
2267
|
+
* Options to be shown on the dropdown under the input.
|
|
2106
2268
|
*/
|
|
2107
|
-
|
|
2269
|
+
selectOptions?: SelectOption[];
|
|
2108
2270
|
/**
|
|
2109
|
-
*
|
|
2271
|
+
* This function will be called when the input element loses the focus.
|
|
2272
|
+
* An object including the input value and the error (if the value
|
|
2273
|
+
* entered is not valid) will be passed to this function. If there is no error,
|
|
2274
|
+
* error will not be defined.
|
|
2110
2275
|
*/
|
|
2111
|
-
|
|
2276
|
+
onBlur?: (val: {
|
|
2277
|
+
value: string;
|
|
2278
|
+
error?: string;
|
|
2279
|
+
}) => void;
|
|
2112
2280
|
/**
|
|
2113
|
-
*
|
|
2281
|
+
* This function will be called when the user types within the input
|
|
2282
|
+
* element of the component. An object including the current value and
|
|
2283
|
+
* the error (if the value entered is not valid) will be passed to this
|
|
2284
|
+
* function. If there is no error, error will not be defined.
|
|
2114
2285
|
*/
|
|
2115
|
-
|
|
2286
|
+
onChange?: (val: {
|
|
2287
|
+
value: string;
|
|
2288
|
+
error?: string;
|
|
2289
|
+
}) => void;
|
|
2116
2290
|
/**
|
|
2117
|
-
*
|
|
2118
|
-
*
|
|
2291
|
+
* This function will be called when the user clicks on the button (submit or stop) or presses enter.
|
|
2292
|
+
* The type parameter indicates whether it's a "submit" or "stop" event. For submit events, "value", "files" and "selectedOption" are provided.
|
|
2119
2293
|
*/
|
|
2120
|
-
|
|
2294
|
+
onButtonClick?: (val: {
|
|
2295
|
+
type: "submit" | "stop";
|
|
2296
|
+
value?: string;
|
|
2297
|
+
files?: File[];
|
|
2298
|
+
selectedOption?: SelectOption;
|
|
2299
|
+
}) => void;
|
|
2121
2300
|
/**
|
|
2122
|
-
* Text of the
|
|
2301
|
+
* Text to be put as placeholder of the input.
|
|
2123
2302
|
*/
|
|
2124
|
-
|
|
2303
|
+
placeholder?: string;
|
|
2125
2304
|
/**
|
|
2126
|
-
*
|
|
2127
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2305
|
+
* Specifies the size of the component. The size will affect the width of the input.
|
|
2128
2306
|
*/
|
|
2129
|
-
|
|
2307
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
2130
2308
|
/**
|
|
2131
|
-
* Value of the tabindex.
|
|
2309
|
+
* Value of the tabindex attribute.
|
|
2132
2310
|
*/
|
|
2133
2311
|
tabIndex?: number;
|
|
2312
|
+
/**
|
|
2313
|
+
* Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
2314
|
+
*/
|
|
2315
|
+
value?: string;
|
|
2134
2316
|
};
|
|
2135
2317
|
|
|
2136
|
-
declare const
|
|
2318
|
+
declare const DxcMessageInput: ({ allowRecording, callbackFile, defaultValue, disabled, error, files, isGenerating, maxLength, minLength, selectOptions, onBlur, onButtonClick, onChange, placeholder, size, tabIndex, value, }: Props$k) => react_jsx_runtime.JSX.Element;
|
|
2137
2319
|
|
|
2138
2320
|
type TabProps$1 = {
|
|
2139
2321
|
/**
|
|
@@ -2169,7 +2351,7 @@ type TabProps$1 = {
|
|
|
2169
2351
|
*/
|
|
2170
2352
|
notificationNumber?: boolean | number;
|
|
2171
2353
|
};
|
|
2172
|
-
type Props$
|
|
2354
|
+
type Props$j = {
|
|
2173
2355
|
/**
|
|
2174
2356
|
* Contains one or more DxcNavTabs.Tab.
|
|
2175
2357
|
*/
|
|
@@ -2185,11 +2367,11 @@ type Props$i = {
|
|
|
2185
2367
|
};
|
|
2186
2368
|
|
|
2187
2369
|
declare const DxcNavTabs: {
|
|
2188
|
-
({ iconPosition, tabIndex, children }: Props$
|
|
2370
|
+
({ iconPosition, tabIndex, children }: Props$j): JSX.Element;
|
|
2189
2371
|
Tab: react.ForwardRefExoticComponent<TabProps$1 & react.RefAttributes<HTMLDivElement | HTMLAnchorElement>>;
|
|
2190
2372
|
};
|
|
2191
2373
|
|
|
2192
|
-
type Props$
|
|
2374
|
+
type Props$i = {
|
|
2193
2375
|
/**
|
|
2194
2376
|
* Text to be placed above the number.
|
|
2195
2377
|
*/
|
|
@@ -2316,9 +2498,9 @@ type Props$h = {
|
|
|
2316
2498
|
showControls?: boolean;
|
|
2317
2499
|
};
|
|
2318
2500
|
|
|
2319
|
-
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$
|
|
2501
|
+
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$i & react.RefAttributes<HTMLDivElement>>;
|
|
2320
2502
|
|
|
2321
|
-
type Props$
|
|
2503
|
+
type Props$h = {
|
|
2322
2504
|
/**
|
|
2323
2505
|
* Number of the current selected page.
|
|
2324
2506
|
*/
|
|
@@ -2356,13 +2538,13 @@ type Props$g = {
|
|
|
2356
2538
|
tabIndex?: number;
|
|
2357
2539
|
};
|
|
2358
2540
|
|
|
2359
|
-
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$
|
|
2541
|
+
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$h) => JSX.Element;
|
|
2360
2542
|
|
|
2361
2543
|
declare function DxcParagraph({ children }: {
|
|
2362
2544
|
children: ReactNode;
|
|
2363
2545
|
}): react_jsx_runtime.JSX.Element;
|
|
2364
2546
|
|
|
2365
|
-
type Props$
|
|
2547
|
+
type Props$g = {
|
|
2366
2548
|
/**
|
|
2367
2549
|
* Text to be placed above the password input.
|
|
2368
2550
|
*/
|
|
@@ -2466,7 +2648,35 @@ type Props$f = {
|
|
|
2466
2648
|
ariaLabel?: string;
|
|
2467
2649
|
};
|
|
2468
2650
|
|
|
2469
|
-
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$
|
|
2651
|
+
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$g & react.RefAttributes<HTMLDivElement>>;
|
|
2652
|
+
|
|
2653
|
+
type PopoverPropsType = {
|
|
2654
|
+
/** Action that triggers the popover to open. */
|
|
2655
|
+
actionToOpen?: "click" | "hover";
|
|
2656
|
+
/** Alignment of the popover relative to the trigger element. */
|
|
2657
|
+
align?: "start" | "center" | "end";
|
|
2658
|
+
/** Set to true if child controls the events. It will render the child directly without wrapping it. */
|
|
2659
|
+
asChild?: boolean;
|
|
2660
|
+
/** Element that triggers the popover and works as the anchor. */
|
|
2661
|
+
children: React.ReactNode;
|
|
2662
|
+
/** Whether the popover should display a tip (arrow). */
|
|
2663
|
+
hasTip?: boolean;
|
|
2664
|
+
/** Controlled open state of the popover. If it is left undefined, it will be uncontrolled. */
|
|
2665
|
+
isOpen?: boolean;
|
|
2666
|
+
/** Distance in pixels from the trigger element to the popover. */
|
|
2667
|
+
offset?: number;
|
|
2668
|
+
/** Callback function when the popover is opened.
|
|
2669
|
+
* Used only in controlled mode and if the trigger lacks the events to manage the controlled behavior. */
|
|
2670
|
+
onOpen?: () => void;
|
|
2671
|
+
/** Callback function when the popover is closed. */
|
|
2672
|
+
onClose?: () => void;
|
|
2673
|
+
/** Content to be displayed inside the popover. */
|
|
2674
|
+
popoverContent: React.ReactNode;
|
|
2675
|
+
/** Side of the trigger where the popover will appear. */
|
|
2676
|
+
side?: "top" | "bottom" | "left" | "right";
|
|
2677
|
+
};
|
|
2678
|
+
|
|
2679
|
+
declare const DxcPopover: ({ actionToOpen, align, asChild, children, hasTip, isOpen, offset, onOpen, onClose, popoverContent, side, }: PopoverPropsType) => JSX.Element;
|
|
2470
2680
|
|
|
2471
2681
|
type Size$1 = {
|
|
2472
2682
|
top?: Space$1;
|
|
@@ -2474,7 +2684,7 @@ type Size$1 = {
|
|
|
2474
2684
|
left?: Space$1;
|
|
2475
2685
|
right?: Space$1;
|
|
2476
2686
|
};
|
|
2477
|
-
type Props$
|
|
2687
|
+
type Props$f = {
|
|
2478
2688
|
/**
|
|
2479
2689
|
* Text to be placed above the progress bar.
|
|
2480
2690
|
*/
|
|
@@ -2508,7 +2718,7 @@ type Props$e = {
|
|
|
2508
2718
|
ariaLabel?: string;
|
|
2509
2719
|
};
|
|
2510
2720
|
|
|
2511
|
-
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$
|
|
2721
|
+
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$f) => JSX.Element;
|
|
2512
2722
|
|
|
2513
2723
|
type Link = {
|
|
2514
2724
|
/**
|
|
@@ -2520,7 +2730,7 @@ type Link = {
|
|
|
2520
2730
|
*/
|
|
2521
2731
|
links?: Link[];
|
|
2522
2732
|
};
|
|
2523
|
-
type Props$
|
|
2733
|
+
type Props$e = {
|
|
2524
2734
|
/**
|
|
2525
2735
|
* Title of the quick nav component.
|
|
2526
2736
|
*/
|
|
@@ -2531,7 +2741,7 @@ type Props$d = {
|
|
|
2531
2741
|
links: Link[];
|
|
2532
2742
|
};
|
|
2533
2743
|
|
|
2534
|
-
declare function DxcQuickNav({ links, title }: Props$
|
|
2744
|
+
declare function DxcQuickNav({ links, title }: Props$e): react_jsx_runtime.JSX.Element;
|
|
2535
2745
|
|
|
2536
2746
|
type Option$1 = {
|
|
2537
2747
|
/**
|
|
@@ -2732,10 +2942,10 @@ type NonPaginatedProps = CommonProps$3 & {
|
|
|
2732
2942
|
*/
|
|
2733
2943
|
showGoToPage?: never;
|
|
2734
2944
|
};
|
|
2735
|
-
type Props$
|
|
2945
|
+
type Props$d = PaginatedProps | NonPaginatedProps;
|
|
2736
2946
|
|
|
2737
2947
|
declare const DxcResultsetTable: {
|
|
2738
|
-
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$
|
|
2948
|
+
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$d): react_jsx_runtime.JSX.Element;
|
|
2739
2949
|
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
2740
2950
|
};
|
|
2741
2951
|
|
|
@@ -2927,11 +3137,11 @@ type MultipleSelect = CommonProps$2 & {
|
|
|
2927
3137
|
*/
|
|
2928
3138
|
value?: string[];
|
|
2929
3139
|
};
|
|
2930
|
-
type Props$
|
|
3140
|
+
type Props$c = SingleSelect | MultipleSelect;
|
|
2931
3141
|
|
|
2932
|
-
declare const DxcSelect: react.ForwardRefExoticComponent<Props$
|
|
3142
|
+
declare const DxcSelect: react.ForwardRefExoticComponent<Props$c & react.RefAttributes<HTMLDivElement>>;
|
|
2933
3143
|
|
|
2934
|
-
type Props$
|
|
3144
|
+
type Props$b = {
|
|
2935
3145
|
/**
|
|
2936
3146
|
* Specifies a string to be used as the name for the slider element when no `label` is provided.
|
|
2937
3147
|
*/
|
|
@@ -3010,9 +3220,9 @@ type Props$a = {
|
|
|
3010
3220
|
value?: number;
|
|
3011
3221
|
};
|
|
3012
3222
|
|
|
3013
|
-
declare const DxcSlider: react.ForwardRefExoticComponent<Props$
|
|
3223
|
+
declare const DxcSlider: react.ForwardRefExoticComponent<Props$b & react.RefAttributes<HTMLDivElement>>;
|
|
3014
3224
|
|
|
3015
|
-
type Props$
|
|
3225
|
+
type Props$a = {
|
|
3016
3226
|
/**
|
|
3017
3227
|
* 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.
|
|
3018
3228
|
*/
|
|
@@ -3046,11 +3256,11 @@ type Props$9 = {
|
|
|
3046
3256
|
value?: number;
|
|
3047
3257
|
};
|
|
3048
3258
|
|
|
3049
|
-
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$
|
|
3259
|
+
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$a) => react_jsx_runtime.JSX.Element;
|
|
3050
3260
|
|
|
3051
3261
|
type Mode = "default" | "info" | "success" | "warning" | "error";
|
|
3052
3262
|
type Size = "small" | "medium" | "large";
|
|
3053
|
-
type Props$
|
|
3263
|
+
type Props$9 = {
|
|
3054
3264
|
/**
|
|
3055
3265
|
* It will define the color of the light based on its semantic meaning.
|
|
3056
3266
|
*/
|
|
@@ -3065,9 +3275,9 @@ type Props$8 = {
|
|
|
3065
3275
|
size?: Size;
|
|
3066
3276
|
};
|
|
3067
3277
|
|
|
3068
|
-
declare function DxcStatusLight({ label, mode, size }: Props$
|
|
3278
|
+
declare function DxcStatusLight({ label, mode, size }: Props$9): react_jsx_runtime.JSX.Element;
|
|
3069
3279
|
|
|
3070
|
-
type Props$
|
|
3280
|
+
type Props$8 = {
|
|
3071
3281
|
/**
|
|
3072
3282
|
* Specifies a string to be used as the name for the switch element when no `label` is provided.
|
|
3073
3283
|
*/
|
|
@@ -3126,10 +3336,10 @@ type Props$7 = {
|
|
|
3126
3336
|
value?: string;
|
|
3127
3337
|
};
|
|
3128
3338
|
|
|
3129
|
-
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$
|
|
3339
|
+
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$8 & react.RefAttributes<HTMLDivElement>>;
|
|
3130
3340
|
|
|
3131
3341
|
declare const DxcTable: {
|
|
3132
|
-
({ children, margin, mode }: Props$
|
|
3342
|
+
({ children, margin, mode }: Props$u): react_jsx_runtime.JSX.Element;
|
|
3133
3343
|
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
3134
3344
|
};
|
|
3135
3345
|
|
|
@@ -3171,14 +3381,14 @@ type TabsProps = {
|
|
|
3171
3381
|
*/
|
|
3172
3382
|
children?: ReactNode;
|
|
3173
3383
|
};
|
|
3174
|
-
type Props$
|
|
3384
|
+
type Props$7 = TabsProps;
|
|
3175
3385
|
|
|
3176
3386
|
declare const DxcTabs: {
|
|
3177
|
-
({ children, iconPosition, margin, tabIndex }: Props$
|
|
3387
|
+
({ children, iconPosition, margin, tabIndex }: Props$7): react_jsx_runtime.JSX.Element;
|
|
3178
3388
|
Tab: react.ForwardRefExoticComponent<TabProps & react.RefAttributes<HTMLButtonElement>>;
|
|
3179
3389
|
};
|
|
3180
3390
|
|
|
3181
|
-
type Props$
|
|
3391
|
+
type Props$6 = {
|
|
3182
3392
|
/**
|
|
3183
3393
|
* Specifies a string to be used as the name for the textarea element when no `label` is provided.
|
|
3184
3394
|
*/
|
|
@@ -3312,7 +3522,7 @@ type Props$5 = {
|
|
|
3312
3522
|
verticalGrow?: "auto" | "manual" | "none";
|
|
3313
3523
|
};
|
|
3314
3524
|
|
|
3315
|
-
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$
|
|
3525
|
+
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$6 & react.RefAttributes<HTMLDivElement>>;
|
|
3316
3526
|
|
|
3317
3527
|
type Action$1 = {
|
|
3318
3528
|
/**
|
|
@@ -3330,7 +3540,7 @@ type Action$1 = {
|
|
|
3330
3540
|
*/
|
|
3331
3541
|
title?: string;
|
|
3332
3542
|
};
|
|
3333
|
-
type Props$
|
|
3543
|
+
type Props$5 = {
|
|
3334
3544
|
/**
|
|
3335
3545
|
* Sets the alignment inside the input.
|
|
3336
3546
|
*/
|
|
@@ -3483,7 +3693,96 @@ type Props$4 = {
|
|
|
3483
3693
|
ariaLabel?: string;
|
|
3484
3694
|
};
|
|
3485
3695
|
|
|
3486
|
-
declare const DxcTextInput: react.ForwardRefExoticComponent<Props$
|
|
3696
|
+
declare const DxcTextInput: react.ForwardRefExoticComponent<Props$5 & react.RefAttributes<HTMLDivElement>>;
|
|
3697
|
+
|
|
3698
|
+
type Props$4 = {
|
|
3699
|
+
/**
|
|
3700
|
+
* Specifies a string to be used as the name for the timeInput element when no `label` is provided.
|
|
3701
|
+
*/
|
|
3702
|
+
ariaLabel?: string;
|
|
3703
|
+
/**
|
|
3704
|
+
* If true, the input will have an action to clear the entered value.
|
|
3705
|
+
*/
|
|
3706
|
+
clearable?: boolean;
|
|
3707
|
+
/**
|
|
3708
|
+
* Initial value of the input, only when it is uncontrolled.
|
|
3709
|
+
*/
|
|
3710
|
+
defaultValue?: string;
|
|
3711
|
+
/**
|
|
3712
|
+
* If true, the component will be disabled.
|
|
3713
|
+
*/
|
|
3714
|
+
disabled?: boolean;
|
|
3715
|
+
/**
|
|
3716
|
+
* If it is a defined value and also a truthy string, the component will
|
|
3717
|
+
* change its appearance, showing the error below the input component. If
|
|
3718
|
+
* the defined value is an empty string, it will reserve a space below
|
|
3719
|
+
* the component for a future error, but it would not change its look. In
|
|
3720
|
+
* case of being undefined or null, both the appearance and the space for
|
|
3721
|
+
* the error message would not be modified.
|
|
3722
|
+
*/
|
|
3723
|
+
error?: string;
|
|
3724
|
+
/**
|
|
3725
|
+
* Helper text to be placed above the input.
|
|
3726
|
+
*/
|
|
3727
|
+
helperText?: string;
|
|
3728
|
+
/**
|
|
3729
|
+
* Text to be placed above the input.
|
|
3730
|
+
*/
|
|
3731
|
+
label?: string;
|
|
3732
|
+
/**
|
|
3733
|
+
* Name attribute of the input element.
|
|
3734
|
+
*/
|
|
3735
|
+
name?: string;
|
|
3736
|
+
/**
|
|
3737
|
+
* This function will be called when the input element loses the focus.
|
|
3738
|
+
* An object including the input value and the error (if the value
|
|
3739
|
+
* entered is not valid) will be passed to this function. If there is no error,
|
|
3740
|
+
* error will not be defined.
|
|
3741
|
+
*/
|
|
3742
|
+
onBlur?: (val: {
|
|
3743
|
+
value: string;
|
|
3744
|
+
error?: string;
|
|
3745
|
+
}) => void;
|
|
3746
|
+
/**
|
|
3747
|
+
* This function will be called when the user types within the input
|
|
3748
|
+
* or selects a value in the dropdown element of the component.
|
|
3749
|
+
*/
|
|
3750
|
+
onChange?: (value: string) => void;
|
|
3751
|
+
/**
|
|
3752
|
+
* If true, the input will be optional, showing '(Optional)'
|
|
3753
|
+
* next to the label. Otherwise, the field will be considered required and an error will be
|
|
3754
|
+
* passed as a parameter to the OnBlur function when it has
|
|
3755
|
+
* not been filled.
|
|
3756
|
+
*/
|
|
3757
|
+
optional?: boolean;
|
|
3758
|
+
/**
|
|
3759
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3760
|
+
* In addition, the clear action will not be displayed even if the flag is set to true.
|
|
3761
|
+
*/
|
|
3762
|
+
readOnly?: boolean;
|
|
3763
|
+
/**
|
|
3764
|
+
* 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.
|
|
3765
|
+
*/
|
|
3766
|
+
showSeconds?: boolean;
|
|
3767
|
+
/**
|
|
3768
|
+
* Size of the component.
|
|
3769
|
+
*/
|
|
3770
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
3771
|
+
/**
|
|
3772
|
+
* Value of the tabindex attribute.
|
|
3773
|
+
*/
|
|
3774
|
+
tabIndex?: number;
|
|
3775
|
+
/**
|
|
3776
|
+
* Time format of the input. It can be either 12 or 24.
|
|
3777
|
+
*/
|
|
3778
|
+
timeFormat?: "12" | "24";
|
|
3779
|
+
/**
|
|
3780
|
+
* Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3781
|
+
*/
|
|
3782
|
+
value?: string;
|
|
3783
|
+
};
|
|
3784
|
+
|
|
3785
|
+
declare const DxcTimeInput: react.ForwardRefExoticComponent<Props$4 & react.RefAttributes<HTMLDivElement>>;
|
|
3487
3786
|
|
|
3488
3787
|
type Action = {
|
|
3489
3788
|
/**
|
|
@@ -3752,8 +4051,12 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3752
4051
|
previousMonthTitle: string;
|
|
3753
4052
|
nextMonthTitle: string;
|
|
3754
4053
|
};
|
|
4054
|
+
card: {
|
|
4055
|
+
noContent: string;
|
|
4056
|
+
};
|
|
3755
4057
|
dateInput: {
|
|
3756
4058
|
invalidDateErrorMessage: string;
|
|
4059
|
+
datePickerActionTitle: string;
|
|
3757
4060
|
};
|
|
3758
4061
|
dialog: {
|
|
3759
4062
|
closeIconAriaLabel: string;
|
|
@@ -3776,13 +4079,21 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3776
4079
|
requiredSelectionErrorMessage: string;
|
|
3777
4080
|
requiredValueErrorMessage: string;
|
|
3778
4081
|
formatRequestedErrorMessage: string;
|
|
3779
|
-
|
|
3780
|
-
|
|
4082
|
+
minLengthErrorMessage: (minLength: number) => string;
|
|
4083
|
+
maxLengthErrorMessage: (maxLength: number) => string;
|
|
3781
4084
|
};
|
|
3782
4085
|
header: {
|
|
3783
4086
|
closeIcon: string;
|
|
3784
4087
|
hamburgerTitle: string;
|
|
3785
4088
|
};
|
|
4089
|
+
messageInput: {
|
|
4090
|
+
inputAriaLabel: string;
|
|
4091
|
+
sendButtonTitle: string;
|
|
4092
|
+
stopButtonTitle: string;
|
|
4093
|
+
attachFileButtonTitle: string;
|
|
4094
|
+
recordAudioButtonTitle: string;
|
|
4095
|
+
stopRecordingButtonTitle: string;
|
|
4096
|
+
};
|
|
3786
4097
|
numberInput: {
|
|
3787
4098
|
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
3788
4099
|
valueLessThanOrEqualToErrorMessage: (value: number) => string;
|
|
@@ -3830,11 +4141,20 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3830
4141
|
searchingMessage: string;
|
|
3831
4142
|
fetchingDataErrorMessage: string;
|
|
3832
4143
|
};
|
|
4144
|
+
timeInput: {
|
|
4145
|
+
timePickerActionTitle: string;
|
|
4146
|
+
timePeriodAM: string;
|
|
4147
|
+
timePeriodPM: string;
|
|
4148
|
+
};
|
|
3833
4149
|
toast: {
|
|
3834
4150
|
clearToastActionTitle: string;
|
|
3835
4151
|
};
|
|
3836
4152
|
};
|
|
3837
4153
|
type TranslatedLabels = typeof defaultTranslatedComponentLabels;
|
|
4154
|
+
type LocalizedContext = {
|
|
4155
|
+
labels: TranslatedLabels;
|
|
4156
|
+
locale?: string;
|
|
4157
|
+
};
|
|
3838
4158
|
|
|
3839
4159
|
/**
|
|
3840
4160
|
* This type is used to allow labels objects to be passed to the HalstackProvider.
|
|
@@ -3843,111 +4163,18 @@ type TranslatedLabels = typeof defaultTranslatedComponentLabels;
|
|
|
3843
4163
|
type DeepPartial<T> = {
|
|
3844
4164
|
[P in keyof T]?: Partial<T[P]>;
|
|
3845
4165
|
};
|
|
3846
|
-
declare const HalstackLanguageContext: react.Context<
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
previousMessageActionTitle: string;
|
|
3852
|
-
nextMessageActionTitle: string;
|
|
3853
|
-
closeAlertActionTitle: string;
|
|
3854
|
-
closeMessageActionTitle: string;
|
|
3855
|
-
};
|
|
3856
|
-
calendar: {
|
|
3857
|
-
daysShort: string[];
|
|
3858
|
-
months: string[];
|
|
3859
|
-
previousMonthTitle: string;
|
|
3860
|
-
nextMonthTitle: string;
|
|
3861
|
-
};
|
|
3862
|
-
dateInput: {
|
|
3863
|
-
invalidDateErrorMessage: string;
|
|
3864
|
-
};
|
|
3865
|
-
dialog: {
|
|
3866
|
-
closeIconAriaLabel: string;
|
|
3867
|
-
};
|
|
3868
|
-
fileInput: {
|
|
3869
|
-
fileSizeGreaterThanErrorMessage: string;
|
|
3870
|
-
fileSizeLessThanErrorMessage: string;
|
|
3871
|
-
multipleButtonLabelDefault: string;
|
|
3872
|
-
singleButtonLabelDefault: string;
|
|
3873
|
-
dropAreaButtonLabelDefault: string;
|
|
3874
|
-
multipleDropAreaLabelDefault: string;
|
|
3875
|
-
singleDropAreaLabelDefault: string;
|
|
3876
|
-
deleteFileActionTitle: string;
|
|
3877
|
-
};
|
|
3878
|
-
footer: {
|
|
3879
|
-
copyrightText: (year: number) => string;
|
|
3880
|
-
};
|
|
3881
|
-
formFields: {
|
|
3882
|
-
optionalLabel: string;
|
|
3883
|
-
requiredSelectionErrorMessage: string;
|
|
3884
|
-
requiredValueErrorMessage: string;
|
|
3885
|
-
formatRequestedErrorMessage: string;
|
|
3886
|
-
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
3887
|
-
logoAlternativeText: string;
|
|
3888
|
-
};
|
|
3889
|
-
header: {
|
|
3890
|
-
closeIcon: string;
|
|
3891
|
-
hamburgerTitle: string;
|
|
3892
|
-
};
|
|
3893
|
-
numberInput: {
|
|
3894
|
-
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
3895
|
-
valueLessThanOrEqualToErrorMessage: (value: number) => string;
|
|
3896
|
-
decrementValueTitle: string;
|
|
3897
|
-
incrementValueTitle: string;
|
|
3898
|
-
};
|
|
3899
|
-
paginator: {
|
|
3900
|
-
itemsPerPageText: string;
|
|
3901
|
-
minToMaxOfText: (minNumberOfItems: number, maxNumberOfItems: number, totalItems: number) => string;
|
|
3902
|
-
goToPageText: string;
|
|
3903
|
-
pageOfText: (pageNumber: number, totalPagesNumber: number) => string;
|
|
3904
|
-
firstResultsTitle: string;
|
|
3905
|
-
previousResultsTitle: string;
|
|
3906
|
-
nextResultsTitle: string;
|
|
3907
|
-
lastResultsTitle: string;
|
|
3908
|
-
};
|
|
3909
|
-
passwordInput: {
|
|
3910
|
-
inputShowPasswordTitle: string;
|
|
3911
|
-
inputHidePasswordTitle: string;
|
|
3912
|
-
};
|
|
3913
|
-
quickNav: {
|
|
3914
|
-
contentTitle: string;
|
|
3915
|
-
};
|
|
3916
|
-
radioGroup: {
|
|
3917
|
-
optionalItemLabelDefault: string;
|
|
3918
|
-
};
|
|
3919
|
-
searchBar: {
|
|
3920
|
-
clearFieldActionTitle: string;
|
|
3921
|
-
inputAriaLabel: string;
|
|
3922
|
-
triggerTitle: string;
|
|
3923
|
-
cancelButtonLabel: string;
|
|
3924
|
-
};
|
|
3925
|
-
select: {
|
|
3926
|
-
actionClearSelectionTitle: string;
|
|
3927
|
-
actionClearSearchTitle: string;
|
|
3928
|
-
noMatchesErrorMessage: string;
|
|
3929
|
-
selectAllLabel: string;
|
|
3930
|
-
};
|
|
3931
|
-
tabs: {
|
|
3932
|
-
scrollLeft: string;
|
|
3933
|
-
scrollRight: string;
|
|
3934
|
-
};
|
|
3935
|
-
textInput: {
|
|
3936
|
-
clearFieldActionTitle: string;
|
|
3937
|
-
searchingMessage: string;
|
|
3938
|
-
fetchingDataErrorMessage: string;
|
|
3939
|
-
};
|
|
3940
|
-
toast: {
|
|
3941
|
-
clearToastActionTitle: string;
|
|
3942
|
-
};
|
|
3943
|
-
}>;
|
|
3944
|
-
type ThemeType = Record<string, string | number>;
|
|
4166
|
+
declare const HalstackLanguageContext: react.Context<LocalizedContext>;
|
|
4167
|
+
type ThemeType = {
|
|
4168
|
+
tokens?: Record<string, string | number>;
|
|
4169
|
+
logos?: Record<string, string | undefined>;
|
|
4170
|
+
};
|
|
3945
4171
|
type HalstackProviderPropsType = {
|
|
3946
4172
|
labels?: DeepPartial<TranslatedLabels>;
|
|
3947
4173
|
children: ReactNode;
|
|
3948
4174
|
opinionatedTheme?: ThemeType;
|
|
4175
|
+
localeTag?: string;
|
|
3949
4176
|
};
|
|
3950
|
-
declare const HalstackProvider: ({ labels, children, opinionatedTheme }: HalstackProviderPropsType) => JSX.Element;
|
|
4177
|
+
declare const HalstackProvider: ({ labels, children, opinionatedTheme, localeTag, }: HalstackProviderPropsType) => JSX.Element;
|
|
3951
4178
|
|
|
3952
4179
|
declare function useToast(): {
|
|
3953
4180
|
default: (toast: DefaultToast) => (() => void) | undefined;
|
|
@@ -3957,4 +4184,4 @@ declare function useToast(): {
|
|
|
3957
4184
|
loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
|
|
3958
4185
|
};
|
|
3959
4186
|
|
|
3960
|
-
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 };
|
|
4187
|
+
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, DxcMessageInput, 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 };
|