@telus-uds/components-base 1.2.0 → 1.4.0

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 (415) hide show
  1. package/.turbo/turbo-build.log +8 -0
  2. package/CHANGELOG.json +61 -0
  3. package/CHANGELOG.md +45 -2
  4. package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +35 -0
  5. package/__tests__/ActivityIndicator/__snapshots__/ActivityIndicator.test.jsx.snap +287 -0
  6. package/__tests__/FlexGrid/Col.test.jsx +6 -10
  7. package/__tests__/utils/props.test.js +36 -0
  8. package/__tests__/utils/semantics.test.jsx +1 -10
  9. package/babel.config.js +27 -5
  10. package/component-docs.json +170 -494
  11. package/generate-component-docs.js +3 -0
  12. package/lib/A11yText/index.js +6 -5
  13. package/lib/ActivityIndicator/Spinner.js +46 -37
  14. package/lib/ActivityIndicator/Spinner.native.js +26 -15
  15. package/lib/ActivityIndicator/index.js +3 -3
  16. package/lib/Box/Box.js +8 -8
  17. package/lib/Button/Button.js +2 -2
  18. package/lib/Button/ButtonBase.js +7 -8
  19. package/lib/Button/ButtonGroup.js +10 -12
  20. package/lib/Button/ButtonLink.js +4 -4
  21. package/lib/Button/propTypes.js +4 -2
  22. package/lib/Card/Card.js +6 -5
  23. package/lib/Card/CardBase.js +6 -9
  24. package/lib/Card/PressableCardBase.js +6 -11
  25. package/lib/Checkbox/Checkbox.js +4 -6
  26. package/lib/Divider/Divider.js +14 -13
  27. package/lib/ExpandCollapse/Control.js +7 -7
  28. package/lib/ExpandCollapse/ExpandCollapse.js +6 -2
  29. package/lib/ExpandCollapse/Panel.js +6 -7
  30. package/lib/Feedback/Feedback.js +6 -5
  31. package/lib/Fieldset/Fieldset.js +1 -3
  32. package/lib/FlexGrid/FlexGrid.js +4 -4
  33. package/lib/FlexGrid/helpers/index.js +1 -4
  34. package/lib/HorizontalScroll/HorizontalScroll.js +5 -6
  35. package/lib/IconButton/IconButton.js +6 -6
  36. package/lib/InputLabel/InputLabel.js +7 -2
  37. package/lib/InputSupports/InputSupports.js +2 -2
  38. package/lib/Link/LinkBase.js +12 -13
  39. package/lib/List/List.js +4 -6
  40. package/lib/List/ListItem.js +6 -2
  41. package/lib/Modal/Modal.js +6 -2
  42. package/lib/Notification/Notification.js +12 -8
  43. package/lib/Pagination/Pagination.js +8 -3
  44. package/lib/Progress/Progress.js +5 -4
  45. package/lib/Progress/ProgressBar.js +8 -7
  46. package/lib/Radio/Radio.js +4 -6
  47. package/lib/Radio/RadioButton.js +6 -3
  48. package/lib/Radio/RadioGroup.js +7 -2
  49. package/lib/RadioCard/RadioCard.js +4 -4
  50. package/lib/RadioCard/RadioCardGroup.js +9 -6
  51. package/lib/Search/Search.js +7 -2
  52. package/lib/Select/Select.js +10 -9
  53. package/lib/SideNav/Item.js +7 -7
  54. package/lib/SideNav/SideNav.js +7 -3
  55. package/lib/Skeleton/Skeleton.js +6 -2
  56. package/lib/Spacer/Spacer.js +9 -20
  57. package/lib/StackView/StackView.js +7 -7
  58. package/lib/StackView/StackWrapBox.js +6 -7
  59. package/lib/StackView/StackWrapGap.js +6 -5
  60. package/lib/StackView/getStackedContent.js +1 -1
  61. package/lib/StepTracker/Step.js +7 -3
  62. package/lib/StepTracker/StepTracker.js +7 -7
  63. package/lib/Tabs/Tabs.js +6 -2
  64. package/lib/Tabs/TabsItem.js +6 -5
  65. package/lib/Tags/Tags.js +11 -12
  66. package/lib/TextInput/TextArea.js +13 -14
  67. package/lib/TextInput/TextInput.js +13 -14
  68. package/lib/TextInput/TextInputBase.js +5 -3
  69. package/lib/ThemeProvider/useThemeTokens.js +3 -3
  70. package/lib/ThemeProvider/utils/theme-tokens.js +3 -3
  71. package/lib/ToggleSwitch/ToggleSwitch.js +10 -9
  72. package/lib/ToggleSwitch/ToggleSwitchGroup.js +10 -12
  73. package/lib/Tooltip/Tooltip.js +7 -2
  74. package/lib/TooltipButton/TooltipButton.js +7 -2
  75. package/lib/Typography/Typography.js +8 -6
  76. package/lib/index.js +7 -0
  77. package/lib/utils/a11y/semantics.js +4 -3
  78. package/lib/utils/children.js +5 -1
  79. package/lib/utils/index.js +18 -4
  80. package/lib/utils/pressability.js +2 -2
  81. package/lib/utils/props/a11yProps.js +153 -0
  82. package/lib/utils/props/clickProps.js +36 -0
  83. package/lib/utils/props/componentPropType.js +70 -0
  84. package/lib/utils/props/copyPropTypes.js +14 -0
  85. package/lib/utils/props/getPropSelector.js +13 -0
  86. package/lib/utils/props/hrefAttrsProp.js +41 -0
  87. package/lib/utils/props/index.js +158 -0
  88. package/lib/{InputSupports/propTypes.js → utils/props/inputSupportsProps.js} +2 -3
  89. package/lib/utils/props/linkProps.js +64 -0
  90. package/lib/utils/props/paddingProp.js +20 -0
  91. package/lib/utils/props/pressProps.js +57 -0
  92. package/lib/utils/props/rectProp.js +20 -0
  93. package/lib/utils/props/responsiveProps.js +40 -0
  94. package/lib/utils/props/selectSystemProps.js +31 -0
  95. package/lib/utils/props/spacingProps.js +71 -0
  96. package/lib/utils/props/tokens.js +145 -0
  97. package/lib/utils/props/variantProp.js +28 -0
  98. package/lib/utils/props/viewProps.js +34 -0
  99. package/lib/utils/ssr.js +51 -0
  100. package/lib/utils/useResponsiveProp.js +1 -1
  101. package/lib/utils/useSpacingScale.js +4 -4
  102. package/lib-module/A11yInfoProvider/index.js +62 -0
  103. package/lib-module/A11yText/index.js +55 -0
  104. package/lib-module/ActivityIndicator/Spinner.js +76 -0
  105. package/lib-module/ActivityIndicator/Spinner.native.js +143 -0
  106. package/lib-module/ActivityIndicator/index.js +40 -0
  107. package/lib-module/ActivityIndicator/shared.js +12 -0
  108. package/lib-module/BaseProvider/index.js +26 -0
  109. package/lib-module/Box/Box.js +243 -0
  110. package/lib-module/Box/index.js +2 -0
  111. package/lib-module/Button/Button.js +25 -0
  112. package/lib-module/Button/ButtonBase.js +254 -0
  113. package/lib-module/Button/ButtonGroup.js +164 -0
  114. package/lib-module/Button/ButtonLink.js +39 -0
  115. package/lib-module/Button/index.js +4 -0
  116. package/lib-module/Button/propTypes.js +36 -0
  117. package/lib-module/Card/Card.js +83 -0
  118. package/lib-module/Card/CardBase.js +62 -0
  119. package/lib-module/Card/PressableCardBase.js +113 -0
  120. package/lib-module/Card/index.js +4 -0
  121. package/lib-module/Checkbox/Checkbox.js +321 -0
  122. package/lib-module/Checkbox/CheckboxGroup.js +218 -0
  123. package/lib-module/Checkbox/CheckboxInput.js +58 -0
  124. package/lib-module/Checkbox/CheckboxInput.native.js +6 -0
  125. package/lib-module/Checkbox/index.js +3 -0
  126. package/lib-module/Divider/Divider.js +123 -0
  127. package/lib-module/Divider/index.js +2 -0
  128. package/lib-module/ExpandCollapse/Accordion.js +15 -0
  129. package/lib-module/ExpandCollapse/Control.js +130 -0
  130. package/lib-module/ExpandCollapse/ExpandCollapse.js +94 -0
  131. package/lib-module/ExpandCollapse/Panel.js +158 -0
  132. package/lib-module/ExpandCollapse/index.js +7 -0
  133. package/lib-module/Feedback/Feedback.js +144 -0
  134. package/lib-module/Feedback/index.js +2 -0
  135. package/lib-module/Fieldset/Fieldset.js +145 -0
  136. package/lib-module/Fieldset/FieldsetContainer.js +29 -0
  137. package/lib-module/Fieldset/FieldsetContainer.native.js +20 -0
  138. package/lib-module/Fieldset/Legend.js +21 -0
  139. package/lib-module/Fieldset/Legend.native.js +28 -0
  140. package/lib-module/Fieldset/cssReset.js +14 -0
  141. package/lib-module/Fieldset/index.js +2 -0
  142. package/lib-module/FlexGrid/Col/Col.js +265 -0
  143. package/lib-module/FlexGrid/Col/index.js +2 -0
  144. package/lib-module/FlexGrid/FlexGrid.js +147 -0
  145. package/lib-module/FlexGrid/Row/Row.js +177 -0
  146. package/lib-module/FlexGrid/Row/index.js +2 -0
  147. package/lib-module/FlexGrid/helpers/index.js +18 -0
  148. package/lib-module/FlexGrid/index.js +2 -0
  149. package/lib-module/FlexGrid/providers/GutterContext.js +3 -0
  150. package/lib-module/HorizontalScroll/HorizontalScroll.js +171 -0
  151. package/lib-module/HorizontalScroll/HorizontalScrollButton.js +102 -0
  152. package/lib-module/HorizontalScroll/ScrollViewEnd.js +47 -0
  153. package/lib-module/HorizontalScroll/ScrollViewEnd.native.js +24 -0
  154. package/lib-module/HorizontalScroll/dictionary.js +11 -0
  155. package/lib-module/HorizontalScroll/index.js +11 -0
  156. package/lib-module/HorizontalScroll/itemPositions.js +106 -0
  157. package/lib-module/Icon/Icon.js +61 -0
  158. package/lib-module/Icon/IconText.js +81 -0
  159. package/lib-module/Icon/index.js +4 -0
  160. package/lib-module/IconButton/IconButton.js +115 -0
  161. package/lib-module/IconButton/index.js +2 -0
  162. package/lib-module/InputLabel/InputLabel.js +131 -0
  163. package/lib-module/InputLabel/LabelContent.js +24 -0
  164. package/lib-module/InputLabel/LabelContent.native.js +16 -0
  165. package/lib-module/InputLabel/index.js +2 -0
  166. package/lib-module/InputSupports/InputSupports.js +88 -0
  167. package/lib-module/InputSupports/index.js +2 -0
  168. package/lib-module/InputSupports/useInputSupports.js +31 -0
  169. package/lib-module/Link/ChevronLink.js +51 -0
  170. package/lib-module/Link/InlinePressable.js +37 -0
  171. package/lib-module/Link/InlinePressable.native.js +85 -0
  172. package/lib-module/Link/Link.js +27 -0
  173. package/lib-module/Link/LinkBase.js +210 -0
  174. package/lib-module/Link/TextButton.js +43 -0
  175. package/lib-module/Link/index.js +5 -0
  176. package/lib-module/List/List.js +55 -0
  177. package/lib-module/List/ListItem.js +213 -0
  178. package/lib-module/List/index.js +5 -0
  179. package/lib-module/Modal/Modal.js +208 -0
  180. package/lib-module/Modal/dictionary.js +9 -0
  181. package/lib-module/Modal/index.js +2 -0
  182. package/lib-module/Notification/Notification.js +196 -0
  183. package/lib-module/Notification/dictionary.js +8 -0
  184. package/lib-module/Notification/index.js +2 -0
  185. package/lib-module/Pagination/PageButton.js +65 -0
  186. package/lib-module/Pagination/Pagination.js +140 -0
  187. package/lib-module/Pagination/SideButton.js +103 -0
  188. package/lib-module/Pagination/dictionary.js +18 -0
  189. package/lib-module/Pagination/index.js +2 -0
  190. package/lib-module/Pagination/usePagination.js +72 -0
  191. package/lib-module/Progress/Progress.js +85 -0
  192. package/lib-module/Progress/ProgressBar.js +134 -0
  193. package/lib-module/Progress/ProgressBarBackground.js +41 -0
  194. package/lib-module/Progress/index.js +4 -0
  195. package/lib-module/Radio/Radio.js +263 -0
  196. package/lib-module/Radio/RadioButton.js +128 -0
  197. package/lib-module/Radio/RadioGroup.js +225 -0
  198. package/lib-module/Radio/RadioInput.js +60 -0
  199. package/lib-module/Radio/RadioInput.native.js +6 -0
  200. package/lib-module/Radio/index.js +3 -0
  201. package/lib-module/RadioCard/RadioCard.js +218 -0
  202. package/lib-module/RadioCard/RadioCardGroup.js +232 -0
  203. package/lib-module/RadioCard/index.js +3 -0
  204. package/lib-module/Search/Search.js +233 -0
  205. package/lib-module/Search/dictionary.js +12 -0
  206. package/lib-module/Search/index.js +2 -0
  207. package/lib-module/Select/Group.js +20 -0
  208. package/lib-module/Select/Group.native.js +14 -0
  209. package/lib-module/Select/Item.js +17 -0
  210. package/lib-module/Select/Item.native.js +9 -0
  211. package/lib-module/Select/Picker.js +67 -0
  212. package/lib-module/Select/Picker.native.js +110 -0
  213. package/lib-module/Select/Select.js +317 -0
  214. package/lib-module/Select/index.js +6 -0
  215. package/lib-module/SideNav/Item.js +139 -0
  216. package/lib-module/SideNav/ItemContent.js +45 -0
  217. package/lib-module/SideNav/ItemsGroup.js +115 -0
  218. package/lib-module/SideNav/SideNav.js +133 -0
  219. package/lib-module/SideNav/index.js +1 -0
  220. package/lib-module/Skeleton/Skeleton.js +117 -0
  221. package/lib-module/Skeleton/index.js +2 -0
  222. package/lib-module/Skeleton/skeleton.constant.js +3 -0
  223. package/lib-module/Skeleton/skeletonWebAnimation.js +18 -0
  224. package/lib-module/Skeleton/useSkeletonNativeAnimation.js +24 -0
  225. package/lib-module/Spacer/Spacer.js +97 -0
  226. package/lib-module/Spacer/index.js +2 -0
  227. package/lib-module/StackView/StackView.js +124 -0
  228. package/lib-module/StackView/StackWrap.js +48 -0
  229. package/lib-module/StackView/StackWrap.native.js +3 -0
  230. package/lib-module/StackView/StackWrapBox.js +114 -0
  231. package/lib-module/StackView/StackWrapGap.js +58 -0
  232. package/lib-module/StackView/common.js +32 -0
  233. package/lib-module/StackView/getStackedContent.js +123 -0
  234. package/lib-module/StackView/index.js +5 -0
  235. package/lib-module/StepTracker/Step.js +229 -0
  236. package/lib-module/StepTracker/StepTracker.js +175 -0
  237. package/lib-module/StepTracker/dictionary.js +10 -0
  238. package/lib-module/StepTracker/index.js +2 -0
  239. package/lib-module/Tabs/Tabs.js +113 -0
  240. package/lib-module/Tabs/TabsItem.js +215 -0
  241. package/lib-module/Tabs/index.js +2 -0
  242. package/lib-module/Tags/Tags.js +238 -0
  243. package/lib-module/Tags/index.js +2 -0
  244. package/lib-module/TextInput/TextArea.js +88 -0
  245. package/lib-module/TextInput/TextInput.js +60 -0
  246. package/lib-module/TextInput/TextInputBase.js +233 -0
  247. package/lib-module/TextInput/index.js +3 -0
  248. package/lib-module/TextInput/propTypes.js +31 -0
  249. package/lib-module/ThemeProvider/ThemeProvider.js +35 -0
  250. package/lib-module/ThemeProvider/index.js +6 -0
  251. package/lib-module/ThemeProvider/useSetTheme.js +22 -0
  252. package/lib-module/ThemeProvider/useTheme.js +14 -0
  253. package/lib-module/ThemeProvider/useThemeTokens.js +105 -0
  254. package/lib-module/ThemeProvider/utils/index.js +2 -0
  255. package/lib-module/ThemeProvider/utils/styles.js +174 -0
  256. package/lib-module/ThemeProvider/utils/theme-tokens.js +151 -0
  257. package/lib-module/ToggleSwitch/ToggleSwitch.js +224 -0
  258. package/lib-module/ToggleSwitch/ToggleSwitchGroup.js +202 -0
  259. package/lib-module/ToggleSwitch/index.js +3 -0
  260. package/lib-module/Tooltip/Backdrop.js +52 -0
  261. package/lib-module/Tooltip/Backdrop.native.js +43 -0
  262. package/lib-module/Tooltip/Tooltip.js +332 -0
  263. package/lib-module/Tooltip/dictionary.js +8 -0
  264. package/lib-module/Tooltip/getTooltipPosition.js +164 -0
  265. package/lib-module/Tooltip/index.js +2 -0
  266. package/lib-module/TooltipButton/TooltipButton.js +71 -0
  267. package/lib-module/TooltipButton/index.js +2 -0
  268. package/lib-module/Typography/Typography.js +118 -0
  269. package/lib-module/Typography/index.js +2 -0
  270. package/lib-module/ViewportProvider/ViewportProvider.js +28 -0
  271. package/lib-module/ViewportProvider/index.js +3 -0
  272. package/lib-module/ViewportProvider/useViewport.js +3 -0
  273. package/lib-module/ViewportProvider/useViewportListener.js +43 -0
  274. package/lib-module/index.js +48 -0
  275. package/lib-module/utils/a11y/index.js +2 -0
  276. package/lib-module/utils/a11y/semantics.js +154 -0
  277. package/lib-module/utils/a11y/textSize.js +34 -0
  278. package/lib-module/utils/animation/index.js +2 -0
  279. package/lib-module/utils/animation/useVerticalExpandAnimation.js +49 -0
  280. package/lib-module/utils/children.js +118 -0
  281. package/lib-module/utils/index.js +15 -0
  282. package/lib-module/utils/info/index.js +7 -0
  283. package/lib-module/utils/info/platform/index.js +11 -0
  284. package/lib-module/utils/info/platform/platform.android.js +1 -0
  285. package/lib-module/utils/info/platform/platform.ios.js +1 -0
  286. package/lib-module/utils/info/platform/platform.js +1 -0
  287. package/lib-module/utils/info/platform/platform.native.js +4 -0
  288. package/lib-module/utils/info/versions.js +5 -0
  289. package/lib-module/utils/input.js +180 -0
  290. package/lib-module/utils/pressability.js +97 -0
  291. package/lib-module/utils/props/a11yProps.js +140 -0
  292. package/lib-module/utils/props/clickProps.js +25 -0
  293. package/lib-module/utils/props/componentPropType.js +63 -0
  294. package/lib-module/utils/props/copyPropTypes.js +2 -0
  295. package/lib-module/utils/props/getPropSelector.js +6 -0
  296. package/lib-module/utils/props/hrefAttrsProp.js +30 -0
  297. package/lib-module/utils/props/index.js +16 -0
  298. package/lib-module/utils/props/inputSupportsProps.js +54 -0
  299. package/lib-module/utils/props/linkProps.js +47 -0
  300. package/lib-module/utils/props/paddingProp.js +9 -0
  301. package/lib-module/utils/props/pressProps.js +42 -0
  302. package/lib-module/utils/props/rectProp.js +9 -0
  303. package/lib-module/utils/props/responsiveProps.js +30 -0
  304. package/lib-module/utils/props/selectSystemProps.js +24 -0
  305. package/lib-module/utils/props/spacingProps.js +56 -0
  306. package/lib-module/utils/props/tokens.js +120 -0
  307. package/lib-module/utils/props/variantProp.js +18 -0
  308. package/lib-module/utils/props/viewProps.js +22 -0
  309. package/lib-module/utils/ssr.js +35 -0
  310. package/lib-module/utils/useCopy.js +42 -0
  311. package/lib-module/utils/useHash.js +44 -0
  312. package/lib-module/utils/useHash.native.js +7 -0
  313. package/lib-module/utils/useResponsiveProp.js +47 -0
  314. package/lib-module/utils/useSpacingScale.js +123 -0
  315. package/lib-module/utils/useUniqueId.js +12 -0
  316. package/lib-module/utils/withLinkRouter.js +82 -0
  317. package/package.json +9 -5
  318. package/src/A11yText/index.jsx +7 -3
  319. package/src/ActivityIndicator/Spinner.jsx +56 -44
  320. package/src/ActivityIndicator/Spinner.native.jsx +20 -12
  321. package/src/ActivityIndicator/index.jsx +1 -1
  322. package/src/Box/Box.jsx +15 -13
  323. package/src/Button/Button.jsx +1 -1
  324. package/src/Button/ButtonBase.jsx +9 -8
  325. package/src/Button/ButtonGroup.jsx +17 -8
  326. package/src/Button/ButtonLink.jsx +1 -1
  327. package/src/Button/propTypes.js +2 -1
  328. package/src/Card/Card.jsx +7 -4
  329. package/src/Card/CardBase.jsx +6 -5
  330. package/src/Card/PressableCardBase.jsx +12 -12
  331. package/src/Checkbox/Checkbox.jsx +12 -5
  332. package/src/Divider/Divider.jsx +19 -12
  333. package/src/ExpandCollapse/Control.jsx +12 -7
  334. package/src/ExpandCollapse/ExpandCollapse.jsx +13 -3
  335. package/src/ExpandCollapse/Panel.jsx +15 -5
  336. package/src/Feedback/Feedback.jsx +13 -3
  337. package/src/Fieldset/Fieldset.jsx +1 -1
  338. package/src/FlexGrid/FlexGrid.jsx +11 -5
  339. package/src/FlexGrid/helpers/index.js +1 -3
  340. package/src/HorizontalScroll/HorizontalScroll.jsx +12 -5
  341. package/src/IconButton/IconButton.jsx +12 -8
  342. package/src/InputLabel/InputLabel.jsx +16 -2
  343. package/src/InputSupports/InputSupports.jsx +1 -1
  344. package/src/Link/LinkBase.jsx +11 -10
  345. package/src/List/List.jsx +12 -5
  346. package/src/List/ListItem.jsx +16 -2
  347. package/src/Modal/Modal.jsx +63 -50
  348. package/src/Notification/Notification.jsx +23 -6
  349. package/src/Pagination/Pagination.jsx +10 -3
  350. package/src/Progress/Progress.jsx +5 -3
  351. package/src/Progress/ProgressBar.jsx +8 -6
  352. package/src/Radio/Radio.jsx +13 -5
  353. package/src/Radio/RadioButton.jsx +13 -3
  354. package/src/Radio/RadioGroup.jsx +14 -2
  355. package/src/RadioCard/RadioCard.jsx +9 -6
  356. package/src/RadioCard/RadioCardGroup.jsx +16 -4
  357. package/src/Search/Search.jsx +15 -3
  358. package/src/Select/Select.jsx +21 -7
  359. package/src/SideNav/Item.jsx +15 -7
  360. package/src/SideNav/SideNav.jsx +13 -2
  361. package/src/Skeleton/Skeleton.jsx +55 -43
  362. package/src/Spacer/Spacer.jsx +10 -18
  363. package/src/StackView/StackView.jsx +13 -12
  364. package/src/StackView/StackWrapBox.jsx +12 -12
  365. package/src/StackView/StackWrapGap.jsx +9 -7
  366. package/src/StackView/getStackedContent.jsx +1 -1
  367. package/src/StepTracker/Step.jsx +7 -4
  368. package/src/StepTracker/StepTracker.jsx +8 -8
  369. package/src/Tabs/Tabs.jsx +16 -3
  370. package/src/Tabs/TabsItem.jsx +13 -9
  371. package/src/Tags/Tags.jsx +16 -7
  372. package/src/TextInput/TextArea.jsx +20 -8
  373. package/src/TextInput/TextInput.jsx +20 -8
  374. package/src/TextInput/TextInputBase.jsx +13 -3
  375. package/src/ThemeProvider/useThemeTokens.js +3 -3
  376. package/src/ThemeProvider/utils/theme-tokens.js +3 -3
  377. package/src/ToggleSwitch/ToggleSwitch.jsx +12 -7
  378. package/src/ToggleSwitch/ToggleSwitchGroup.jsx +14 -6
  379. package/src/Tooltip/Tooltip.jsx +13 -3
  380. package/src/TooltipButton/TooltipButton.jsx +6 -4
  381. package/src/Typography/Typography.jsx +10 -6
  382. package/src/index.js +1 -1
  383. package/src/utils/a11y/semantics.js +3 -2
  384. package/src/utils/children.jsx +2 -1
  385. package/src/utils/index.js +2 -1
  386. package/src/utils/pressability.js +1 -1
  387. package/src/utils/props/a11yProps.js +151 -0
  388. package/src/utils/props/clickProps.js +31 -0
  389. package/src/utils/props/componentPropType.js +67 -0
  390. package/src/utils/props/copyPropTypes.js +3 -0
  391. package/src/utils/props/getPropSelector.js +14 -0
  392. package/src/utils/props/hrefAttrsProp.js +25 -0
  393. package/src/utils/props/index.js +16 -0
  394. package/src/{InputSupports/propTypes.js → utils/props/inputSupportsProps.js} +2 -4
  395. package/src/utils/props/linkProps.js +43 -0
  396. package/src/utils/props/paddingProp.js +10 -0
  397. package/src/utils/props/pressProps.js +45 -0
  398. package/src/utils/props/rectProp.js +10 -0
  399. package/src/utils/props/responsiveProps.js +30 -0
  400. package/src/utils/props/selectSystemProps.js +25 -0
  401. package/src/utils/props/spacingProps.js +58 -0
  402. package/src/utils/props/tokens.js +150 -0
  403. package/src/utils/props/variantProp.js +20 -0
  404. package/src/utils/props/viewProps.js +23 -0
  405. package/src/utils/ssr.js +35 -0
  406. package/src/utils/useResponsiveProp.js +1 -1
  407. package/src/utils/useSpacingScale.js +4 -4
  408. package/.ultra.cache.json +0 -1
  409. package/lib/utils/a11y/propTypes.js +0 -61
  410. package/lib/utils/a11y/propTypes.native.js +0 -47
  411. package/lib/utils/propTypes.js +0 -566
  412. package/release-context.json +0 -7
  413. package/src/utils/a11y/propTypes.js +0 -61
  414. package/src/utils/a11y/propTypes.native.js +0 -39
  415. package/src/utils/propTypes.js +0 -561
