@telus-uds/components-base 1.12.1 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/CHANGELOG.md +41 -2
  2. package/component-docs.json +888 -66
  3. package/lib/Button/ButtonBase.js +36 -7
  4. package/lib/Button/ButtonGroup.js +7 -0
  5. package/lib/Button/propTypes.js +18 -0
  6. package/lib/Carousel/Carousel.js +69 -12
  7. package/lib/Carousel/CarouselContext.js +17 -11
  8. package/lib/Carousel/CarouselFirstFocus/CarouselFirstFocus.js +73 -0
  9. package/lib/Carousel/CarouselTabs/CarouselTabs.js +70 -0
  10. package/lib/Carousel/CarouselTabs/CarouselTabsPanel.js +95 -0
  11. package/lib/Carousel/CarouselTabs/CarouselTabsPanelItem.js +148 -0
  12. package/lib/Carousel/CarouselTabs/index.js +13 -0
  13. package/lib/Carousel/CarouselThumbnail.js +99 -0
  14. package/lib/Carousel/CarouselThumbnailNavigation.js +87 -0
  15. package/lib/Carousel/dictionary.js +4 -2
  16. package/lib/Carousel/index.js +10 -1
  17. package/lib/Checkbox/CheckboxGroup.js +7 -0
  18. package/lib/Icon/IconText.js +1 -1
  19. package/lib/Link/InlinePressable.js +1 -8
  20. package/lib/Link/LinkBase.js +6 -7
  21. package/lib/List/ListItem.js +1 -1
  22. package/lib/Notification/Notification.js +37 -22
  23. package/lib/Radio/RadioGroup.js +8 -0
  24. package/lib/RadioCard/RadioCardGroup.js +7 -0
  25. package/lib/SkipLink/SkipLink.js +216 -0
  26. package/lib/SkipLink/index.js +13 -0
  27. package/lib/ThemeProvider/ThemeProvider.js +6 -1
  28. package/lib/ToggleSwitch/ToggleSwitchGroup.js +7 -0
  29. package/lib/index.js +9 -0
  30. package/lib-module/Button/ButtonBase.js +35 -7
  31. package/lib-module/Button/ButtonGroup.js +7 -0
  32. package/lib-module/Button/propTypes.js +17 -0
  33. package/lib-module/Carousel/Carousel.js +66 -11
  34. package/lib-module/Carousel/CarouselContext.js +17 -11
  35. package/lib-module/Carousel/CarouselFirstFocus/CarouselFirstFocus.js +51 -0
  36. package/lib-module/Carousel/CarouselTabs/CarouselTabs.js +50 -0
  37. package/lib-module/Carousel/CarouselTabs/CarouselTabsPanel.js +76 -0
  38. package/lib-module/Carousel/CarouselTabs/CarouselTabsPanelItem.js +126 -0
  39. package/lib-module/Carousel/CarouselTabs/index.js +2 -0
  40. package/lib-module/Carousel/CarouselThumbnail.js +85 -0
  41. package/lib-module/Carousel/CarouselThumbnailNavigation.js +66 -0
  42. package/lib-module/Carousel/dictionary.js +4 -2
  43. package/lib-module/Carousel/index.js +2 -1
  44. package/lib-module/Checkbox/CheckboxGroup.js +7 -0
  45. package/lib-module/Icon/IconText.js +1 -1
  46. package/lib-module/Link/InlinePressable.js +1 -8
  47. package/lib-module/Link/LinkBase.js +6 -7
  48. package/lib-module/List/ListItem.js +1 -1
  49. package/lib-module/Notification/Notification.js +38 -23
  50. package/lib-module/Radio/RadioGroup.js +8 -0
  51. package/lib-module/RadioCard/RadioCardGroup.js +7 -0
  52. package/lib-module/SkipLink/SkipLink.js +188 -0
  53. package/lib-module/SkipLink/index.js +2 -0
  54. package/lib-module/ThemeProvider/ThemeProvider.js +5 -1
  55. package/lib-module/ToggleSwitch/ToggleSwitchGroup.js +7 -0
  56. package/lib-module/index.js +1 -0
  57. package/package.json +46 -47
  58. package/src/Button/ButtonBase.jsx +28 -9
  59. package/src/Button/ButtonGroup.jsx +6 -0
  60. package/src/Button/propTypes.js +14 -0
  61. package/src/Carousel/Carousel.jsx +68 -10
  62. package/src/Carousel/CarouselContext.jsx +22 -9
  63. package/src/Carousel/CarouselFirstFocus/CarouselFirstFocus.jsx +49 -0
  64. package/src/Carousel/CarouselTabs/CarouselTabs.jsx +37 -0
  65. package/src/Carousel/CarouselTabs/CarouselTabsPanel.jsx +69 -0
  66. package/src/Carousel/CarouselTabs/CarouselTabsPanelItem.jsx +119 -0
  67. package/src/Carousel/CarouselTabs/index.js +3 -0
  68. package/src/Carousel/CarouselThumbnail.jsx +77 -0
  69. package/src/Carousel/CarouselThumbnailNavigation.jsx +53 -0
  70. package/src/Carousel/dictionary.js +4 -2
  71. package/src/Carousel/index.js +1 -0
  72. package/src/Checkbox/CheckboxGroup.jsx +7 -0
  73. package/src/Icon/IconText.jsx +1 -1
  74. package/src/Link/InlinePressable.jsx +2 -8
  75. package/src/Link/LinkBase.jsx +8 -17
  76. package/src/List/ListItem.jsx +1 -1
  77. package/src/Notification/Notification.jsx +35 -20
  78. package/src/Radio/RadioGroup.jsx +7 -0
  79. package/src/RadioCard/RadioCardGroup.jsx +6 -0
  80. package/src/SkipLink/SkipLink.jsx +179 -0
  81. package/src/SkipLink/index.js +3 -0
  82. package/src/ThemeProvider/ThemeProvider.jsx +7 -1
  83. package/src/ToggleSwitch/ToggleSwitchGroup.jsx +6 -0
  84. package/src/index.js +1 -0
@@ -29,6 +29,9 @@
29
29
  "paddingBottom": "size",
30
30
  "width": "size",
31
31
  "minWidth": "size",
32
+ "iconSize": "size",
33
+ "iconSpace": "integer",
34
+ "icon": "icon",
32
35
  "outerBorderColor": "color",
33
36
  "outerBorderWidth": "border",
34
37
  "outerBorderGap": "size",
@@ -87,7 +90,35 @@
87
90
  "showPreviousNextNavigation": "show",
88
91
  "showPanelNavigation": "show",
89
92
  "spaceBetweenSlideAndPreviousNextNavigation": "size",
