@telus-uds/components-base 0.0.2-prerelease.7 → 1.0.1

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