@@ -0,0 +1,171 @@
1
+ import React, { forwardRef, useEffect, useRef, useState } from 'react';
2
+ import PropTypes from 'prop-types';
3
+ import Platform from "react-native-web/dist/exports/Platform";
4
+ import StyleSheet from "react-native-web/dist/exports/StyleSheet";
5
+ import View from "react-native-web/dist/exports/View";
6
+ import { validateThemeTokens, resolveThemeTokens } from '../ThemeProvider';
7
+ import { a11yProps, getTokensSetPropType, selectSystemProps, selectTokens, viewProps } from '../utils';
8
+ import ScrollViewEnd from './ScrollViewEnd';
9
+ import { getItemPositionScrollTarget, itemPositionsPropType } from './itemPositions';
10
+ import { jsx as _jsx } from "react/jsx-runtime";
11
+ import { jsxs as _jsxs } from "react/jsx-runtime";
12
+ const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
13
+ const tokenKeys = ['nextIcon', 'previousIcon', 'gutter', 'borderBottomWidth', 'borderBottomColor', 'buttonClearance'];
14
+ export const selectHorizontalScrollTokens = (themeTokens, prefix) => selectTokens(tokenKeys, themeTokens, prefix);
15
+ /**
16
+ * Base component that scrolls horizontally and displays left and right buttons if
17
+ * there is content to the left and the right which can be scrolled to.
18
+ *
19
+ * @TODO revisit `ScrollButton` after IconButton is stable.
20
+ */
21
+
22
+ const HorizontalScroll = /*#__PURE__*/forwardRef(({
23
+ ScrollButton,
24
+ tokens,
25
+ itemPositions,
26
+ children,
27
+ ...rest
28
+ }, ref) => {
29
+ const {
30
+ nextIcon,
31
+ previousIcon,
32
+ gutter,
33
+ borderBottomWidth,
34
+ borderBottomColor,
35
+ buttonClearance = 0
36
+ } = validateThemeTokens(resolveThemeTokens(tokens), // Allow missing icons
37
+ getTokensSetPropType(tokenKeys, {
38
+ partial: true
39
+ }), 'HorizontalScroll');
40
+ const [containerWidth, setContainerWidth] = useState(0);
41
+ const [contentWidth, setContentWidth] = useState(0);
42
+
43
+ const handleContentWidth = width => setContentWidth(width);
44
+
45
+ const handleContainerLayout = ({
46
+ nativeEvent: {
47
+ layout: {
48
+ width
49
+ }
50
+ }
51
+ }) => setContainerWidth(width); // Update the scroll position only when scrolling actions ends to minimally rerender
52
+ // and update which buttons are conditionally rendered.
53
+
54
+
55
+ const [scrollOffset, setScrollOffset] = useState(0);
56
+
57
+ const handleScrollEnd = ({
58
+ nativeEvent: {
59
+ contentOffset: {
60
+ x
61
+ }
62
+ }
63
+ }) => {
64
+ setScrollOffset(x);
65
+ };
66
+
67
+ const scrollMax = Math.max(0, contentWidth - containerWidth);
68
+ const showNextButton = scrollOffset < scrollMax;
69
+ const showPreviousButton = scrollOffset > 0;
70
+ const scrollRef = useRef(null);
71
+
72
+ const scrollTo = targetX => {
73
+ var _scrollRef$current;
74
+
75
+ if (typeof ((_scrollRef$current = scrollRef.current) === null || _scrollRef$current === void 0 ? void 0 : _scrollRef$current.scrollTo) === 'function') {
76
+ const x = getItemPositionScrollTarget(targetX, scrollMax, itemPositions.positions, buttonClearance);
77
+ scrollRef.current.scrollTo({
78
+ x,
79
+ animated: true
80
+ });
81
+
82
+ if (Platform.OS === 'android') {
83
+ // React Native calls onScrollMomentumEnd after scrollTo for iOS, but not Android.
84
+ // See https://github.com/facebook/react-native/issues/26661
85
+ // There's also no callback for when scrollTo finishes.
86
+ setTimeout(() => setScrollOffset(x), 300);
87
+ }
88
+ }
89
+ }; // Make scrollTo and relevant co-ordinates available to any component with an interest in itemPositions.
90
+ // ItemPositions is a mutable ref object intended to have its properties mutated without any rerenders.
91
+
92
+ /* eslint-disable-next-line no-param-reassign */
93
+
94
+
95
+ itemPositions.scrollTo = scrollTo;
96
+ /* eslint-disable-next-line no-param-reassign */
97
+
98
+ itemPositions.containerWidth = containerWidth;
99
+ /* eslint-disable-next-line no-param-reassign */
100
+
101
+ itemPositions.contentWidth = contentWidth;
102
+ /* eslint-disable-next-line no-param-reassign */
103
+
104
+ itemPositions.scrollOffset = scrollOffset;
105
+ const hasWidths = itemPositions.contentWidth > 0 && itemPositions.contentWidth > 0;
106
+ useEffect(() => {
107
+ if (hasWidths) itemPositions.setIsReady(true); // itemPositions is a ref object so this should occur only when elements' widths are set in state
108
+ }, [hasWidths, itemPositions]); // When scrolling, allow clearance around scroll buttons, so e.g. this...
109
+ // (<-) Item 5 Item 6 Item 7 Item 8 It(->)
110
+ // ...doesn't scroll like this with Item 9 never being properly visible:
111
+ // (<-)em 9 Item 10 Item 11 Item 12 Item (->)
112
+
113
+ const scrollDistance = containerWidth - buttonClearance * 2;
114
+
115
+ const scrollNext = () => scrollTo(scrollOffset + scrollDistance);
116
+
117
+ const scrollPrevious = () => scrollTo(scrollOffset - scrollDistance); // On Web, being scrollable in one direction prevents overflow: visible in the other direction.
118
+ // Apply a fixed margin gutter that tab highlight effects can overhang without getting trimmed.
119
+
120
+
121
+ return /*#__PURE__*/_jsxs(View, {
122
+ ref: ref,
123
+ style: staticStyles.container,
124
+ children: [/*#__PURE__*/_jsx(ScrollViewEnd, {
125
+ onScrollEnd: handleScrollEnd,
126
+ ref: scrollRef,
127
+ horizontal: true,
128
+ onContentSizeChange: handleContentWidth,
129
+ onLayout: handleContainerLayout,
130
+ showsHorizontalScrollIndicator: false,
131
+ contentContainerStyle: [staticStyles.scrollContainer, {
132
+ marginBottom: gutter,
133
+ borderBottomWidth,
134
+ borderBottomColor
135
+ }],
136
+ ...selectProps(rest),
137
+ children: children
138
+ }), showPreviousButton && /*#__PURE__*/_jsx(ScrollButton, {
139
+ icon: previousIcon,
140
+ onPress: scrollPrevious,
141
+ offset: gutter,
142
+ direction: "previous"
143
+ }), showNextButton && /*#__PURE__*/_jsx(ScrollButton, {
144
+ icon: nextIcon,
145
+ onPress: scrollNext,
146
+ offset: gutter,
147
+ direction: "next"
148
+ })]
149
+ });
150
+ });
151
+ HorizontalScroll.displayName = 'HorizontalScroll';
152
+ const staticStyles = StyleSheet.create({
153
+ scrollContainer: {
154
+ // Gives inner container width from content, allowing it to exceed its container's width
155
+ alignSelf: 'flex-start',
156
+ flexGrow: 1
157
+ },
158
+ container: {
159
+ // Vertically center the ScrollButtons buttons
160
+ justifyContent: 'center'
161
+ }
162
+ });
163
+ HorizontalScroll.propTypes = { ...selectedSystemPropTypes,
164
+ itemPositions: itemPositionsPropType,
165
+ ScrollButton: PropTypes.elementType,
166
+ tokens: getTokensSetPropType(tokenKeys, {
167
+ allowFunction: true
168
+ }),
169
+ children: PropTypes.node
170
+ };
171
+ export default HorizontalScroll;
@@ -0,0 +1,102 @@
1
+ import React, { forwardRef } from 'react';
2
+ import PropTypes from 'prop-types';
3
+ import Pressable from "react-native-web/dist/exports/Pressable";
4
+ import StyleSheet from "react-native-web/dist/exports/StyleSheet";
5
+ import { useThemeTokensCallback } from '../ThemeProvider';
6
+ import { resolvePressableTokens, selectTokens, variantProp, getTokensPropType, useCopy, copyPropTypes, a11yProps } from '../utils';
7
+ import Icon from '../Icon';
8
+ import Typography from '../Typography';
9
+ import dictionary from './dictionary';
10
+ import { jsx as _jsx } from "react/jsx-runtime";
11
+
12
+ const selectButtonStyles = ({
13
+ borderRadius,
14
+ backgroundColor,
15
+ borderColor,
16
+ borderWidth,
17
+ padding
18
+ }, direction) => [staticStyles.absolute, staticStyles[direction], {
19
+ borderRadius,
20
+ backgroundColor,
21
+ borderColor,
22
+ borderWidth,
23
+ padding
24
+ }];
25
+ /**
26
+ * Button within a Tabs component showing users that content is available to the left or
27
+ * right, scrolling a screen's worth of content left or right when pressed.
28
+ *
29
+ * This is rendered automatically by `Tabs` and isn't intended be used directly.
30
+ *
31
+ * @TODO when IconButton is complete and stable revisit this and update interaction state styles.
32
+ */
33
+
34
+
35
+ const HorizontalScrollButton = /*#__PURE__*/forwardRef(({
36
+ direction = 'next',
37
+ icon,
38
+ onPress,
39
+ offset,
40
+ variant,
41
+ tokens,
42
+ copy
43
+ }, ref) => {
44
+ const getTokens = useThemeTokensCallback('HorizontalScrollButton', tokens, variant);
45
+
46
+ const resolveButtonTokens = pressableState => resolvePressableTokens(getTokens, pressableState);
47
+
48
+ const getPressableStyle = pressableState => [selectButtonStyles(resolveButtonTokens(pressableState), direction), {
49
+ marginTop: -1 * (offset || 0)
50
+ }];
51
+
52
+ const getCopy = useCopy({
53
+ dictionary,
54
+ copy
55
+ });
56
+ const label = direction === 'previous' ? getCopy('previousText') : getCopy('nextText');
57
+ return /*#__PURE__*/_jsx(Pressable, {
58
+ ref: ref,
59
+ style: getPressableStyle,
60
+ onPress: onPress,
61
+ accessibilityLabel: label,
62
+ accessibilityRole: "button" // For keyboard-tab or screenreader-swipe navigation, users can just go through all items
63
+ ,
64
+ ...a11yProps.nonFocusableProps,
65
+ children: pressableState => {
66
+ const iconTokens = selectTokens('Icon', resolveButtonTokens(pressableState), 'icon');
67
+ return icon ? /*#__PURE__*/_jsx(Icon, {
68
+ icon: icon,
69
+ tokens: iconTokens
70
+ }) : /*#__PURE__*/_jsx(Typography, {
71
+ tokens: {
72
+ fontSize: iconTokens.size,
73
+ lineHeight: 1,
74
+ color: iconTokens.color
75
+ },
76
+ children: direction === 'next' ? '→' : '←'
77
+ });
78
+ }
79
+ });
80
+ });
81
+ HorizontalScrollButton.displayName = 'HorizontalScrollButton';
82
+ const staticStyles = StyleSheet.create({
83
+ absolute: {
84
+ position: 'absolute'
85
+ },
86
+ previous: {
87
+ left: 0
88
+ },
89
+ next: {
90
+ right: 0
91
+ }
92
+ });
93
+ HorizontalScrollButton.propTypes = {
94
+ tokens: getTokensPropType('HorizontalScrollButton'),
95
+ variant: variantProp.propType,
96
+ copy: copyPropTypes,
97
+ direction: PropTypes.oneOf(['previous', 'next']),
98
+ offset: PropTypes.number,
99
+ icon: PropTypes.elementType,
100
+ onPress: PropTypes.func.isRequired
101
+ };
102
+ export default HorizontalScrollButton;
@@ -0,0 +1,47 @@
1
+ import React, { forwardRef, useCallback, useEffect } from 'react';
2
+ import PropTypes from 'prop-types';
3
+ import ScrollView from "react-native-web/dist/exports/ScrollView";
4
+ import debounce from 'lodash.debounce';
5
+ import { jsx as _jsx } from "react/jsx-runtime";
6
+ const DEBOUNCE_MS = 100;
7
+ /**
8
+ * A wrapper for ScrollView that supports an `onScrollEnd` function.
9
+ *
10
+ * React Native Web hasn't got around to implementing any scroll end handlers yet,
11
+ * so we need to work around it with debouncing on `onScroll`. See:
12
+ * https://github.com/necolas/react-native-web/issues/1021
13
+ */
14
+
15
+ const ScrollViewEnd = /*#__PURE__*/forwardRef(({
16
+ onScrollEnd,
17
+ onScroll,
18
+ ...props
19
+ }, ref) => {
20
+ // Return debounced function directly from useCallback so it has .cancel method etc.
21
+ // Linter complains this stops it automatically scanning the deps, but we can check them manually.
22
+ // eslint-disable-next-line react-hooks/exhaustive-deps
23
+ const debounceScrollEnd = useCallback(debounce(event => onScrollEnd(event), DEBOUNCE_MS), [onScrollEnd]); // Call any onScroll handler immediately, and any onScrollEnd handler after 100ms of no scrolling
24
+
25
+ const handleScroll = event => {
26
+ if (typeof onScroll === 'function') onScroll(event);
27
+ if (typeof onScrollEnd === 'function') debounceScrollEnd(event);
28
+ }; // Cancel any lingering debounce timeouts on dismount
29
+
30
+
31
+ useEffect(() => debounceScrollEnd.cancel);
32
+ return /*#__PURE__*/_jsx(ScrollView, {
33
+ ref: ref,
34
+ ...props,
35
+ onScroll: handleScroll,
36
+ scrollEventThrottle: DEBOUNCE_MS / 2
37
+ });
38
+ });
39
+ ScrollViewEnd.displayName = 'ScrollViewEnd';
40
+ ScrollViewEnd.propTypes = {
41
+ onScrollEnd: PropTypes.func.isRequired,
42
+ onScroll: PropTypes.func
43
+ };
44
+ ScrollViewEnd.defaultProps = {
45
+ onScroll: null
46
+ };
47
+ export default ScrollViewEnd;
@@ -0,0 +1,24 @@
1
+ import React, { forwardRef } from 'react';
2
+ import PropTypes from 'prop-types';
3
+ import ScrollView from "react-native-web/dist/exports/ScrollView";
4
+ /**
5
+ * A wrapper for ScrollView that supports an `onScrollEnd` function.
6
+ *
7
+ * React Native has two scroll end handlers, we want to treat them both the same.
8
+ */
9
+
10
+ import { jsx as _jsx } from "react/jsx-runtime";
11
+ const ScrollViewEnd = /*#__PURE__*/forwardRef(({
12
+ onScrollEnd,
13
+ ...props
14
+ }, ref) => /*#__PURE__*/_jsx(ScrollView, {
15
+ ref: ref,
16
+ ...props,
17
+ onScrollEndDrag: onScrollEnd,
18
+ onMomentumScrollEnd: onScrollEnd
19
+ }));
20
+ ScrollViewEnd.displayName = 'ScrollViewEnd';
21
+ ScrollViewEnd.propTypes = {
22
+ onScrollEnd: PropTypes.func.isRequired
23
+ };
24
+ export default ScrollViewEnd;
@@ -0,0 +1,11 @@
1
+ export default {
2
+ en: {
3
+ // English text from TDS Community `Tabs`
4
+ previousLabel: 'Move menu to the left',
5
+ nextLabel: 'Move menu to the right'
6
+ },
7
+ fr: {
8
+ previousLabel: 'Déplacer le menu vers la gauche',
9
+ nextLabel: 'Déplacer le menu vers la droite'
10
+ }
11
+ };
@@ -0,0 +1,11 @@
1
+ import HorizontalScroll, { selectHorizontalScrollTokens } from './HorizontalScroll';
2
+ import { useItemPositions, getItemPositionScrollTarget, getItemPositionLayoutHandler, itemPositionsPropType } from './itemPositions';
3
+ export default HorizontalScroll;
4
+ export { default as HorizontalScrollButton } from './HorizontalScrollButton';
5
+ export const horizontalScrollUtils = {
6
+ selectHorizontalScrollTokens,
7
+ useItemPositions,
8
+ getItemPositionScrollTarget,
9
+ getItemPositionLayoutHandler,
10
+ itemPositionsPropType
11
+ };
@@ -0,0 +1,106 @@
1
+ import { useRef, useState } from 'react';
2
+ import PropTypes from 'prop-types'; // Utilities to assist scrolling a parent so that it snaps neatly to an appropriate child.
3
+
4
+ /**
5
+ * @typedef ItemPositionPosition
6
+ * @property {number} [ItemPositionItem.start] - optional theme scale variants e.g. compact, wide
7
+ * @property {number} [ItemPositionItem.end] - optional override to force a particular pixel size
8
+ *
9
+ * @typedef {Object.<number, ItemPositionItem>} ItemPositionPositions - ref object of start/end coordinates
10
+ *
11
+ * @typedef ItemPositions
12
+ * @property {number} ItemPositions.contentWidth - current width of potentially-overflowing content inside scrollable
13
+ * @property {number} ItemPositions.containerWidth - current width of non-overflowing outer scroll container
14
+ * @property {number} ItemPositions.scrollOffset - current x position of the left edge of the visible section of the scrollable content
15
+ * @property {ItemPositionPositions} ItemPositions.positions - `{ start, end }` coordinates of each scrollable content item, by index
16
+ * @property {(targetX: number) => void)} ItemPositions.scrollTo - function to scroll to a co-ordinate, applying scrolling logic
17
+ * @property {() => void)} ItemPositions.setIsReady - function to call when layout has been calculated and itemPositions data is ready
18
+ */
19
+
20
+ /**
21
+ * Takes a desired scroll target coordinate and returns a valid coordinate
22
+ * that, when not scrolling to one end or another, snaps to the start of an item,
23
+ * making sure any "scroll back" button doesn't overlap the first item.
24
+ *
25
+ * @param {number} x - the intended coordinate to scroll to
26
+ * @param {number} scrollMax - the highest posible coordinate to scroll to
27
+ * @param {ItemPositionPositions} positions - positions list from `useItemPositions` ref
28
+ * @param {number} [buttonClearance] - offset to allow space for a button
29
+ * @returns {number}
30
+ */
31
+
32
+ export const getItemPositionScrollTarget = (x, scrollMax, positions, buttonClearance = 0) => {
33
+ if (x <= 0) return 0;
34
+ if (x >= scrollMax) return scrollMax; // If not scrolling all the way to the start or end, stop
35
+ // where the first item is not coverred by the scroll previous button
36
+
37
+ const targetItem = Object.values(positions).find(({
38
+ start,
39
+ end
40
+ }) => start <= x && end > x); // If there's no target item we're landing at a gap between items
41
+
42
+ const targetX = targetItem ? targetItem.start : x;
43
+ return Math.max(0, targetX - buttonClearance);
44
+ };
45
+ /**
46
+ * Returns a handler for React Native's `onLayout` which updates the values of
47
+ * the ref object returned from `useItemPositions`.
48
+ *
49
+ * @param {ItemPositionPositions} positions
50
+ * @param {number} index
51
+ * @returns {function}
52
+ */
53
+
54
+ export const getItemPositionLayoutHandler = (positions, index) => {
55
+ const handleLayout = ({
56
+ nativeEvent: {
57
+ layout: {
58
+ width,
59
+ x
60
+ }
61
+ }
62
+ }) => {
63
+ /* eslint-disable-next-line no-param-reassign */
64
+ positions[index] = {
65
+ start: x,
66
+ end: x + width
67
+ };
68
+ };
69
+
70
+ return handleLayout;
71
+ };
72
+ /**
73
+ * Wrapper for `useRef` which gives a mutable object in which item start/end coordinates,
74
+ * scrollTo method and content/container widths may be set and updated without causing a re-render.
75
+ *
76
+ * @returns {[ItemPositions, isReady: bool]} tuple array of:
77
+ * - current ref object `{ positions, contentWidth, containerWidth, scrollOffset, scrollTo, setIsReady }`
78
+ * - boolean that updates to `true` (causing a re-render) after the first time `setIsReady` is called
79
+ */
80
+
81
+ export const useItemPositions = () => {
82
+ const [isReady, setIsReady] = useState(false);
83
+ return [useRef({
84
+ positions: {},
85
+ scrollTo: () => {},
86
+ contentWidth: 0,
87
+ containerWidth: 0,
88
+ scrollOffset: 0,
89
+ setIsReady
90
+ }).current, isReady];
91
+ };
92
+ /**
93
+ * PropType for the ref object returned by `useItemPositions`
94
+ */
95
+
96
+ export const itemPositionsPropType = PropTypes.exact({
97
+ positions: PropTypes.objectOf(PropTypes.shape({
98
+ start: PropTypes.number,
99
+ end: PropTypes.number
100
+ })),
101
+ scrollTo: PropTypes.func,
102
+ contentWidth: PropTypes.number,
103
+ containerWidth: PropTypes.number,
104
+ scrollOffset: PropTypes.number,
105
+ setIsReady: PropTypes.func
106
+ });
@@ -0,0 +1,61 @@
1
+ import React, { forwardRef } from 'react';
2
+ import Platform from "react-native-web/dist/exports/Platform";
3
+ import View from "react-native-web/dist/exports/View";
4
+ import PropTypes from 'prop-types';
5
+ import { useThemeTokens } from '../ThemeProvider';
6
+ import { getTokensPropType, scaleWithText, variantProp } from '../utils';
7
+ import { jsx as _jsx } from "react/jsx-runtime";
8
+ const Icon = /*#__PURE__*/forwardRef(({
9
+ icon: IconComponent,
10
+ accessibilityLabel,
11
+ variant,
12
+ tokens,
13
+ scalesWithText = false,
14
+ dataSet
15
+ }, ref) => {
16
+ const themeTokens = useThemeTokens('Icon', tokens, variant);
17
+ const size = scalesWithText ? scaleWithText(themeTokens.size) : themeTokens.size;
18
+
19
+ const iconContent = /*#__PURE__*/_jsx(IconComponent, {
20
+ title: accessibilityLabel,
21
+ size: size,
22
+ color: themeTokens.color
23
+ });
24
+
25
+ return Platform.OS === 'web' ? /*#__PURE__*/_jsx(View, {
26
+ ref: ref // eslint-disable-next-line react-native/no-inline-styles
27
+ ,
28
+ style: {
29
+ // TODO: systematise animations.
30
+ // https://github.com/telus/universal-design-system/issues/487
31
+ transition: 'transform 200ms, color 200ms',
32
+ transform: [themeTokens.scale ? `scale(${themeTokens.scale})` : '', themeTokens.translateX ? `translateX(${themeTokens.translateX}px)` : '', themeTokens.translateY ? `translateY(${themeTokens.translateY}px)` : ''].filter(exists => exists).join(' ')
33
+ },
34
+ dataSet: dataSet,
35
+ children: iconContent
36
+ }) : iconContent;
37
+ });
38
+ Icon.displayName = 'Icon';
39
+ export const iconComponentPropTypes = {
40
+ variant: variantProp.propType,
41
+ tokens: getTokensPropType('Icon'),
42
+
43
+ /**
44
+ * Descriptive label used in web SVG title tag for accessibility
45
+ */
46
+ accessibilityLabel: PropTypes.string,
47
+
48
+ /**
49
+ * controls whether the icon size should be proportionate to any accessibility-related font scaling.
50
+ */
51
+ scalesWithText: PropTypes.bool
52
+ };
53
+ Icon.propTypes = { ...iconComponentPropTypes,
54
+
55
+ /**
56
+ * A valid UDS icon component imported from a UDS palette
57
+ * (e.g.) `import { MyIcon } from @telus-uds/palette-<brand>/build/web/icons`
58
+ */
59
+ icon: PropTypes.elementType.isRequired
60
+ };
61
+ export default Icon;
@@ -0,0 +1,81 @@
1
+ import React, { forwardRef } from 'react';
2
+ import PropTypes from 'prop-types';
3
+ import Platform from "react-native-web/dist/exports/Platform";
4
+ import View from "react-native-web/dist/exports/View";
5
+ import Icon, { iconComponentPropTypes } from './Icon';
6
+ import { getStackedContent } from '../StackView';
7
+ import { spacingProps } from '../utils';
8
+ /**
9
+ * Returns an icon and some text with a sized gap between them. This is a utility component
10
+ * intended for use when creating components, not intended for use in applications on its own.
11
+ *
12
+ * IconText does not wrap its children, so should be used either:
13
+ * - inline within a <Text> element
14
+ * - within a container with `flexDirection: 'row'`
15
+ */
16
+
17
+ import { jsx as _jsx } from "react/jsx-runtime";
18
+ const IconText = /*#__PURE__*/forwardRef(({
19
+ space,
20
+ iconPosition = 'left',
21
+ icon: IconComponent,
22
+ iconProps,
23
+ children
24
+ }, ref) => {
25
+ var _iconProps$tokens;
26
+
27
+ const iconContent = IconComponent && /*#__PURE__*/_jsx(Icon, {
28
+ ref: ref,
29
+ icon: IconComponent,
30
+ scalesWithText: true,
31
+ ...iconProps
32
+ }); // Inline images on Android are always baseline-aligned which makes them look misaligned - offset it.
33
+ // See abandoned issue https://github.com/facebook/react-native/issues/6529
34
+
35
+
36
+ const size = iconProps === null || iconProps === void 0 ? void 0 : (_iconProps$tokens = iconProps.tokens) === null || _iconProps$tokens === void 0 ? void 0 : _iconProps$tokens.size;
37
+ const iconAdjusted = Platform.OS === 'android' && iconContent && size ? /*#__PURE__*/_jsx(View, {
38
+ style: {
39
+ transform: [{
40
+ translateY: size * 0.2
41
+ }]
42
+ },
43
+ children: iconContent
44
+ }) : iconContent;
45
+ return getStackedContent(iconPosition === 'left' ? [iconAdjusted, children] : [children, iconAdjusted], {
46
+ space,
47
+ direction: 'row'
48
+ });
49
+ });
50
+ IconText.displayName = 'IconText';
51
+ IconText.propTypes = {
52
+ /**
53
+ * Amount of space to separate the text content and icon. Uses the themes's spacing scale
54
+ * (see useSpacingScale for more info).
55
+ */
56
+ space: spacingProps.types.spacingValue,
57
+
58
+ /**
59
+ * Whether the icon should be to the left of the content or the right of the content.
60
+ */
61
+ iconPosition: PropTypes.oneOf(['left', 'right']),
62
+
63
+ /**
64
+ * A valid UDS icon component imported from a UDS palette.
65
+ */
66
+ icon: PropTypes.func,
67
+
68
+ /**
69
+ * Props that will be passed to the icon component. By default the icon's `scalesWithText`
70
+ * prop will be set as "true" so that the icon continues to match the size of the text
71
+ * if users use accessibility settings to increase text size.
72
+ */
73
+ iconProps: PropTypes.exact(iconComponentPropTypes),
74
+
75
+ /**
76
+ * Content to be rendered alongside the Icon component. Usually this should be a
77
+ * `<Typography>` component, or a component that renders `<Text>`.
78
+ */
79
+ children: PropTypes.node
80
+ };
81
+ export default IconText;
@@ -0,0 +1,4 @@
1
+ import Icon, { iconComponentPropTypes } from './Icon';
2
+ import IconText from './IconText';
3
+ export default Icon;
4
+ export { iconComponentPropTypes, IconText };