90
- "spaceBetweenSlideAndPanelNavigation": "size"
93
+ "spaceBetweenSlideAndPanelNavigation": "size",
94
+ "thumbnailBorderColor": "color",
95
+ "thumbnailBorderRadius": "radius",
96
+ "thumbnailBorderWidth": "border",
97
+ "thumbnailContainerPaddingTop": "size",
98
+ "thumbnailMargin": "size",
99
+ "thumbnailPadding": "size",
100
+ "thumbnailSelectedBorderColor": "color",
101
+ "thumbnailSelectedBorderWidth": "border",
102
+ "thumbnailSize": "size"
103
+ },
104
+ "CarouselTabsPanelItem": {
105
+ "paddingLeft": "size",
106
+ "paddingRight": "size",
107
+ "paddingTop": "size",
108
+ "paddingBottom": "size",
109
+ "borderBottomColor": "color",
110
+ "borderBottomWidth": "border",
111
+ "borderBottomStyle": "borderStyle",
112
+ "flex": "integer",
113
+ "alignItems": "flexAlign",
114
+ "justifyContent": "flexJustifyContent",
115
+ "color": "color",
116
+ "fontSize": "fontSize",
117
+ "fontScaleCap": "fontSize",
118
+ "lineHeight": "lineHeight",
119
+ "letterSpacing": "letterSpacing",
120
+ "fontWeight": "fontWeight",
121
+ "fontName": "fontName"
91
122
  },
92
123
  "Checkbox": {
93
124
  "containerBackgroundColor": "color",
@@ -617,6 +648,17 @@
617
648
  "showStepName": "show",
618
649
  "showStepTrackerLabel": "show"
619
650
  },
651
+ "SkipLink": {
652
+ "backgroundColor": "color",
653
+ "color": "color",
654
+ "outlineColor": "color",
655
+ "outlineOffset": "border",
656
+ "outlineStyle": "borderStyle",
657
+ "outlineWidth": "border",
658
+ "paddingHorizontal": "size",
659
+ "paddingVertical": "size",
660
+ "borderRadius": "radius"
661
+ },
620
662
  "Tabs": {
621
663
  "nextIcon": "icon",
622
664
  "previousIcon": "icon",
@@ -900,6 +942,43 @@
900
942
  "type": "state"
901
943
  }
902
944
  },
945
+ "CarouselTabsPanelItem": {
946
+ "focus": {
947
+ "description": "Currently only web has good support for this. Applies when an interactive component's focus handler is triggered, such as keyboard tabbing or selection.",
948
+ "values": [
949
+ true
950
+ ],
951
+ "type": "state"
952
+ },
953
+ "hover": {
954
+ "description": "Currently web only. Applies when an interactive component's hover handler is triggered, such as on mouseover.",
955
+ "values": [
956
+ true
957
+ ],
958
+ "type": "state"
959
+ },
960
+ "pressed": {
961
+ "description": "Applies while an interactive component is being physically pressed. Most visible on touchscreen taps; in React Native Web, this is visible on web mouse clicks only if the pressable is held down.",
962
+ "values": [
963
+ true
964
+ ],
965
+ "type": "state"
966
+ },
967
+ "inactive": {
968
+ "description": "Prevents an interactive component from being interacted with and applies accessibility attributes to indicate to the user that this component cannot be used.",
969
+ "values": [
970
+ true
971
+ ],
972
+ "type": "state"
973
+ },
974
+ "selected": {
975
+ "description": "Applies while an interactive component is the currently selected one in a set of states or components, for example a button in a `ButtonGroup`.",
976
+ "values": [
977
+ true
978
+ ],
979
+ "type": "state"
980
+ }
981
+ },
903
982
  "Checkbox": {
904
983
  "checked": {
905
984
  "description": "Corresponds to a selected state for a checkbox or radio",
@@ -1554,6 +1633,15 @@
1554
1633
  ],
1555
1634
  "type": "state"
1556
1635
  }
1636
+ },
1637
+ "SkipLink": {
1638
+ "focus": {
1639
+ "description": "Currently only web has good support for this. Applies when an interactive component's focus handler is triggered, such as keyboard tabbing or selection.",
1640
+ "values": [
1641
+ true
1642
+ ],
1643
+ "type": "state"
1644
+ }
1557
1645
  }
1558
1646
  }
1559
1647
  },
@@ -4611,7 +4699,7 @@
4611
4699
  },
4612
4700
  "icon": {
4613
4701
  "type": {
4614
- "name": "func"
4702
+ "name": "elementType"
4615
4703
  },
4616
4704
  "required": false,
4617
4705
  "description": "Renders side item icon"
@@ -4782,7 +4870,7 @@
4782
4870
  },
4783
4871
  "icon": {
4784
4872
  "type": {
4785
- "name": "func"
4873
+ "name": "elementType"
4786
4874
  },
4787
4875
  "required": false,
4788
4876
  "description": "Renders side item icon"
@@ -4875,7 +4963,7 @@
4875
4963
  },
4876
4964
  "icon": {
4877
4965
  "type": {
4878
- "name": "func"
4966
+ "name": "elementType"
4879
4967
  },
4880
4968
  "required": false,
4881
4969
  "description": "Renders side item icon"
@@ -6769,6 +6857,69 @@
6769
6857
  }
6770
6858
  }
6771
6859
  },
