@dxc-technology/halstack-react 0.0.0-bac56e4 → 0.0.0-bb6d27a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -276,7 +276,7 @@ type Props$H = {
276
276
  };
277
277
 
278
278
  type Size$4 = "small" | "medium" | "large" | "fillParent" | "fitContent";
279
- type Option$1 = {
279
+ type Option$2 = {
280
280
  /**
281
281
  * Option display value.
282
282
  */
@@ -294,7 +294,7 @@ type Props$G = {
294
294
  /**
295
295
  * An array of objects representing the options.
296
296
  */
297
- options: Option$1[];
297
+ options: Option$2[];
298
298
  /**
299
299
  * In case options include icons, whether the icon should appear
300
300
  * after or before the label.
@@ -544,44 +544,42 @@ type Props$E = (ContextualProps | NotificationProps) & CommonProps$7;
544
544
 
545
545
  declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$E) => JSX.Element;
546
546
 
547
- type CoreSpacingTokensType = "0rem" | "0.125rem" | "0.25rem" | "0.5rem" | "0.75rem" | "1rem" | "1.5rem" | "2rem" | "2.5rem" | "3rem" | "3.5rem" | "4rem" | "5rem" | "6rem" | "7rem";
548
-
549
547
  type Props$D = {
550
548
  /**
551
549
  * Applies the spacing scale to all sides.
552
550
  */
553
- space?: CoreSpacingTokensType;
551
+ space?: string;
554
552
  /**
555
553
  * Applies the spacing scale to the left and right sides.
556
554
  */
557
- horizontal?: CoreSpacingTokensType;
555
+ horizontal?: string;
558
556
  /**
559
557
  * Applies the spacing scale to the top and bottom sides.
560
558
  */
561
- vertical?: CoreSpacingTokensType;
559
+ vertical?: string;
562
560
  /**
563
561
  * Applies the spacing scale to the top side.
564
562
  */
565
- top?: CoreSpacingTokensType;
563
+ top?: string;
566
564
  /**
567
565
  * Applies the spacing scale to the right side.
568
566
  */
569
- right?: CoreSpacingTokensType;
567
+ right?: string;
570
568
  /**
571
569
  * Applies the spacing scale to the bottom side.
572
570
  */
573
- bottom?: CoreSpacingTokensType;
571
+ bottom?: string;
574
572
  /**
575
573
  * Applies the spacing scale to the left side.
576
574
  */
577
- left?: CoreSpacingTokensType;
575
+ left?: string;
578
576
  /**
579
577
  * Custom content inside the bleed.
580
578
  */
581
579
  children: ReactNode;
582
580
  };
583
581
 
584
- declare const Bleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$D) => react_jsx_runtime.JSX.Element;
582
+ declare function DxcBleed({ space, horizontal, vertical, top, right, bottom, left, children }: Props$D): react_jsx_runtime.JSX.Element;
585
583
 
586
584
  type Item$1 = {
587
585
  href?: string;
@@ -786,7 +784,7 @@ type Props$z = {
786
784
  children?: ReactNode;
787
785
  };
788
786
 
789
- declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$z) => JSX.Element;
787
+ declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$z) => react_jsx_runtime.JSX.Element;
790
788
 
791
789
  type Props$y = {
792
790
  /**
@@ -1100,7 +1098,7 @@ type ActionsPropsType = Array<{
1100
1098
  onClick: (value?: string) => void;
1101
1099
  disabled?: boolean;
1102
1100
  tabIndex?: number;
1103
- options: Option$1[];
1101
+ options: Option$2[];
1104
1102
  }>;
1105
1103
  type Props$u = {
1106
1104
  /**
@@ -1171,6 +1169,7 @@ type HierarchyGridRow = GridRow & {
1171
1169
  type ExpandableGridRow = GridRow & {
1172
1170
  expandedContent?: ReactNode;
1173
1171
  expandedContentHeight?: number;
1172
+ contentIsExpanded?: boolean;
1174
1173
  };
1175
1174
  type ExpandableRows = {
1176
1175
  rows: ExpandableGridRow[];
@@ -1247,6 +1246,10 @@ type PaginatedProps$1 = {
1247
1246
  * Function called whenever the current page is changed.
1248
1247
  */
1249
1248
  onPageChange?: (_page: number) => void;
1249
+ /**
1250
+ * Default page in which the datagrid is rendered
1251
+ */
1252
+ defaultPage?: number;
1250
1253
  };
1251
1254
  type NonPaginatedProps$1 = {
1252
1255
  /**
@@ -1278,6 +1281,10 @@ type NonPaginatedProps$1 = {
1278
1281
  * Function called whenever the current page is changed.
1279
1282
  */
1280
1283
  onPageChange?: never;
1284
+ /**
1285
+ * Default page in which the datagrid is rendered
1286
+ */
1287
+ defaultPage?: never;
1281
1288
  };