6860
+ "SkipLink": {
6861
+ "docs": {
6862
+ "description": "A generic Skip link component, unstyled by default.\nA Skip link component help keyboard-only users, screen reader users to skip\nsections and navigate to the content they want.\n\n## Component API\n\nFor common uses, pass a `href` that is a # link to a DOM id that can be skipped to (web only).\n\nThe element with this ID should be focusable, e.g. `<Box nativeID=\"skip-target\" focusable>`.\n\nOther custom behaviour may be set by passing an `onPress` function, and routers may be integrated\nin the same way as other navigation-related components by passing a `LinkRouter`; but a # anchor\nhref on web and/or a `targetRef` for cross-platform applications is the recommended approach.\n\n## Visible styling\n\nWhen focused, the skip link shows as a visible element similar to a simplified ButtonLink using\nUDS theming. The `tokens` prop may be used to override these styles.\n\nTo control the background of a skip link, the following tokens can be used:\n\n- `backgroundColor`\n*\nIn order to control the color of the skip link text, the following tokens can be used:\n\n- `color`\n\n### Padding\n\nThe following padding tokens can be used:\n\n- `paddingHorizontal`\n- `paddingVertical`\n\n### Outline\n\nThe following tokens to control the outline:\n\n- `outlineColor`\n- `outlineOffset`\n- `outlineStyle`\n- `outlineWidth`\n\n## Usability and A11y guidelines\n\n- The skip link component is visually hidden until a keyboard press activates it.\n- Usually, you should place the skip link immediately after the opening <body> tag.\n- This lets users bypass top-level navigation links and jump to the main content on a page.\n- Also consider using SkipLink before a complex feature containing many focusable elements.\n\n## Accessibility\n\nSkip link supports all the common a11y and link props.",
6863
+ "props": {
6864
+ "children": {
6865
+ "type": {
6866
+ "name": "node"
6867
+ },
6868
+ "required": false,
6869
+ "description": "The text content shown or read out when the SkipLink is focused, usually a string."
6870
+ },
6871
+ "href": {
6872
+ "type": {
6873
+ "name": "string"
6874
+ },
6875
+ "required": false,
6876
+ "description": "The target to skip to. Usually an anchor link to a section id (e.g. href=\"#main-section\")."
6877
+ },
6878
+ "tokens": {
6879
+ "type": {
6880
+ "name": "custom",
6881
+ "raw": {
6882
+ "backgroundColor": "color",
6883
+ "color": "color",
6884
+ "outlineColor": "color",
6885
+ "outlineOffset": "border",
6886
+ "outlineStyle": "borderStyle",
6887
+ "outlineWidth": "border",
6888
+ "paddingHorizontal": "size",
6889
+ "paddingVertical": "size",
6890
+ "borderRadius": "radius"
6891
+ }
6892
+ },
6893
+ "required": false,
6894
+ "description": ""
6895
+ },
6896
+ "variant": {
6897
+ "type": {
6898
+ "name": "objectOf",
6899
+ "value": {
6900
+ "name": "union",
6901
+ "value": [
6902
+ {
6903
+ "name": "string"
6904
+ },
6905
+ {
6906
+ "name": "number"
6907
+ },
6908
+ {
6909
+ "name": "bool"
6910
+ }
6911
+ ]
6912
+ }
6913
+ },
6914
+ "required": false,
6915
+ "description": ""
6916
+ }
6917
+ },
6918
+ "attributes": {
6919
+ "acceptsRNA11yProps": false
6920
+ }
6921
+ }
6922
+ },
6772
6923
  "Spacer": {
6773
6924
  "docs": {
6774
6925
  "description": "An empty element used to create a gap between components that is sized according to the theme spacing scale,\npassing its `space` prop ({@link SpacingValue}) to `useSpacingScale`.\n\n## Simple spacing\n\nFor most simple uses, pass a number to Spacer's `space` prop referring to an index in the theme's\nspacing scale. For example, for a spacer of the theme's smallest non-zero spacing size:\n\n```jsx\n<Spacer space={1} />\n```\n\n## Responsive spacing\n\nDifferent spacing scale sizes may be chosen for different viewports by passing `space` a {@link SpacingObject}\nusing keys for the viewports at and above which certain spacing indexes should apply.\n\nThis can be useful when a Spacer is inside a layout with a shape that changes between viewports.\n\nFor example, a spacer might need no width below 'md' viewport because the items it separates will be on separate lines,\nbut may need a visible size above that viewport, and a wider size at the highest viewport:\n\n```jsx\n<Spacer space={{ xs: 0, md: 2, xl: 3 }} />\n```\n\nNote that themes may also define viewport-specific behaviour for indexes on the spacing scale. These viewport\nprops should only be used where necessary to achieve a certain responsive layoutm and shouldn't be used to replace\nor deviate from responsive spacing behaviour in a theme that is intended to apply universally.\n\n## More options\n\nSee `useSpacingScale` hook for more options that may be used with the `space` prop.\n\n## Accessibility\n\nSpacer has no content and is ignored by tools such as screen readers. Use `Divider` for\nseparations between elements that may be treated as semantically meaningful on web.",
@@ -7496,11 +7647,16 @@
7496
7647
  "forceAbsoluteFontSizing": {
7497
7648
  "name": "bool",
7498
7649
  "required": false
7650
+ },
7651
+ "contentMaxWidth": {
7652
+ "name": "custom",
7653
+ "raw": "responsiveProps.getTypeOptionallyByViewport(PropTypes.number)",
7654
+ "required": false
7499
7655
  }
7500
7656
  }
7501
7657
  },
7502
7658
  "required": false,
7503
- "description": "An object containing options allowing to customize the theming experience:\n\n- `forceAbsoluteFontSizing`: available on web only; when set to true, allows\n using absolute font sizing (in pixels, doesn't scale) instead of the\n relative sizing (in `rem`, scales depending on the browser settings)"
7659
+ "description": "An object containing options allowing to customize the theming experience:\n\n- `forceAbsoluteFontSizing`: available on web only; when set to true, allows\n using absolute font sizing (in pixels, doesn't scale) instead of the\n relative sizing (in `rem`, scales depending on the browser settings)\n- `contentMaxWidth`: allows configuration of the content max width to be used in components\n such as Footnote and Notification to avoid content to stretch width more then the page's width"
7504
7660
  },
7505
7661
  "children": {
7506
7662
  "type": {
@@ -7999,6 +8155,9 @@
7999
8155
  "paddingBottom": "size",
8000
8156
  "width": "size",
8001
8157
  "minWidth": "size",
8158
+ "iconSize": "size",
8159
+ "iconSpace": "integer",
8160
+ "icon": "icon",
8002
8161
  "outerBorderColor": "color",
8003
8162
  "outerBorderWidth": "border",
8004
8163
  "outerBorderGap": "size",
@@ -8037,6 +8196,59 @@
8037
8196
  "required": false,
8038
8197
  "description": "Function called when the button is pressed. Required unless the button has a href."
8039
8198
  },
8199
+ "iconProps": {
8200
+ "type": {
8201
+ "name": "exact",
8202
+ "value": {
8203
+ "variant": {
8204
+ "name": "custom",
8205
+ "raw": "variantProp.propType",
8206
+ "required": false
8207
+ },
8208
+ "tokens": {
8209
+ "name": "custom",
8210
+ "raw": "getTokensPropType('Icon')",
8211
+ "required": false
8212
+ },
8213
+ "accessibilityLabel": {
8214
+ "name": "string",
8215
+ "description": "Descriptive label used in web SVG title tag for accessibility",
8216
+ "required": false
8217
+ },
8218
+ "scalesWithText": {
8219
+ "name": "bool",
8220
+ "description": "controls whether the icon size should be proportionate to any accessibility-related font scaling.",
8221
+ "required": false
8222
+ }
8223
+ }
8224
+ },
8225
+ "required": false,
8226
+ "description": "Optional variant that may be passed down to the link's icon if there is one"
8227
+ },
8228
+ "iconPosition": {
8229
+ "type": {
8230
+ "name": "enum",
8231
+ "value": [
8232
+ {
8233
+ "value": "'left'",
8234
+ "computed": false
8235
+ },
8236
+ {
8237
+ "value": "'right'",
8238
+ "computed": false
8239
+ }
8240
+ ]
8241
+ },
8242
+ "required": false,
8243
+ "description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of the button."
8244
+ },
8245
+ "icon": {
8246
+ "type": {
8247
+ "name": "func"
8248
+ },
8249
+ "required": false,
8250
+ "description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
8251
+ },
8040
8252
  "variant": {
8041
8253
  "type": {
8042
8254
  "name": "objectOf",
@@ -8138,6 +8350,27 @@
8138
8350
  "required": false,
8139
8351
  "description": "If true, the buttons cannot be interacted with, elements are set as `disabled` and if the\ntheme supports `inactive` appearances rules, these are applied."
8140
8352
  },
8353
+ "hintPosition": {
8354
+ "defaultValue": {
8355
+ "value": "'inline'",
8356
+ "computed": false
8357
+ },
8358
+ "type": {
8359
+ "name": "enum",
8360
+ "value": [
8361
+ {
8362
+ "value": "'inline'",
8363
+ "computed": false
8364
+ },
8365
+ {
8366
+ "value": "'below'",
8367
+ "computed": false
8368
+ }
8369
+ ]
8370
+ },
8371
+ "required": false,
8372
+ "description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
8373
+ },
8141
8374
  "accessibilityRole": {
8142
8375
  "defaultValue": {
8143
8376
  "value": "maxValues === 1\n? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups\n: Platform.select({ web: 'group', default: 'none' })",
@@ -8311,6 +8544,9 @@
8311
8544
  "paddingBottom": "size",
8312
8545
  "width": "size",
8313
8546
  "minWidth": "size",
8547
+ "iconSize": "size",
8548
+ "iconSpace": "integer",
8549
+ "icon": "icon",
8314
8550
  "outerBorderColor": "color",
8315
8551
  "outerBorderWidth": "border",
8316
8552
  "outerBorderGap": "size",
@@ -8349,35 +8585,88 @@
8349
8585
  "required": false,
8350
8586
  "description": "Function called when the button is pressed. Required unless the button has a href."
8351
8587
  },
8352
- "variant": {
8588
+ "iconProps": {
8353
8589
  "type": {
8354
- "name": "objectOf",
8590
+ "name": "exact",
8355
8591
  "value": {
8356
- "name": "union",
8357
- "value": [
8358
- {
8359
- "name": "string"
8360
- },
8361
- {
8362
- "name": "number"
8363
- },
8364
- {
8365
- "name": "bool"
8366
- }
8367
- ]
8592
+ "variant": {
8593
+ "name": "custom",
8594
+ "raw": "variantProp.propType",
8595
+ "required": false
8596
+ },
8597
+ "tokens": {
8598
+ "name": "custom",
8599
+ "raw": "getTokensPropType('Icon')",
8600
+ "required": false
8601
+ },
8602
+ "accessibilityLabel": {
8603
+ "name": "string",
8604
+ "description": "Descriptive label used in web SVG title tag for accessibility",
8605
+ "required": false
8606
+ },
8607
+ "scalesWithText": {
8608
+ "name": "bool",
8609
+ "description": "controls whether the icon size should be proportionate to any accessibility-related font scaling.",
8610
+ "required": false
8611
+ }
8368
8612
  }
8369
8613
  },
8370
8614
  "required": false,
8371
- "description": ""
8372
- },
8373
- "onPressIn": {
8374
- "type": {
8375
- "name": "func"
8376
- },
8377
- "required": false,
8378
- "description": ""
8615
+ "description": "Optional variant that may be passed down to the link's icon if there is one"
8379
8616
  },
8380
- "onPressOut": {
8617
+ "iconPosition": {
8618
+ "type": {
8619
+ "name": "enum",
8620
+ "value": [
8621
+ {
8622
+ "value": "'left'",
8623
+ "computed": false
8624
+ },
8625
+ {
8626
+ "value": "'right'",
8627
+ "computed": false
8628
+ }
8629
+ ]
8630
+ },
8631
+ "required": false,
8632
+ "description": "When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of the button."
8633
+ },
8634
+ "icon": {
8635
+ "type": {
8636
+ "name": "func"
8637
+ },
8638
+ "required": false,
8639
+ "description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
8640
+ },
8641
+ "variant": {
8642
+ "type": {
8643
+ "name": "objectOf",
8644
+ "value": {
8645
+ "name": "union",
8646
+ "value": [
8647
+ {
8648
+ "name": "string"
8649
+ },
8650
+ {
8651
+ "name": "number"
8652
+ },
8653
+ {
8654
+ "name": "bool"
8655
+ }
8656
+ ]
8657
+ }
8658
+ },
8659
+ "required": false,
8660
+ "description": ""
8661
+ },
8662
+ "onPressIn": {
8663
+ "type": {
8664
+ "name": "func"
8665
+ },
8666
+ "required": false,
8667
+ "description": ""
8668
+ },
8669
+ "onPressOut": {
8381
8670
  "type": {
8382
8671
  "name": "func"
8383
8672
  },
@@ -8523,6 +8812,13 @@
8523
8812
  "required": false,
8524
8813
  "description": "Minimal part of slide width must be swiped for changing index.\nOtherwise animation restore current slide. Default value 0.2 means that 20% must be swiped for change index"
8525
8814
  },
8815
+ "title": {
8816
+ "defaultValue": {
8817
+ "value": "'carousel'",
8818
+ "computed": false
8819
+ },
8820
+ "required": false
8821
+ },
8526
8822
  "springConfig": {
8527
8823
  "defaultValue": {
8528
8824
  "value": "undefined",
@@ -8534,9 +8830,37 @@
8534
8830
  "required": false,
8535
8831
  "description": "Carousel uses `Animated.spring` to animate slide changes, use this option to pass custom animation configuration"
8536
8832
  },
8833
+ "thumbnails": {
8834
+ "defaultValue": {
8835
+ "value": "undefined",
8836
+ "computed": true
8837
+ },
8838
+ "type": {
8839
+ "name": "arrayOf",
8840
+ "value": {
8841
+ "name": "shape",
8842
+ "value": {
8843
+ "accessibilityLabel": {
8844
+ "name": "string",
8845
+ "required": false
8846
+ },
8847
+ "alt": {
8848
+ "name": "string",
8849
+ "required": false
8850
+ },
8851
+ "src": {
8852
+ "name": "string",
8853
+ "required": false
8854
+ }
8855
+ }
8856
+ }
8857
+ },
8858
+ "required": false,
8859
+ "description": "An array of objects containing information on the thumbnails to be rendered as navigation panel"
8860
+ },
8537
8861
  "panelNavigation": {
8538
8862
  "defaultValue": {
8539
- "value": "<CarouselStepTracker />",
8863
+ "value": "thumbnails ? (\n <CarouselThumbnailNavigation thumbnails={thumbnails} />\n) : (\n <CarouselStepTracker />\n)",
8540
8864
  "computed": false
8541
8865
  },
8542
8866
  "type": {
@@ -8634,27 +8958,23 @@
8634
8958
  "required": false,
8635
8959
  "description": "HTML tag to use for the Carousel item's immediate parent. Defaults to `'ul'` so that\nassistive technology tools know to intepret the carousel as a list.\n\nNote that if the immediate Carousel children do not all render as `'li'` elements,\nthis should be changed (e.g. pass tag=\"div\") because only 'li' is a valid child of 'ul'."
8636
8960
  },
8637
- "accessibilityRole": {
8961
+ "accessibilityLabel": {
8638
8962
  "defaultValue": {
8639
- "value": "'adjustable'",
8640
- "computed": false
8963
+ "value": "title",
8964
+ "computed": true
8641
8965
  },
8642
8966
  "type": {
8643
8967
  "name": "string"
8644
8968
  },
8645
8969
  "required": false,
8646
- "description": "Provide custom accessibilityRole for Carousel container"
8970
+ "description": "Provide custom accessibilityLabel for Carousel container"
8647
8971
  },
8648
- "accessibilityLabel": {
8972
+ "accessibilityLiveRegion": {
8649
8973
  "defaultValue": {
8650
- "value": "'carousel'",
8974
+ "value": "'polite'",
8651
8975
  "computed": false
8652
8976
  },
8653
- "type": {
8654
- "name": "string"
8655
- },
8656
- "required": false,
8657
- "description": "Provide custom accessibilityLabel for Carousel container"
8977
+ "required": false
8658
8978
  },
8659
8979
  "tokens": {
8660
8980
  "type": {
@@ -8665,7 +8985,16 @@
8665
8985
  "showPreviousNextNavigation": "show",
8666
8986
  "showPanelNavigation": "show",
8667
8987
  "spaceBetweenSlideAndPreviousNextNavigation": "size",
8668
- "spaceBetweenSlideAndPanelNavigation": "size"
8988
+ "spaceBetweenSlideAndPanelNavigation": "size",
8989
+ "thumbnailBorderColor": "color",
8990
+ "thumbnailBorderRadius": "radius",
8991
+ "thumbnailBorderWidth": "border",
8992
+ "thumbnailContainerPaddingTop": "size",
8993
+ "thumbnailMargin": "size",
8994
+ "thumbnailPadding": "size",
8995
+ "thumbnailSelectedBorderColor": "color",
8996
+ "thumbnailSelectedBorderWidth": "border",
8997
+ "thumbnailSize": "size"
8669
8998
  }
8670
8999
  },
8671
9000
  "required": false,
@@ -8717,6 +9046,20 @@
8717
9046
  "required": false,
8718
9047
  "description": "Called when active index changed\nThis function is also provided with a parameter indicating changed index (either 1, or -1)\nUse it as follows:\n```js\n const onIndexChangedCallback = React.useCallback((changedIndex) => {\n console.log(changedIndex)\n }, []) // pass local dependencies as per your component\n <Carousel\n onIndexChanged={onIndexChangedCallback}\n >\n <Carousel.Item>First Slide</Carousel.Item>\n </Carousel>\n```\nCaution: Always consider wrapping your callback for `onIndexChanged` in `useCallback` in order to avoid bugs and performance issues"
8719
9048
  },
9049
+ "skipLinkHref": {
9050
+ "type": {
9051
+ "name": "string"
9052
+ },
9053
+ "required": false,
9054
+ "description": "If this is a complex carousel with a lot of focusable content, pass a href for a skip link. Typically, this will be an anchor link\nwith the ID of a focusable element immediately after the Carousel, e.g. `'#section-2-heading'`."
9055
+ },
9056
+ "refocus": {
9057
+ "type": {
9058
+ "name": "bool"
9059
+ },
9060
+ "required": false,
9061
+ "description": "If true, whenever a new slide comes into view, the focus of the Carousel switches to the start.\n\nPass this as true when using carousel items that contain interactive content, so a user can easily tab into that content.\n\nIf skipLinkHref is passed, the focus target will be the SkipLink; if not, it'll be an empty element before the slide content."
9062
+ },
8720
9063
  "onAnimationStart": {
8721
9064
  "type": {
8722
9065
  "name": "func"
@@ -8759,6 +9102,13 @@
8759
9102
  },
8760
9103
  "required": false,
8761
9104
  "description": "Use this to override the default text for panel navigation"
9105
+ },
9106
+ "accessibilityRole": {
9107
+ "type": {
9108
+ "name": "string"
9109
+ },
9110
+ "required": false,
9111
+ "description": "Provide custom accessibilityRole for Carousel container"
8762
9112
  }
8763
9113
  },
8764
9114
  "attributes": {
@@ -8882,18 +9232,379 @@
8882
9232
  "name": "node"
8883
9233
  }
8884
9234
  },
8885
- {
8886
- "name": "node"
8887
- }
8888
- ]
8889
- },
8890
- "required": true,
8891
- "description": "Content of the slide"
8892
- }
9235
+ {
9236
+ "name": "node"
9237
+ }
9238
+ ]
9239
+ },
9240
+ "required": true,
9241
+ "description": "Content of the slide"
9242
+ }
9243
+ },
9244
+ "attributes": {
9245
+ "acceptsRNA11yProps": false
9246
+ }
9247
+ }
9248
+ }
9249
+ },
9250
+ "CarouselTabs": {
9251
+ "docs": {
9252
+ "description": "",
9253
+ "props": {
9254
+ "refocus": {
9255
+ "defaultValue": {
9256
+ "value": "true",
9257
+ "computed": false
9258
+ },
9259
+ "type": {
9260
+ "name": "bool"
9261
+ },
9262
+ "required": false,
9263
+ "description": "If true, whenever a new slide comes into view, the focus of the Carousel switches to the start.\n\nPass this as true when using carousel items that contain interactive content, so a user can easily tab into that content.\n\nIf skipLinkHref is passed, the focus target will be the SkipLink; if not, it'll be an empty element before the slide content."
9264
+ },
9265
+ "items": {
9266
+ "type": {
9267
+ "name": "arrayOf",
9268
+ "value": {
9269
+ "name": "shape",
9270
+ "value": {
9271
+ "title": {
9272
+ "name": "string",
9273
+ "required": true
9274
+ },
9275
+ "content": {
9276
+ "name": "node",
9277
+ "required": true
9278
+ }
9279
+ }
9280
+ }
9281
+ },
9282
+ "required": false,
9283
+ "description": "An array of objects where title is the string shown in the slide's tab and content is the JSX for the slide itself"
9284
+ },
9285
+ "tokens": {
9286
+ "type": {
9287
+ "name": "custom",
9288
+ "raw": {
9289
+ "nextIcon": "icon",
9290
+ "previousIcon": "icon",
9291
+ "showPreviousNextNavigation": "show",
9292
+ "showPanelNavigation": "show",
9293
+ "spaceBetweenSlideAndPreviousNextNavigation": "size",
9294
+ "spaceBetweenSlideAndPanelNavigation": "size",
9295
+ "thumbnailBorderColor": "color",
9296
+ "thumbnailBorderRadius": "radius",
9297
+ "thumbnailBorderWidth": "border",
9298
+ "thumbnailContainerPaddingTop": "size",
9299
+ "thumbnailMargin": "size",
9300
+ "thumbnailPadding": "size",
9301
+ "thumbnailSelectedBorderColor": "color",
9302
+ "thumbnailSelectedBorderWidth": "border",
9303
+ "thumbnailSize": "size"
9304
+ }
9305
+ },
9306
+ "required": false,
9307
+ "description": ""
9308
+ },
9309
+ "variant": {
9310
+ "type": {
9311
+ "name": "objectOf",
9312
+ "value": {
9313
+ "name": "union",
9314
+ "value": [
9315
+ {
9316
+ "name": "string"
9317
+ },
9318
+ {
9319
+ "name": "number"
9320
+ },
9321
+ {
9322
+ "name": "bool"
9323
+ }
9324
+ ]
9325
+ }
9326
+ },
9327
+ "required": false,
9328
+ "description": ""
9329
+ },
9330
+ "children": {
9331
+ "type": {
9332
+ "name": "union",
9333
+ "value": [
9334
+ {
9335
+ "name": "arrayOf",
9336
+ "value": {
9337
+ "name": "node"
9338
+ }
9339
+ },
9340
+ {
9341
+ "name": "node"
9342
+ }
9343
+ ]
9344
+ },
9345
+ "required": true,
9346
+ "description": "Slides to render in Carousel. Wrap individual slides in `Carousel.Item`"
9347
+ },
9348
+ "itemLabel": {
9349
+ "type": {
9350
+ "name": "string"
9351
+ },
9352
+ "required": false,
9353
+ "description": "Lowercase language-appropriate user-facing description of what each Carousel slide represents.\nThis is used when generating item labels. For example, if a carousel contains offers,\npass itemLabel=\"summer offer\" (or copy=\"fr\" and an appropriate French translation) to genereate\naccessible labels such as \"Summer offer 1 of 3\" and \"Show summer offer 2 of 3\"."
9354
+ },
9355
+ "previousNextNavigationPosition": {
9356
+ "type": {
9357
+ "name": "enum",
9358
+ "value": [
9359
+ {
9360
+ "value": "'inside'",
9361
+ "computed": false
9362
+ },
9363
+ {
9364
+ "value": "'outside'",
9365
+ "computed": false
9366
+ },
9367
+ {
9368
+ "value": "'edge'",
9369
+ "computed": false
9370
+ }
9371
+ ]
9372
+ },
9373
+ "required": false,
9374
+ "description": "`inside` renders the previous and next buttons inside the slide\n`outside` renders the previous and next buttons outside the slide\n`edge` renders the previous and next buttons at the edge of the slide"
9375
+ },
9376
+ "previousNextIconSize": {
9377
+ "type": {
9378
+ "name": "enum",
9379
+ "value": [
9380
+ {
9381
+ "value": "'default'",
9382
+ "computed": false
9383
+ },
9384
+ {
9385
+ "value": "'small'",
9386
+ "computed": false
9387
+ },
9388
+ {
9389
+ "value": "'large'",
9390
+ "computed": false
9391
+ }
9392
+ ]
9393
+ },
9394
+ "required": false,
9395
+ "description": "Defines the size of the `IconButton` which is being used to render next and previous buttons"
9396
+ },
9397
+ "springConfig": {
9398
+ "type": {
9399
+ "name": "object"
9400
+ },
9401
+ "required": false,
9402
+ "description": "Carousel uses `Animated.spring` to animate slide changes, use this option to pass custom animation configuration"
9403
+ },
9404
+ "thumbnails": {
9405
+ "type": {
9406
+ "name": "arrayOf",
9407
+ "value": {
9408
+ "name": "shape",
9409
+ "value": {
9410
+ "accessibilityLabel": {
9411
+ "name": "string",
9412
+ "required": false
9413
+ },
9414
+ "alt": {
9415
+ "name": "string",
9416
+ "required": false
9417
+ },
9418
+ "src": {
9419
+ "name": "string",
9420
+ "required": false
9421
+ }
9422
+ }
9423
+ }
9424
+ },
9425
+ "required": false,
9426
+ "description": "An array of objects containing information on the thumbnails to be rendered as navigation panel"
9427
+ },
9428
+ "minDistanceForAction": {
9429
+ "type": {
9430
+ "name": "number"
9431
+ },
9432
+ "required": false,
9433
+ "description": "Minimal part of slide width must be swiped for changing index.\nOtherwise animation restore current slide. Default value 0.2 means that 20% must be swiped for change index"
9434
+ },
9435
+ "minDistanceToCapture": {
9436
+ "type": {
9437
+ "name": "number"
9438
+ },
9439
+ "required": false,
9440
+ "description": "Initiate animation after swipe this distance."
9441
+ },
9442
+ "onIndexChanged": {
9443
+ "type": {
9444
+ "name": "func"
9445
+ },
9446
+ "required": false,
9447
+ "description": "Called when active index changed\nThis function is also provided with a parameter indicating changed index (either 1, or -1)\nUse it as follows:\n```js\n const onIndexChangedCallback = React.useCallback((changedIndex) => {\n console.log(changedIndex)\n }, []) // pass local dependencies as per your component\n <Carousel\n onIndexChanged={onIndexChangedCallback}\n >\n <Carousel.Item>First Slide</Carousel.Item>\n </Carousel>\n```\nCaution: Always consider wrapping your callback for `onIndexChanged` in `useCallback` in order to avoid bugs and performance issues"
9448
+ },
9449
+ "skipLinkHref": {
9450
+ "type": {
9451
+ "name": "string"
9452
+ },
9453
+ "required": false,
9454
+ "description": "If this is a complex carousel with a lot of focusable content, pass a href for a skip link. Typically, this will be an anchor link\nwith the ID of a focusable element immediately after the Carousel, e.g. `'#section-2-heading'`."
9455
+ },
9456
+ "panelNavigation": {
9457
+ "type": {
9458
+ "name": "element"
9459
+ },
9460
+ "required": false,
9461
+ "description": "Use this to render a custom panel navigation element instead of the default StepTracker's based navigation\nYou can make use of `useCarousel` within your custom panel navigation component to hook into various Carousel states such as:\n- activeIndex: index of current slide\n- totalItems: total number of slides\nUse it as follows:\n```js\n <Carousel\n panelNavigation={<CustomPanelNavigation />}\n >\n <Carousel.Item>First Slide</Carousel.Item>\n </Carousel>\n```"
9462
+ },
9463
+ "onAnimationStart": {
9464
+ "type": {
9465
+ "name": "func"
9466
+ },
9467
+ "required": false,
9468
+ "description": "When slide animation start\nThis function is also provided with a parameter indicating the current slide index before animation starts\nUse it as follows:\n```js\n const onAnimationStartCallback = React.useCallback((currentIndex) => {\n console.log(currentIndex)\n }, []) // pass local dependencies as per your component\n <Carousel\n onAnimationStart={onAnimationStartCallback}\n >\n <Carousel.Item>First Slide</Carousel.Item>\n </Carousel>\n```\nCaution: Always consider wrapping your callback for `onAnimationStart` in `useCallback` in order to avoid bugs and performance issues"
9469
+ },
9470
+ "onAnimationEnd": {
9471
+ "type": {
9472
+ "name": "func"
9473
+ },
9474
+ "required": false,
9475
+ "description": "When slide animation end with parameter of current index (after animation ends)\nThis function is also provided with a parameter indicating the updated slide index after animation ends\nUse it as follows:\n```js\n const onAnimationEndCallback = React.useCallback((changedIndex) => {\n console.log(changedIndex)\n }, []) // pass local dependencies as per your component\n <Carousel\n onAnimationEnd={onAnimationEndCallback}\n >\n <Carousel.Item>First Slide</Carousel.Item>\n </Carousel>\n```\nCaution: Always consider wrapping your callback for `onAnimationEnd` in `useCallback` in order to avoid bugs and performance issues"
9476
+ },
9477
+ "panelNavigationTextDictionary": {
9478
+ "type": {
9479
+ "name": "shape",
9480
+ "value": {
9481
+ "en": {
9482
+ "name": "shape",
9483
+ "value": {
9484
+ "stepTrackerLabel": {
9485
+ "name": "string",
9486
+ "required": true
9487
+ }
9488
+ },
9489
+ "required": false
9490
+ },
9491
+ "fr": {
9492
+ "name": "shape",
9493
+ "value": {
9494
+ "stepTrackerLabel": {
9495
+ "name": "string",
9496
+ "required": true
9497
+ }
9498
+ },
9499
+ "required": false
9500
+ }
9501
+ }
9502
+ },
9503
+ "required": false,
9504
+ "description": "Use this to override the default text for panel navigation"
8893
9505
  },
8894
- "attributes": {
8895
- "acceptsRNA11yProps": false
9506
+ "accessibilityRole": {
9507
+ "type": {
9508
+ "name": "string"
9509
+ },
9510
+ "required": false,
9511
+ "description": "Provide custom accessibilityRole for Carousel container"
9512
+ },
9513
+ "accessibilityLabel": {
9514
+ "type": {
9515
+ "name": "string"
9516
+ },
9517
+ "required": false,
9518
+ "description": "Provide custom accessibilityLabel for Carousel container"
9519
+ },
9520
+ "tag": {
9521
+ "type": {
9522
+ "name": "enum",
9523
+ "value": [
9524
+ {
9525
+ "value": "'h1'",
9526
+ "computed": false
9527
+ },
9528
+ {
9529
+ "value": "'h2'",
9530
+ "computed": false
9531
+ },
9532
+ {
9533
+ "value": "'h3'",
9534
+ "computed": false
9535
+ },
9536
+ {
9537
+ "value": "'h4'",
9538
+ "computed": false
9539
+ },
9540
+ {
9541
+ "value": "'h5'",
9542
+ "computed": false
9543
+ },
9544
+ {
9545
+ "value": "'h6'",
9546
+ "computed": false
9547
+ },
9548
+ {
9549
+ "value": "'article'",
9550
+ "computed": false
9551
+ },
9552
+ {
9553
+ "value": "'aside'",
9554
+ "computed": false
9555
+ },
9556
+ {
9557
+ "value": "'blockquote'",
9558
+ "computed": false
9559
+ },
9560
+ {
9561
+ "value": "'footer'",
9562
+ "computed": false
9563
+ },
9564
+ {
9565
+ "value": "'figure'",
9566
+ "computed": false
9567
+ },
9568
+ {
9569
+ "value": "'form'",
9570
+ "computed": false
9571
+ },
9572
+ {
9573
+ "value": "'header'",
9574
+ "computed": false
9575
+ },
9576
+ {
9577
+ "value": "'ul'",
9578
+ "computed": false
9579
+ },
9580
+ {
9581
+ "value": "'li'",
9582
+ "computed": false
9583
+ },
9584
+ {
9585
+ "value": "'main'",
9586
+ "computed": false
9587
+ },
9588
+ {
9589
+ "value": "'nav'",
9590
+ "computed": false
9591
+ },
9592
+ {
9593
+ "value": "'section'",
9594
+ "computed": false
9595
+ },
9596
+ {
9597
+ "value": "'label'",
9598
+ "computed": false
9599
+ }
9600
+ ]
9601
+ },
9602
+ "required": false,
9603
+ "description": "HTML tag to use for the Carousel item's immediate parent. Defaults to `'ul'` so that\nassistive technology tools know to intepret the carousel as a list.\n\nNote that if the immediate Carousel children do not all render as `'li'` elements,\nthis should be changed (e.g. pass tag=\"div\") because only 'li' is a valid child of 'ul'."
8896
9604
  }
9605
+ },
9606
+ "attributes": {
9607
+ "acceptsRNA11yProps": false
8897
9608
  }
8898
9609
  }
8899
9610
  },
@@ -8901,6 +9612,17 @@
8901
9612
  "docs": {
8902
9613
  "description": "",
8903
9614
  "props": {
9615
+ "refocus": {
9616
+ "defaultValue": {
9617
+ "value": "false",
9618
+ "computed": false
9619
+ },
9620
+ "type": {
9621
+ "name": "bool"
9622
+ },
9623
+ "required": false,
9624
+ "description": ""
9625
+ },
8904
9626
  "children": {
8905
9627
  "type": {
8906
9628
  "name": "arrayOf",
@@ -8918,30 +9640,23 @@
8918
9640
  "required": true,
8919
9641
  "description": ""
8920
9642
  },
8921
- "totalItems": {
8922
- "type": {
8923
- "name": "number"
8924
- },
8925
- "required": true,
8926
- "description": ""
8927
- },
8928
- "width": {
9643
+ "goTo": {
8929
9644
  "type": {
8930
- "name": "number"
9645
+ "name": "func"
8931
9646
  },
8932
9647
  "required": true,
8933
9648
  "description": ""
8934
9649
  },
8935
- "goTo": {
9650
+ "getCopyWithPlaceholders": {
8936
9651
  "type": {
8937
9652
  "name": "func"
8938
9653
  },
8939
9654
  "required": true,
8940
9655
  "description": ""
8941
9656
  },
8942
- "getCopyWithPlaceholders": {
9657
+ "itemLabel": {
8943
9658
  "type": {
8944
- "name": "func"
9659
+ "name": "string"
8945
9660
  },
8946
9661
  "required": true,
8947
9662
  "description": ""
@@ -8955,11 +9670,34 @@
8955
9670
  "showPreviousNextNavigation": "show",
8956
9671
  "showPanelNavigation": "show",
8957
9672
  "spaceBetweenSlideAndPreviousNextNavigation": "size",
8958
- "spaceBetweenSlideAndPanelNavigation": "size"
9673
+ "spaceBetweenSlideAndPanelNavigation": "size",
9674
+ "thumbnailBorderColor": "color",
9675
+ "thumbnailBorderRadius": "radius",
9676
+ "thumbnailBorderWidth": "border",
9677
+ "thumbnailContainerPaddingTop": "size",
9678
+ "thumbnailMargin": "size",
9679
+ "thumbnailPadding": "size",
9680
+ "thumbnailSelectedBorderColor": "color",
9681
+ "thumbnailSelectedBorderWidth": "border",
9682
+ "thumbnailSize": "size"
8959
9683
  }
8960
9684
  },
8961
9685
  "required": false,
8962
9686
  "description": ""
9687
+ },
9688
+ "totalItems": {
9689
+ "type": {
9690
+ "name": "number"
9691
+ },
9692
+ "required": true,
9693
+ "description": ""
9694
+ },
9695
+ "width": {
9696
+ "type": {
9697
+ "name": "number"
9698
+ },
9699
+ "required": true,
9700
+ "description": ""
8963
9701
  }
8964
9702
  },
8965
9703
  "attributes": {
@@ -9004,6 +9742,27 @@
9004
9742
  "required": false,
9005
9743
  "description": "Array of objects containing specifics for each Checkbox to be rendered in the group."
9006
9744
  },
9745
+ "hintPosition": {
9746
+ "defaultValue": {
9747
+ "value": "'inline'",
9748
+ "computed": false
9749
+ },
9750
+ "type": {
9751
+ "name": "enum",
9752
+ "value": [
9753
+ {
9754
+ "value": "'inline'",
9755
+ "computed": false
9756
+ },
9757
+ {
9758
+ "value": "'below'",
9759
+ "computed": false
9760
+ }
9761
+ ]
9762
+ },
9763
+ "required": false,
9764
+ "description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
9765
+ },
9007
9766
  "tokens": {
9008
9767
  "type": {
9009
9768
  "name": "custom",
@@ -9324,7 +10083,7 @@
9324
10083
  },
9325
10084
  "icon": {
9326
10085
  "type": {
9327
- "name": "func"
10086
+ "name": "elementType"
9328
10087
  },
9329
10088
  "required": false,
9330
10089
  "description": "A valid UDS icon component imported from a UDS palette."
@@ -9571,7 +10330,7 @@
9571
10330
  },
9572
10331
  "icon": {
9573
10332
  "type": {
9574
- "name": "func"
10333
+ "name": "elementType"
9575
10334
  },
9576
10335
  "required": false,
9577
10336
  "description": "A function component for an SVG icon to render inside the link. Inherits size and color from\nthe link and any Typography the link is nested inside."
@@ -9703,6 +10462,27 @@
9703
10462
  "required": false,
9704
10463
  "description": "Array of objects containing specifics for each Radio to be rendered in the group."
9705
10464
  },
10465
+ "hintPosition": {
10466
+ "defaultValue": {
10467
+ "value": "'inline'",
10468
+ "computed": false
10469
+ },
10470
+ "type": {
10471
+ "name": "enum",
10472
+ "value": [
10473
+ {
10474
+ "value": "'inline'",
10475
+ "computed": false
10476
+ },
10477
+ {
10478
+ "value": "'below'",
10479
+ "computed": false
10480
+ }
10481
+ ]
10482
+ },
10483
+ "required": false,
10484
+ "description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
10485
+ },
9706
10486
  "tokens": {
9707
10487
  "type": {
9708
10488
  "name": "custom",
@@ -9922,6 +10702,27 @@
9922
10702
  "required": false,
9923
10703
  "description": "Array of objects containing specifics for each RadioCard to be rendered in the group."
9924
10704
  },
10705
+ "hintPosition": {
10706
+ "defaultValue": {
10707
+ "value": "'inline'",
10708
+ "computed": false
10709
+ },
10710
+ "type": {
10711
+ "name": "enum",
10712
+ "value": [
10713
+ {
10714
+ "value": "'inline'",
10715
+ "computed": false
10716
+ },
10717
+ {
10718
+ "value": "'below'",
10719
+ "computed": false
10720
+ }
10721
+ ]
10722
+ },
10723
+ "required": false,
10724
+ "description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
10725
+ },
9925
10726
  "tokens": {
9926
10727
  "type": {
9927
10728
  "name": "custom",
@@ -10691,6 +11492,27 @@
10691
11492
  },
10692
11493
  "required": false
10693
11494
  },
11495
+ "hintPosition": {
11496
+ "defaultValue": {
11497
+ "value": "'inline'",
11498
+ "computed": false
11499
+ },
11500
+ "type": {
11501
+ "name": "enum",
11502
+ "value": [
11503
+ {
11504
+ "value": "'inline'",
11505
+ "computed": false
11506
+ },
11507
+ {
11508
+ "value": "'below'",
11509
+ "computed": false
11510
+ }
11511
+ ]
11512
+ },
11513
+ "required": false,
11514
+ "description": "Position of the hint relative to label. Use `below` to display a larger hint below the label."
11515
+ },
10694
11516
  "accessibilityRole": {
10695
11517
  "defaultValue": {
10696
11518
  "value": "maxValues === 1\n? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups\n: Platform.select({ web: 'group', default: 'none' })",