1282
1289
  type CommonProps$6 = {
1283
1290
  columns: GridColumn[];
@@ -1305,7 +1312,7 @@ type BasicGridProps = {
1305
1312
  type Props$t = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((BasicGridProps & SelectableGridProps) | (ExpandableRows & SelectableGridProps) | (HierarchyRows & SelectableGridProps));
1306
1313
 
1307
1314
  declare const DxcDataGrid: {
1308
- ({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, }: Props$t): JSX.Element;
1315
+ ({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$t): JSX.Element;
1309
1316
  ActionsCell: ({ actions }: ActionCellsPropsType) => JSX.Element;
1310
1317
  };
1311
1318
 
@@ -1475,7 +1482,7 @@ type Props$q = {
1475
1482
  decorative?: boolean;
1476
1483
  };
1477
1484
 
1478
- declare const DxcDivider: ({ orientation, weight, color, decorative, }: Props$q) => react_jsx_runtime.JSX.Element;
1485
+ declare function DxcDivider({ color, decorative, orientation, weight, }: Props$q): react_jsx_runtime.JSX.Element;
1479
1486
 
1480
1487
  declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$G) => react_jsx_runtime.JSX.Element;
1481
1488
 
@@ -1794,7 +1801,7 @@ type Props$m = {
1794
1801
  * The html tag of the heading will be the one specified in the 'as' prop.
1795
1802
  * If 'as' is not specified, the html tag of the heading is the one specified in the 'level' prop.
1796
1803
  */
1797
- level?: 1 | 2 | 3 | 4 | 5;
1804
+ level?: 1 | 2 | 3 | 4 | 5 | 6;
1798
1805
  /**
1799
1806
  * Heading text.
1800
1807
  */
@@ -1802,11 +1809,11 @@ type Props$m = {
1802
1809
  /**
1803
1810
  * Modifies the default weight of the heading.
1804
1811
  */
1805
- weight?: "light" | "normal" | "bold";
1812
+ weight?: "light" | "default" | "regular";
1806
1813
  /**
1807
1814
  * Specifies the HTML tag of the heading.
1808
1815
  */
1809
- as?: "h1" | "h2" | "h3" | "h4" | "h5";
1816
+ as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
1810
1817
  /**
1811
1818
  * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
1812
1819
  * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
@@ -1814,7 +1821,7 @@ type Props$m = {
1814
1821
  margin?: Space$1 | Margin;
1815
1822
  };
1816
1823
 
1817
- declare const DxcHeading: ({ level, text, as, weight, margin }: Props$m) => JSX.Element;
1824
+ declare function DxcHeading({ as, level, margin, text, weight }: Props$m): react_jsx_runtime.JSX.Element;
1818
1825
 
1819
1826
  type Props$l = {
1820
1827
  /**
@@ -1829,21 +1836,35 @@ type Props$l = {
1829
1836
  * which is required regardless of the presence of the caption or not.
1830
1837
  */
1831
1838
  caption?: string;
1839
+ /**
1840
+ * Sets the rendered height of the image.
1841
+ */
1842
+ height?: string;
1832
1843
  /**
1833
1844
  * If true, the image will be loaded only when it is visible on the screen (lazy loading).
1834
1845
  * Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
1835
1846
  */
1836
1847
  lazyLoading?: boolean;
1837
1848
  /**
1838
- * URL of the image. This prop is required and must be valid.
1849
+ * Sets the object-fit CSS property.
1850
+ *
1851
+ * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
1839
1852
  */
1840
- src: string;
1853
+ objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
1841
1854
  /**
1842
- * List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
1855
+ * Sets the object-position CSS property.
1843
1856
  *
1844
- * See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
1857
+ * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
1845
1858
  */
1846
- srcSet?: string;
1859
+ objectPosition?: string;
1860
+ /**
1861
+ * This function will be called when the image fails to load.
1862
+ */
1863
+ onError?: ReactEventHandler<HTMLImageElement>;
1864
+ /**
1865
+ * This function will be called when the image is loaded.
1866
+ */
1867
+ onLoad?: ReactEventHandler<HTMLImageElement>;
1847
1868
  /**
1848
1869
  * One or more strings separated by commas, indicating a set of source sizes.
1849
1870
  * If the srcSet attribute is absent or contains no values with a width descriptor,
@@ -1853,36 +1874,22 @@ type Props$l = {
1853
1874
  */
1854
1875
  sizes?: string;
1855
1876
  /**
1856
- * Sets the rendered width of the image.
1857
- */
1858
- width?: string;
1859
- /**
1860
- * Sets the rendered height of the image.
1861
- */
1862
- height?: string;
1863
- /**
1864
- * Sets the object-fit CSS property.
1865
- *
1866
- * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
1877
+ * URL of the image. This prop is required and must be valid.
1867
1878
  */
1868
- objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
1879
+ src: string;
1869
1880
  /**
1870
- * Sets the object-position CSS property.
1881
+ * List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
1871
1882
  *
1872
- * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
1873
- */
1874
- objectPosition?: string;
1875
- /**
1876
- * This function will be called when the image is loaded.
1883
+ * See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
1877
1884
  */
1878
- onLoad?: ReactEventHandler<HTMLImageElement>;
1885
+ srcSet?: string;
1879
1886
  /**
1880
- * This function will be called when the image fails to load.
1887
+ * Sets the rendered width of the image.
1881
1888
  */
1882
- onError?: ReactEventHandler<HTMLImageElement>;
1889
+ width?: string;
1883
1890
  };
1884
1891
 
1885
- declare function DxcImage({ alt, caption, lazyLoading, src, srcSet, sizes, width, height, objectFit, objectPosition, onLoad, onError, }: Props$l): react_jsx_runtime.JSX.Element;
1892
+ declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$l): react_jsx_runtime.JSX.Element;
1886
1893
 
1887
1894
  type Props$k = {
1888
1895
  /**
@@ -2360,9 +2367,9 @@ type Props$e = {
2360
2367
  links: Link[];
2361
2368
  };
2362
2369
 
2363
- declare const DxcQuickNav: ({ title, links }: Props$e) => JSX.Element;
2370
+ declare function DxcQuickNav({ links, title }: Props$e): react_jsx_runtime.JSX.Element;
2364
2371
 
2365
- type RadioOption = {
2372
+ type Option$1 = {
2366
2373
  /**
2367
2374
  * Label of the option placed next to the radio input.
2368
2375
  */
@@ -2380,26 +2387,39 @@ type RadioOption = {
2380
2387
  };
2381
2388
  type RadioGroupProps = {
2382
2389
  /**
2383
- * Text to be placed above the radio group.
2390
+ * Specifies a string to be used as the name for the radio group when no `label` is provided.
2384
2391
  */
2385
- label?: string;
2392
+ ariaLabel?: string;
2386
2393
  /**
2387
- * Name attribute of the input element. This attribute will allow users
2388
- * to find the component's value during the submit event.
2394
+ * Initial value of the radio group, only when it is uncontrolled.
2389
2395
  */
2390
- name?: string;
2396
+ defaultValue?: string;
2397
+ /**
2398
+ * If true, the component will be disabled.
2399
+ */
2400
+ disabled?: boolean;
2401
+ /**
2402
+ * If it is a defined value and also a truthy string, the component will
2403
+ * change its appearance, showing the error below the radio group. If the
2404
+ * defined value is an empty string, it will reserve a space below the
2405
+ * component for a future error, but it would not change its look. In
2406
+ * case of being undefined or null, both the appearance and the space for
2407
+ * the error message would not be modified.
2408
+ */
2409
+ error?: string;
2391
2410
  /**
2392
2411
  * Helper text to be placed above the radio group.
2393
2412
  */
2394
2413
  helperText?: string;
2395
2414
  /**
2396
- * An array of objects representing the selectable options.
2415
+ * Text to be placed above the radio group.
2397
2416
  */
2398
- options: RadioOption[];
2417
+ label?: string;
2399
2418
  /**
2400
- * If true, the component will be disabled.
2419
+ * Name attribute of the input element. This attribute will allow users
2420
+ * to find the component's value during the submit event.
2401
2421
  */
2402
- disabled?: boolean;
2422
+ name?: string;
2403
2423
  /**
2404
2424
  * If true, the radio group will be optional, showing
2405
2425
  * (Optional) next to the label and adding a default last
@@ -2413,28 +2433,9 @@ type RadioGroupProps = {
2413
2433
  */
2414
2434
  optionalItemLabel?: string;
2415
2435
  /**
2416
- * If true, the component will not be mutable, meaning the user can not edit the control.
2417
- */
2418
- readOnly?: boolean;
2419
- /**
2420
- * Sets the orientation of the options within the radio group.
2421
- */
2422
- stacking?: "row" | "column";
2423
- /**
2424
- * Initial value of the radio group, only when it is uncontrolled.
2425
- */
2426
- defaultValue?: string;
2427
- /**
2428
- * Value of the radio group. If undefined, the component will be
2429
- * uncontrolled and the value will be managed internally by the
2430
- * component.
2431
- */
2432
- value?: string;
2433
- /**
2434
- * This function will be called when the user chooses an option. The new
2435
- * value will be passed to this function.
2436
+ * An array of objects representing the selectable options.
2436
2437
  */
2437
- onChange?: (value: string) => void;
2438
+ options: Option$1[];
2438
2439
  /**
2439
2440
  * This function will be called when the radio group loses the focus. An
2440
2441
  * object including the value and the error will be passed to this
@@ -2445,22 +2446,28 @@ type RadioGroupProps = {
2445
2446
  error?: string;
2446
2447
  }) => void;
2447
2448
  /**
2448
- * If it is a defined value and also a truthy string, the component will
2449
- * change its appearance, showing the error below the radio group. If the
2450
- * defined value is an empty string, it will reserve a space below the
2451
- * component for a future error, but it would not change its look. In
2452
- * case of being undefined or null, both the appearance and the space for
2453
- * the error message would not be modified.
2449
+ * This function will be called when the user chooses an option. The new
2450
+ * value will be passed to this function.
2454
2451
  */
2455
- error?: string;
2452
+ onChange?: (value: string) => void;
2453
+ /**
2454
+ * If true, the component will not be mutable, meaning the user can not edit the control.
2455
+ */
2456
+ readOnly?: boolean;
2457
+ /**
2458
+ * Sets the orientation of the options within the radio group.
2459
+ */
2460
+ stacking?: "row" | "column";
2456
2461
  /**
2457
2462
  * Value of the tabindex attribute.
2458
2463
  */
2459
2464
  tabIndex?: number;
2460
2465
  /**
2461
- * Specifies a string to be used as the name for the radio group when no `label` is provided.
2466
+ * Value of the radio group. If undefined, the component will be
2467
+ * uncontrolled and the value will be managed internally by the
2468
+ * component.
2462
2469
  */
2463
- ariaLabel?: string;
2470
+ value?: string;
2464
2471
  };
2465
2472
 
2466
2473
  declare const DxcRadioGroup: react.ForwardRefExoticComponent<RadioGroupProps & react.RefAttributes<HTMLDivElement>>;
@@ -2819,34 +2826,39 @@ declare const DxcSlider: react.ForwardRefExoticComponent<Props$b & react.RefAttr
2819
2826
 
2820
2827
  type Props$a = {
2821
2828
  /**
2822
- * Text to be placed inside the spinner.
2829
+ * 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.
2823
2830
  */
2824
- label?: string;
2831
+ ariaLabel?: string;
2825
2832
  /**
2826
- * The value of the progress indicator. If it's received the
2827
- * component is determinate, otherwise is indeterminate.
2833
+ * If true, the color is inherited from the closest parent with a defined color. This allows users to adapt the spinner
2834
+ * to the semantic color of the use case in which it is used.
2828
2835
  */
2829
- value?: number;
2836
+ inheritColor?: boolean;
2830
2837
  /**
2831
- * If true, the value is displayed inside the spinner..
2838
+ * Text to be placed inside the spinner.
2832
2839
  */
2833
- showValue?: boolean;
2840
+ label?: string;
2841
+ /**
2842
+ * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
2843
+ * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
2844
+ */
2845
+ margin?: Space$1 | Margin;
2834
2846
  /**
2835
2847
  * Available modes of the spinner.
2836
2848
  */
2837
2849
  mode?: "large" | "small" | "overlay";
2838
2850
  /**
2839
- * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
2840
- * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
2851
+ * If true, the value is displayed inside the spinner..
2841
2852
  */
2842
- margin?: Space$1 | Margin;
2853
+ showValue?: boolean;
2843
2854
  /**
2844
- * 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.
2855
+ * The value of the progress indicator. If it's received the
2856
+ * component is determinate, otherwise is indeterminate.
2845
2857
  */
2846
- ariaLabel?: string;
2858
+ value?: number;
2847
2859
  };
2848
2860
 
2849
- declare const DxcSpinner: ({ ariaLabel, label, margin, mode, showValue, value }: Props$a) => react_jsx_runtime.JSX.Element;
2861
+ declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$a) => react_jsx_runtime.JSX.Element;
2850
2862
 
2851
2863
  type Mode = "default" | "info" | "success" | "warning" | "error";
2852
2864
  type Size = "small" | "medium" | "large";
@@ -2869,19 +2881,22 @@ declare function DxcStatusLight({ label, mode, size }: Props$9): react_jsx_runti
2869
2881
 
2870
2882
  type Props$8 = {
2871
2883
  /**
2872
- * Initial state of the switch, only when it is uncontrolled.
2884
+ * Specifies a string to be used as the name for the switch element when no `label` is provided.
2873
2885
  */
2874
- defaultChecked?: boolean;
2886
+ ariaLabel?: string;
2875
2887
  /**
2876
2888
  * If true, the component is checked. If undefined, the component will be uncontrolled
2877
2889
  * and the checked attribute will be managed internally by the component.
2878
2890
  */
2879
2891
  checked?: boolean;
2880
2892
  /**
2881
- * Will be passed to the value attribute of the html input element. When inside a form,
2882
- * this value will be only submitted if the switch is checked.
2893
+ * Initial state of the switch, only when it is uncontrolled.
2883
2894
  */
2884
- value?: string;
2895
+ defaultChecked?: boolean;
2896
+ /**
2897
+ * If true, the component will be disabled.
2898
+ */
2899
+ disabled?: boolean;
2885
2900
  /**
2886
2901
  * Text to be placed next to the switch.
2887
2902
  */
@@ -2891,13 +2906,14 @@ type Props$8 = {
2891
2906
  */
2892
2907
  labelPosition?: "before" | "after";
2893
2908
  /**
2894
- * Name attribute of the input element.
2909
+ * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
2910
+ * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
2895
2911
  */
2896
- name?: string;
2912
+ margin?: Space$1 | Margin;
2897
2913
  /**
2898
- * If true, the component will be disabled.
2914
+ * Name attribute of the input element.
2899
2915
  */
2900
- disabled?: boolean;
2916
+ name?: string;
2901
2917
  /**
2902
2918
  * This function will be called when the user changes the state of the switch.
2903
2919
  * The new value of the checked attribute will be passed as a parameter.
@@ -2907,11 +2923,6 @@ type Props$8 = {
2907
2923
  * If true, the component will display '(Optional)' next to the label.
2908
2924
  */
2909
2925
  optional?: boolean;
2910
- /**
2911
- * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
2912
- * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
2913
- */
2914
- margin?: Space$1 | Margin;
2915
2926
  /**
2916
2927
  * Size of the component.
2917
2928
  */
@@ -2921,9 +2932,10 @@ type Props$8 = {
2921
2932
  */
2922
2933
  tabIndex?: number;
2923
2934
  /**
2924
- * Specifies a string to be used as the name for the switch element when no `label` is provided.
2935
+ * Will be passed to the value attribute of the html input element. When inside a form,
2936
+ * this value will be only submitted if the switch is checked.
2925
2937
  */
2926
- ariaLabel?: string;
2938
+ value?: string;
2927
2939
  };
2928
2940
 
2929
2941
  declare const DxcSwitch: react.ForwardRefExoticComponent<Props$8 & react.RefAttributes<HTMLDivElement>>;
@@ -3115,55 +3127,78 @@ declare const DxcTag: ({ icon, label, linkHref, onClick, iconBgColor, labelPosit
3115
3127
 
3116
3128
  type Props$5 = {
3117
3129
  /**
3118
- * Text to be placed above the textarea.
3130
+ * Specifies a string to be used as the name for the textarea element when no `label` is provided.
3119
3131
  */
3120
- label?: string;
3132
+ ariaLabel?: string;
3121
3133
  /**
3122
- * Name attribute of the textarea element.
3134
+ * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
3135
+ * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
3123
3136
  */
3124
- name?: string;
3137
+ autocomplete?: string;
3138
+ /**
3139
+ * If true, the component will be disabled.
3140
+ */
3141
+ disabled?: boolean;
3125
3142
  /**
3126
3143
  * Initial value of the textarea, only when it is uncontrolled.
3127
3144
  */
3128
3145
  defaultValue?: string;
3129
3146
  /**
3130
- * Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
3147
+ * If it is a defined value and also a truthy string, the component will
3148
+ * change its appearance, showing the error below the textarea. If the
3149
+ * defined value is an empty string, it will reserve a space below the
3150
+ * component for a future error, but it would not change its look. In
3151
+ * case of being undefined or null, both the appearance and the space for
3152
+ * the error message would not be modified.
3131
3153
  */
3132
- value?: string;
3154
+ error?: string;
3133
3155
  /**
3134
3156
  * Helper text to be placed above the textarea.
3135
3157
  */
3136
3158
  helperText?: string;
3137
3159
  /**
3138
- * Text to be put as placeholder of the textarea.
3160
+ * Text to be placed above the textarea.
3139
3161
  */
3140
- placeholder?: string;
3162
+ label?: string;
3141
3163
  /**
3142
- * If true, the component will be disabled.
3164
+ * Specifies the maximum length allowed by the textarea.
3165
+ * This will be checked both when the textarea loses the
3166
+ * focus and while typing within it. If the string entered does not
3167
+ * comply the maximum length, the onBlur and onChange functions will be called
3168
+ * with the current value and an internal error informing that the value
3169
+ * length does not comply the specified range. If a valid length is
3170
+ * reached, the error parameter of both events will not be defined.
3143
3171
  */
3144
- disabled?: boolean;
3172
+ maxLength?: number;
3145
3173
  /**
3146
- * If true, the component will not be mutable, meaning the user can not edit the control.
3174
+ * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
3175
+ * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
3147
3176
  */
3148
- readOnly?: boolean;
3177
+ margin?: Space$1 | Margin;
3149
3178
  /**
3150
- * If true, the textarea will be optional, showing '(Optional)'
3151
- * next to the label. Otherwise, the field will be considered required
3152
- * and an error will be passed as a parameter to the OnBlur and onChange functions
3153
- * when it has not been filled.
3179
+ * Specifies the minimum length allowed by the textarea.
3180
+ * This will be checked both when the textarea loses the
3181
+ * focus and while typing within it. If the string entered does not
3182
+ * comply the minimum length, the onBlur and onChange functions will be called
3183
+ * with the current value and an internal error informing that the value
3184
+ * length does not comply the specified range. If a valid length is
3185
+ * reached, the error parameter of both events will not be defined.
3154
3186
  */
3155
- optional?: boolean;
3187
+ minLength?: number;
3156
3188
  /**
3157
- * Defines the textarea's ability to resize vertically. It can be:
3158
- * - 'auto': The textarea grows or shrinks automatically in order to fit the content.
3159
- * - 'manual': The height of the textarea is enabled to be manually modified.
3160
- * - 'none': The textarea has a fixed height and can't be modified.
3189
+ * Name attribute of the textarea element.
3161
3190
  */
3162
- verticalGrow?: "auto" | "manual" | "none";
3191
+ name?: string;
3163
3192
  /**
3164
- * Number of rows of the textarea.
3193
+ * This function will be called when the textarea loses the focus. An
3194
+ * object including the textarea value and the error (if the value entered
3195
+ * is not valid) will be passed to this function. If there is no error,
3196
+ * error will not be defined.
3165
3197
  */
3166
- rows?: number;
3198
+ onBlur?: (val: {
3199
+ value: string;
3200
+ error?: string;
3201
+ }) => void;
3167
3202
  /**
3168
3203
  * This function will be called when the user types within the textarea.
3169
3204
  * An object including the current value and the error (if the value
@@ -3175,24 +3210,12 @@ type Props$5 = {
3175
3210
  error?: string;
3176
3211
  }) => void;
3177
3212
  /**
3178
- * This function will be called when the textarea loses the focus. An
3179
- * object including the textarea value and the error (if the value entered
3180
- * is not valid) will be passed to this function. If there is no error,
3181
- * error will not be defined.
3182
- */
3183
- onBlur?: (val: {
3184
- value: string;
3185
- error?: string;
3186
- }) => void;
3187
- /**
3188
- * If it is a defined value and also a truthy string, the component will
3189
- * change its appearance, showing the error below the textarea. If the
3190
- * defined value is an empty string, it will reserve a space below the
3191
- * component for a future error, but it would not change its look. In
3192
- * case of being undefined or null, both the appearance and the space for
3193
- * the error message would not be modified.
3213
+ * If true, the textarea will be optional, showing '(Optional)'
3214
+ * next to the label. Otherwise, the field will be considered required
3215
+ * and an error will be passed as a parameter to the OnBlur and onChange functions
3216
+ * when it has not been filled.
3194
3217
  */
3195
- error?: string;
3218
+ optional?: boolean;
3196
3219
  /**
3197
3220
  * Regular expression that defines the valid format allowed by the
3198
3221
  * textarea. This will be checked both when the textarea loses the focus
@@ -3204,35 +3227,17 @@ type Props$5 = {
3204
3227
  */
3205
3228
  pattern?: string;
3206
3229
  /**
3207
- * Specifies the minimum length allowed by the textarea.
3208
- * This will be checked both when the textarea loses the
3209
- * focus and while typing within it. If the string entered does not
3210
- * comply the minimum length, the onBlur and onChange functions will be called
3211
- * with the current value and an internal error informing that the value
3212
- * length does not comply the specified range. If a valid length is
3213
- * reached, the error parameter of both events will not be defined.
3214
- */
3215
- minLength?: number;
3216
- /**
3217
- * Specifies the maximum length allowed by the textarea.
3218
- * This will be checked both when the textarea loses the
3219
- * focus and while typing within it. If the string entered does not
3220
- * comply the maximum length, the onBlur and onChange functions will be called
3221
- * with the current value and an internal error informing that the value
3222
- * length does not comply the specified range. If a valid length is
3223
- * reached, the error parameter of both events will not be defined.
3230
+ * Text to be put as placeholder of the textarea.
3224
3231
  */
3225
- maxLength?: number;
3232
+ placeholder?: string;
3226
3233
  /**
3227
- * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
3228
- * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
3234
+ * If true, the component will not be mutable, meaning the user can not edit the control.
3229
3235
  */
3230
- autocomplete?: string;
3236
+ readOnly?: boolean;
3231
3237
  /**
3232
- * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
3233
- * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
3238
+ * Number of rows of the textarea.
3234
3239
  */
3235
- margin?: Space$1 | Margin;
3240
+ rows?: number;
3236
3241
  /**
3237
3242
  * Size of the component.
3238
3243
  */
@@ -3242,9 +3247,16 @@ type Props$5 = {
3242
3247
  */
3243
3248
  tabIndex?: number;
3244
3249
  /**
3245
- * Specifies a string to be used as the name for the textarea element when no `label` is provided.
3250
+ * Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
3246
3251
  */
3247
- ariaLabel?: string;
3252
+ value?: string;
3253
+ /**
3254
+ * Defines the textarea's ability to resize vertically. It can be:
3255
+ * - 'auto': The textarea grows or shrinks automatically in order to fit the content.
3256
+ * - 'manual': The height of the textarea is enabled to be manually modified.
3257
+ * - 'none': The textarea has a fixed height and can't be modified.
3258
+ */
3259
+ verticalGrow?: "auto" | "manual" | "none";
3248
3260
  };
3249
3261
 
3250
3262
  declare const DxcTextarea: react.ForwardRefExoticComponent<Props$5 & react.RefAttributes<HTMLDivElement>>;
@@ -3458,28 +3470,28 @@ type SemanticToast = CommonProps$1 & {
3458
3470
  hideSemanticIcon?: boolean;
3459
3471
  };
3460
3472
  type ToastsQueuePropsType = {
3473
+ /**
3474
+ * Tree of components from which the useToast hook can be triggered.
3475
+ */
3476
+ children: ReactNode;
3461
3477
  /**
3462
3478
  * Duration in milliseconds before a toast automatically hides itself.
3463
3479
  * The range goes from 3000ms to 5000ms, any other value will not be taken into consideration.
3464
3480
  */
3465
3481
  duration?: number;
3466
- /**
3467
- * Tree of components from which the useToast hook can be triggered.
3468
- */
3469
- children: ReactNode;
3470
3482
  };
3471
3483
 
3472
- declare const DxcToastsQueue: ({ children, duration }: ToastsQueuePropsType) => react_jsx_runtime.JSX.Element;
3484
+ declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType): react_jsx_runtime.JSX.Element;
3473
3485
 
3474
3486
  type OptionIcon = {
3475
- /**
3476
- * String with the option display value.
3477
- */
3478
- label?: never;
3479
3487
  /**
3480
3488
  * Material Symbols icon or SVG element. Icon and label can't be used at same time.
3481
3489
  */
3482
3490
  icon: string | SVG;
3491
+ /**
3492
+ * String with the option display value.
3493
+ */
3494
+ label?: never;
3483
3495
  /**
3484
3496
  * Value for the HTML properties title and aria-label.
3485
3497
  * When a label is defined, this prop can not be use.
@@ -3487,14 +3499,14 @@ type OptionIcon = {
3487
3499
  title: string;
3488
3500
  };
3489
3501
  type OptionLabel = {
3490
- /**
3491
- * String with the option display value.
3492
- */
3493
- label: string;
3494
3502
  /**
3495
3503
  * Material Symbols icon or SVG element. Icon and label can't be used at same time.
3496
3504
  */
3497
3505
  icon?: string | SVG;
3506
+ /**
3507
+ * String with the option display value.
3508
+ */
3509
+ label: string;
3498
3510
  /**
3499
3511
  * Value for the HTML properties title and aria-label.
3500
3512
  * When a label is defined, this prop can not be use.
@@ -3502,6 +3514,10 @@ type OptionLabel = {
3502
3514
  title?: never;
3503
3515
  };
3504
3516
  type Option = {
3517
+ /**
3518
+ * If true, the option will be disabled.
3519
+ */
3520
+ disabled?: boolean;
3505
3521
  /**
3506
3522
  * Number with the option inner value.
3507
3523
  */
@@ -3509,74 +3525,66 @@ type Option = {
3509
3525
  } & (OptionIcon | OptionLabel);
3510
3526
  type CommonProps = {
3511
3527
  /**
3512
- * Text to be placed above the component.
3513
- */
3514
- label?: string;
3515
- /**
3516
- * Helper text to be placed above the component.
3517
- */
3518
- helperText?: string;
3519
- /**
3520
- * If true, the component will be disabled.
3528
+ * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
3529
+ * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
3521
3530
  */
3522
- disabled?: boolean;
3531
+ margin?: Space$1 | Margin;
3523
3532
  /**
3524
3533
  * An array of objects representing the selectable options.
3525
3534
  */
3526
3535
  options: Option[];
3527
3536
  /**
3528
- * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
3529
- * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
3537
+ * The orientation of the toggle group.
3530
3538
  */
3531
- margin?: Space$1 | Margin;
3539
+ orientation?: "horizontal" | "vertical";
3532
3540
  /**
3533
3541
  * Value of the tabindex.
3534
3542
  */
3535
3543
  tabIndex?: number;
3536
3544
  };
3537
- type SingleSelectionToggleGroup = CommonProps & {
3545
+ type MultipleSelectionToggleGroup = {
3546
+ /**
3547
+ * The array of keys with the initially selected values.
3548
+ */
3549
+ defaultValue?: number[];
3538
3550
  /**
3539
3551
  * If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
3540
3552
  */
3541
- multiple?: false;
3553
+ multiple: true;
3542
3554
  /**
3543
- * The key of the initially selected value.
3555
+ * This function will be called every time the selection changes. An array with the key of
3556
+ * the selected values will be passed as a parameter to this function.
3544
3557
  */
3545
- defaultValue?: number;
3558
+ onChange?: (optionIndex: number[]) => void;
3546
3559
  /**
3547
- * The key of the selected value. If the component allows multiple selection, value must be an array.
3560
+ * An array with the keys of the selected values.
3548
3561
  * If undefined, the component will be uncontrolled and the value will be managed internally by the component.
3549
3562
  */
3550
- value?: number;
3563
+ value?: number[];
3564
+ };
3565
+ type SingleSelectionToggleGroup = {
3551
3566
  /**
3552
- * This function will be called every time the selection changes. The number with the key of the selected
3553
- * value will be passed as a parameter to this function.
3567
+ * The key of the initially selected value.
3554
3568
  */
3555
- onChange?: (optionIndex: number) => void;
3556
- };
3557
- type MultipleSelectionToggleGroup = CommonProps & {
3569
+ defaultValue?: number;
3558
3570
  /**
3559
3571
  * If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
3560
3572
  */
3561
- multiple: true;
3573
+ multiple?: false;
3562
3574
  /**
3563
- * The array of keys with the initially selected values.
3575
+ * This function will be called every time the selection changes. The number with the key of the selected
3576
+ * value will be passed as a parameter to this function.
3564
3577
  */
3565
- defaultValue?: number[];
3578
+ onChange?: (optionIndex: number) => void;
3566
3579
  /**
3567
- * An array with the keys of the selected values.
3580
+ * The key of the selected value. If the component allows multiple selection, value must be an array.
3568
3581
  * If undefined, the component will be uncontrolled and the value will be managed internally by the component.
3569
3582
  */
3570
- value?: number[];
3571
- /**
3572
- * This function will be called every time the selection changes. An array with the key of
3573
- * the selected values will be passed as a parameter to this function.
3574
- */
3575
- onChange?: (optionIndex: number[]) => void;
3583
+ value?: number;
3576
3584
  };
3577
- type Props$3 = SingleSelectionToggleGroup | MultipleSelectionToggleGroup;
3585
+ type Props$3 = CommonProps & (MultipleSelectionToggleGroup | SingleSelectionToggleGroup);
3578
3586
 
3579
- declare const DxcToggleGroup: ({ label, helperText, defaultValue, value, onChange, disabled, options, margin, multiple, tabIndex, }: Props$3) => JSX.Element;
3587
+ declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3): react_jsx_runtime.JSX.Element;
3580
3588
 
3581
3589
  type Props$2 = {
3582
3590
  /**
@@ -6570,7 +6578,7 @@ type HalstackProviderPropsType = {
6570
6578
  };
6571
6579
  declare const HalstackProvider: ({ theme, advancedTheme, labels, children }: HalstackProviderPropsType) => JSX.Element;
6572
6580
 
6573
- declare const useToast: () => {
6581
+ declare function useToast(): {
6574
6582
  default: (toast: DefaultToast) => (() => void) | undefined;
6575
6583
  success: (toast: SemanticToast) => (() => void) | undefined;
6576
6584
  warning: (toast: SemanticToast) => (() => void) | undefined;
@@ -6578,4 +6586,4 @@ declare const useToast: () => {
6578
6586
  loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
6579
6587
  };
6580
6588
 
6581
- export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcBadge, Bleed as 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, DxcTag, DxcTextInput, DxcTextarea, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackContext, HalstackLanguageContext, HalstackProvider, useToast };
6589
+ export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcBadge, DxcBleed, DxcBreadcrumbs, DxcBulletedList, DxcButton, DxcCard, DxcCheckbox, DxcChip, DxcContainer, DxcContextualMenu, DxcDataGrid, DxcDateInput, DxcDialog, DxcDivider, DxcDropdown, DxcFileInput, DxcFlex, DxcGrid, DxcHeading, DxcImage, DxcInset, DxcLink, DxcNavTabs, DxcNumberInput, DxcPaginator, DxcParagraph, DxcPasswordInput, DxcProgressBar, DxcQuickNav, DxcRadioGroup, DxcResultsetTable, DxcSelect, DxcSlider, DxcSpinner, DxcStatusLight, DxcSwitch, DxcTable, DxcTabs, DxcTag, DxcTextInput, DxcTextarea, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackContext, HalstackLanguageContext, HalstackProvider, useToast };