@telus-uds/components-base 0.0.2-prerelease.6 → 1.0.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 (458) hide show
  1. package/.eslintrc.js +9 -0
  2. package/.ultra.cache.json +1 -1
  3. package/CHANGELOG.md +85 -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 +851 -57
  9. package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +1 -1
  10. package/__tests__/Button/ButtonBase.test.jsx +2 -31
  11. package/__tests__/Button/ButtonGroup.test.jsx +6 -7
  12. package/__tests__/Checkbox/Checkbox.test.jsx +94 -0
  13. package/__tests__/Checkbox/CheckboxGroup.test.jsx +246 -0
  14. package/__tests__/ExpandCollapse/ExpandCollapse.test.jsx +2 -2
  15. package/__tests__/HorizontalScroll/HorizontalScroll.test.jsx +164 -0
  16. package/__tests__/Icon/Icon.test.jsx +3 -3
  17. package/__tests__/IconButton/IconButton.test.jsx +52 -0
  18. package/__tests__/InputSupports/InputSupports.test.jsx +50 -0
  19. package/__tests__/Link/LinkBase.test.jsx +0 -14
  20. package/__tests__/List/List.test.jsx +60 -0
  21. package/__tests__/Modal/Modal.test.jsx +47 -0
  22. package/__tests__/Notification/Notification.test.jsx +20 -0
  23. package/__tests__/Pagination/Pagination.test.jsx +2 -2
  24. package/__tests__/Progress/Progress.test.jsx +79 -0
  25. package/__tests__/Radio/Radio.test.jsx +87 -0
  26. package/__tests__/Radio/RadioGroup.test.jsx +220 -0
  27. package/__tests__/RadioCard/RadioCard.test.jsx +87 -0
  28. package/__tests__/RadioCard/RadioCardGroup.test.jsx +246 -0
  29. package/__tests__/Search/Search.test.jsx +73 -0
  30. package/__tests__/Select/Select.test.jsx +94 -0
  31. package/__tests__/Skeleton/Skeleton.test.jsx +61 -0
  32. package/__tests__/StepTracker/StepTracker.test.jsx +94 -0
  33. package/__tests__/Tabs/Tabs.test.jsx +40 -0
  34. package/__tests__/Tags/Tags.test.jsx +327 -0
  35. package/__tests__/TextInput/TextArea.test.jsx +35 -0
  36. package/__tests__/TextInput/{TextInput.test.jsx → TextInputBase.test.jsx} +29 -50
  37. package/__tests__/ThemeProvider/ThemeProvider.test.jsx +77 -0
  38. package/__tests__/ThemeProvider/useThemeTokens.test.jsx +9 -5
  39. package/__tests__/ThemeProvider/utils/theme-tokens.test.js +41 -0
  40. package/__tests__/ToggleSwitch/ToggleSwitch.test.jsx +3 -2
  41. package/__tests__/utils/children.test.jsx +128 -0
  42. package/__tests__/utils/input.test.js +59 -1
  43. package/__tests__/utils/semantics.test.jsx +43 -0
  44. package/__tests__/utils/useCopy.test.js +14 -3
  45. package/babel.config.js +20 -0
  46. package/jest.config.js +8 -3
  47. package/lib/A11yInfoProvider/index.js +54 -26
  48. package/lib/A11yText/index.js +45 -17
  49. package/lib/ActivityIndicator/Spinner.js +81 -0
  50. package/lib/ActivityIndicator/Spinner.native.js +129 -91
  51. package/lib/ActivityIndicator/index.js +28 -12
  52. package/lib/ActivityIndicator/shared.js +27 -12
  53. package/lib/BaseProvider/index.js +34 -11
  54. package/lib/Box/Box.js +152 -35
  55. package/lib/Box/index.js +13 -2
  56. package/lib/Button/Button.js +41 -12
  57. package/lib/Button/ButtonBase.js +125 -97
  58. package/lib/Button/ButtonGroup.js +112 -89
  59. package/lib/Button/ButtonLink.js +48 -17
  60. package/lib/Button/index.js +31 -4
  61. package/lib/Button/propTypes.js +32 -9
  62. package/lib/Card/Card.js +38 -41
  63. package/lib/Card/CardBase.js +85 -0
  64. package/lib/Card/PressableCardBase.js +141 -0
  65. package/lib/Card/index.js +40 -2
  66. package/lib/Checkbox/Checkbox.js +355 -0
  67. package/lib/Checkbox/CheckboxGroup.js +241 -0
  68. package/lib/Checkbox/CheckboxInput.js +74 -0
  69. package/lib/Checkbox/CheckboxInput.native.js +14 -0
  70. package/lib/Checkbox/index.js +21 -0
  71. package/lib/Divider/Divider.js +59 -28
  72. package/lib/Divider/index.js +13 -2
  73. package/lib/ExpandCollapse/Accordion.js +26 -7
  74. package/lib/ExpandCollapse/Control.js +60 -31
  75. package/lib/ExpandCollapse/ExpandCollapse.js +50 -28
  76. package/lib/ExpandCollapse/Panel.js +83 -44
  77. package/lib/ExpandCollapse/index.js +25 -7
  78. package/lib/Feedback/Feedback.js +90 -39
  79. package/lib/Feedback/index.js +13 -2
  80. package/lib/Fieldset/Fieldset.js +165 -0
  81. package/lib/Fieldset/FieldsetContainer.js +46 -0
  82. package/lib/Fieldset/FieldsetContainer.native.js +38 -0
  83. package/lib/Fieldset/Legend.js +38 -0
  84. package/lib/Fieldset/Legend.native.js +48 -0
  85. package/lib/Fieldset/cssReset.js +21 -0
  86. package/lib/Fieldset/index.js +13 -0
  87. package/lib/FlexGrid/Col/Col.js +73 -41
  88. package/lib/FlexGrid/Col/index.js +13 -2
  89. package/lib/FlexGrid/FlexGrid.js +99 -49
  90. package/lib/FlexGrid/Row/Row.js +58 -30
  91. package/lib/FlexGrid/Row/index.js +13 -2
  92. package/lib/FlexGrid/helpers/index.js +9 -1
  93. package/lib/FlexGrid/index.js +13 -2
  94. package/lib/FlexGrid/providers/GutterContext.js +15 -3
  95. package/lib/HorizontalScroll/HorizontalScroll.js +200 -0
  96. package/lib/HorizontalScroll/HorizontalScrollButton.js +127 -0
  97. package/lib/HorizontalScroll/ScrollViewEnd.js +66 -0
  98. package/lib/HorizontalScroll/ScrollViewEnd.native.js +41 -0
  99. package/lib/HorizontalScroll/dictionary.js +18 -0
  100. package/lib/HorizontalScroll/index.js +35 -0
  101. package/lib/HorizontalScroll/itemPositions.js +128 -0
  102. package/lib/Icon/Icon.js +62 -50
  103. package/lib/Icon/IconText.js +101 -0
  104. package/lib/Icon/index.js +31 -3
  105. package/lib/IconButton/IconButton.js +140 -0
  106. package/lib/IconButton/index.js +13 -0
  107. package/lib/InputLabel/InputLabel.js +102 -40
  108. package/lib/InputLabel/LabelContent.js +41 -0
  109. package/lib/InputLabel/LabelContent.native.js +32 -6
  110. package/lib/InputLabel/index.js +13 -2
  111. package/lib/InputSupports/InputSupports.js +109 -0
  112. package/lib/InputSupports/index.js +13 -0
  113. package/lib/InputSupports/propTypes.js +66 -0
  114. package/lib/InputSupports/useInputSupports.js +41 -0
  115. package/lib/Link/ChevronLink.js +58 -31
  116. package/lib/Link/InlinePressable.js +56 -0
  117. package/lib/Link/InlinePressable.native.js +102 -0
  118. package/lib/Link/Link.js +39 -15
  119. package/lib/Link/LinkBase.js +126 -150
  120. package/lib/Link/TextButton.js +53 -18
  121. package/lib/Link/index.js +39 -4
  122. package/lib/List/List.js +81 -0
  123. package/lib/List/ListItem.js +245 -0
  124. package/lib/List/index.js +13 -0
  125. package/lib/Modal/Modal.js +231 -0
  126. package/lib/Modal/dictionary.js +16 -0
  127. package/lib/Modal/index.js +13 -0
  128. package/lib/Notification/Notification.js +216 -0
  129. package/lib/Notification/dictionary.js +15 -0
  130. package/lib/Notification/index.js +13 -0
  131. package/lib/Pagination/PageButton.js +58 -48
  132. package/lib/Pagination/Pagination.js +78 -43
  133. package/lib/Pagination/SideButton.js +79 -58
  134. package/lib/Pagination/dictionary.js +9 -2
  135. package/lib/Pagination/index.js +13 -2
  136. package/lib/Pagination/usePagination.js +12 -2
  137. package/lib/Progress/Progress.js +104 -0
  138. package/lib/Progress/ProgressBar.js +157 -0
  139. package/lib/Progress/ProgressBarBackground.js +61 -0
  140. package/lib/Progress/index.js +16 -0
  141. package/lib/Radio/Radio.js +293 -0
  142. package/lib/Radio/RadioButton.js +152 -0
  143. package/lib/Radio/RadioGroup.js +244 -0
  144. package/lib/Radio/RadioInput.js +76 -0
  145. package/lib/Radio/RadioInput.native.js +14 -0
  146. package/lib/Radio/index.js +21 -0
  147. package/lib/RadioCard/RadioCard.js +244 -0
  148. package/lib/RadioCard/RadioCardGroup.js +252 -0
  149. package/lib/RadioCard/index.js +21 -0
  150. package/lib/Search/Search.js +254 -0
  151. package/lib/Search/dictionary.js +19 -0
  152. package/lib/Search/index.js +13 -0
  153. package/lib/Select/Group.js +33 -0
  154. package/lib/Select/Group.native.js +25 -0
  155. package/lib/Select/Item.js +29 -0
  156. package/lib/Select/Item.native.js +19 -0
  157. package/lib/Select/Picker.js +84 -0
  158. package/lib/Select/Picker.native.js +130 -0
  159. package/lib/Select/Select.js +342 -0
  160. package/lib/Select/index.js +19 -0
  161. package/lib/SideNav/Item.js +63 -37
  162. package/lib/SideNav/ItemContent.js +41 -15
  163. package/lib/SideNav/ItemsGroup.js +55 -31
  164. package/lib/SideNav/SideNav.js +100 -73
  165. package/lib/SideNav/index.js +15 -1
  166. package/lib/Skeleton/Skeleton.js +137 -0
  167. package/lib/Skeleton/index.js +13 -0
  168. package/lib/Skeleton/skeleton.constant.js +12 -0
  169. package/lib/Skeleton/skeletonWebAnimation.js +27 -0
  170. package/lib/Skeleton/useSkeletonNativeAnimation.js +37 -0
  171. package/lib/Spacer/Spacer.js +49 -18
  172. package/lib/Spacer/index.js +13 -2
  173. package/lib/StackView/StackView.js +71 -31
  174. package/lib/StackView/StackWrap.js +43 -13
  175. package/lib/StackView/StackWrap.native.js +13 -2
  176. package/lib/StackView/StackWrapBox.js +76 -29
  177. package/lib/StackView/StackWrapGap.js +56 -26
  178. package/lib/StackView/common.js +23 -6
  179. package/lib/StackView/getStackedContent.js +47 -17
  180. package/lib/StackView/index.js +29 -5
  181. package/lib/StepTracker/Step.js +245 -0
  182. package/lib/StepTracker/StepTracker.js +202 -0
  183. package/lib/StepTracker/dictionary.js +17 -0
  184. package/lib/StepTracker/index.js +13 -0
  185. package/lib/Tabs/Tabs.js +124 -0
  186. package/lib/Tabs/TabsItem.js +238 -0
  187. package/lib/Tabs/index.js +13 -0
  188. package/lib/Tags/Tags.js +266 -0
  189. package/lib/Tags/index.js +13 -0
  190. package/lib/TextInput/TextArea.js +111 -0
  191. package/lib/TextInput/TextInput.js +50 -304
  192. package/lib/TextInput/TextInputBase.js +256 -0
  193. package/lib/TextInput/index.js +23 -2
  194. package/lib/TextInput/propTypes.js +42 -0
  195. package/lib/ThemeProvider/ThemeProvider.js +46 -18
  196. package/lib/ThemeProvider/index.js +61 -6
  197. package/lib/ThemeProvider/useSetTheme.js +19 -5
  198. package/lib/ThemeProvider/useTheme.js +13 -4
  199. package/lib/ThemeProvider/useThemeTokens.js +86 -19
  200. package/lib/ThemeProvider/utils/index.js +31 -2
  201. package/lib/ThemeProvider/utils/styles.js +50 -14
  202. package/lib/ThemeProvider/utils/theme-tokens.js +121 -12
  203. package/lib/ToggleSwitch/ToggleSwitch.js +86 -57
  204. package/lib/ToggleSwitch/index.js +13 -2
  205. package/lib/Tooltip/{Backdrop.web.js → Backdrop.js} +20 -8
  206. package/lib/Tooltip/Backdrop.native.js +39 -15
  207. package/lib/Tooltip/Tooltip.js +117 -74
  208. package/lib/Tooltip/dictionary.js +9 -2
  209. package/lib/Tooltip/getTooltipPosition.js +9 -1
  210. package/lib/Tooltip/index.js +13 -2
  211. package/lib/TooltipButton/TooltipButton.js +57 -38
  212. package/lib/TooltipButton/index.js +13 -2
  213. package/lib/Typography/Typography.js +86 -55
  214. package/lib/Typography/index.js +13 -2
  215. package/lib/ViewportProvider/ViewportProvider.js +34 -13
  216. package/lib/ViewportProvider/index.js +28 -3
  217. package/lib/ViewportProvider/useViewport.js +15 -3
  218. package/lib/ViewportProvider/useViewportListener.js +24 -10
  219. package/lib/index.js +539 -26
  220. package/lib/utils/a11y/index.js +31 -0
  221. package/lib/utils/a11y/semantics.js +173 -0
  222. package/lib/utils/a11y/textSize.js +49 -0
  223. package/lib/utils/animation/index.js +15 -2
  224. package/lib/utils/animation/useVerticalExpandAnimation.js +27 -10
  225. package/lib/utils/children.js +134 -0
  226. package/lib/utils/index.js +163 -7
  227. package/lib/utils/info/index.js +19 -0
  228. package/lib/utils/info/platform/index.js +23 -0
  229. package/lib/utils/info/platform/platform.android.js +8 -0
  230. package/lib/utils/info/platform/platform.ios.js +8 -0
  231. package/lib/utils/info/platform/platform.js +8 -0
  232. package/lib/utils/info/platform/platform.native.js +11 -0
  233. package/lib/utils/info/versions.js +16 -0
  234. package/lib/utils/input.js +53 -25
  235. package/lib/utils/pressability.js +120 -0
  236. package/lib/utils/propTypes.js +338 -132
  237. package/lib/utils/useCopy.js +40 -5
  238. package/lib/utils/useHash.js +52 -0
  239. package/lib/utils/useHash.native.js +15 -0
  240. package/lib/utils/useResponsiveProp.js +21 -9
  241. package/lib/utils/useSpacingScale.js +19 -9
  242. package/lib/utils/useUniqueId.js +12 -3
  243. package/package.json +16 -10
  244. package/release-context.json +4 -4
  245. package/src/A11yText/index.jsx +6 -4
  246. package/src/ActivityIndicator/{Spinner.web.jsx → Spinner.jsx} +5 -3
  247. package/src/ActivityIndicator/Spinner.native.jsx +5 -3
  248. package/src/Box/Box.jsx +131 -39
  249. package/src/Button/Button.jsx +13 -6
  250. package/src/Button/ButtonBase.jsx +134 -125
  251. package/src/Button/ButtonGroup.jsx +85 -86
  252. package/src/Button/ButtonLink.jsx +22 -7
  253. package/src/Button/propTypes.js +12 -2
  254. package/src/Card/Card.jsx +5 -31
  255. package/src/Card/CardBase.jsx +58 -0
  256. package/src/Card/PressableCardBase.jsx +119 -0
  257. package/src/Card/index.js +3 -0
  258. package/src/Checkbox/Checkbox.jsx +284 -0
  259. package/src/Checkbox/CheckboxGroup.jsx +206 -0
  260. package/src/Checkbox/CheckboxInput.jsx +55 -0
  261. package/src/Checkbox/CheckboxInput.native.jsx +6 -0
  262. package/src/Checkbox/index.js +5 -0
  263. package/src/Divider/Divider.jsx +7 -4
  264. package/src/ExpandCollapse/Accordion.jsx +3 -2
  265. package/src/ExpandCollapse/Control.jsx +40 -43
  266. package/src/ExpandCollapse/ExpandCollapse.jsx +26 -23
  267. package/src/ExpandCollapse/Panel.jsx +69 -63
  268. package/src/Feedback/Feedback.jsx +42 -30
  269. package/src/Fieldset/Fieldset.jsx +136 -0
  270. package/src/Fieldset/FieldsetContainer.jsx +31 -0
  271. package/src/Fieldset/FieldsetContainer.native.jsx +19 -0
  272. package/src/Fieldset/Legend.jsx +21 -0
  273. package/src/Fieldset/Legend.native.jsx +27 -0
  274. package/src/Fieldset/cssReset.js +14 -0
  275. package/src/Fieldset/index.js +3 -0
  276. package/src/FlexGrid/Col/Col.jsx +139 -132
  277. package/src/FlexGrid/FlexGrid.jsx +79 -51
  278. package/src/FlexGrid/Row/Row.jsx +55 -48
  279. package/src/HorizontalScroll/HorizontalScroll.jsx +168 -0
  280. package/src/HorizontalScroll/HorizontalScrollButton.jsx +105 -0
  281. package/src/HorizontalScroll/ScrollViewEnd.jsx +53 -0
  282. package/src/HorizontalScroll/ScrollViewEnd.native.jsx +24 -0
  283. package/src/HorizontalScroll/dictionary.js +11 -0
  284. package/src/HorizontalScroll/index.js +17 -0
  285. package/src/HorizontalScroll/itemPositions.js +101 -0
  286. package/src/Icon/Icon.jsx +46 -49
  287. package/src/Icon/IconText.jsx +68 -0
  288. package/src/Icon/index.js +3 -2
  289. package/src/IconButton/IconButton.jsx +114 -0
  290. package/src/IconButton/index.js +3 -0
  291. package/src/InputLabel/InputLabel.jsx +57 -35
  292. package/src/InputLabel/LabelContent.jsx +21 -0
  293. package/src/InputLabel/LabelContent.native.jsx +11 -2
  294. package/src/InputSupports/InputSupports.jsx +70 -0
  295. package/src/InputSupports/index.js +3 -0
  296. package/src/InputSupports/propTypes.js +44 -0
  297. package/src/InputSupports/useInputSupports.js +30 -0
  298. package/src/Link/ChevronLink.jsx +34 -21
  299. package/src/Link/InlinePressable.jsx +39 -0
  300. package/src/Link/InlinePressable.native.jsx +75 -0
  301. package/src/Link/Link.jsx +23 -13
  302. package/src/Link/LinkBase.jsx +98 -170
  303. package/src/Link/TextButton.jsx +37 -16
  304. package/src/Link/index.js +2 -1
  305. package/src/List/List.jsx +48 -0
  306. package/src/List/ListItem.jsx +182 -0
  307. package/src/List/index.js +3 -0
  308. package/src/Modal/Modal.jsx +190 -0
  309. package/src/Modal/dictionary.js +9 -0
  310. package/src/Modal/index.js +3 -0
  311. package/src/Notification/Notification.jsx +164 -0
  312. package/src/Notification/dictionary.js +8 -0
  313. package/src/Notification/index.js +3 -0
  314. package/src/Pagination/PageButton.jsx +42 -49
  315. package/src/Pagination/Pagination.jsx +88 -92
  316. package/src/Pagination/SideButton.jsx +58 -66
  317. package/src/Progress/Progress.jsx +78 -0
  318. package/src/Progress/ProgressBar.jsx +123 -0
  319. package/src/Progress/ProgressBarBackground.jsx +36 -0
  320. package/src/Progress/index.js +6 -0
  321. package/src/Radio/Radio.jsx +240 -0
  322. package/src/Radio/RadioButton.jsx +142 -0
  323. package/src/Radio/RadioGroup.jsx +209 -0
  324. package/src/Radio/RadioInput.jsx +57 -0
  325. package/src/Radio/RadioInput.native.jsx +6 -0
  326. package/src/Radio/index.js +5 -0
  327. package/src/RadioCard/RadioCard.jsx +198 -0
  328. package/src/RadioCard/RadioCardGroup.jsx +218 -0
  329. package/src/RadioCard/index.js +5 -0
  330. package/src/Search/Search.jsx +225 -0
  331. package/src/Search/dictionary.js +12 -0
  332. package/src/Search/index.js +3 -0
  333. package/src/Select/Group.jsx +15 -0
  334. package/src/Select/Group.native.jsx +14 -0
  335. package/src/Select/Item.jsx +11 -0
  336. package/src/Select/Item.native.jsx +10 -0
  337. package/src/Select/Picker.jsx +74 -0
  338. package/src/Select/Picker.native.jsx +102 -0
  339. package/src/Select/Select.jsx +298 -0
  340. package/src/Select/index.js +8 -0
  341. package/src/SideNav/Item.jsx +54 -47
  342. package/src/SideNav/ItemsGroup.jsx +50 -43
  343. package/src/SideNav/SideNav.jsx +68 -60
  344. package/src/Skeleton/Skeleton.jsx +94 -0
  345. package/src/Skeleton/index.js +3 -0
  346. package/src/Skeleton/skeleton.constant.js +3 -0
  347. package/src/Skeleton/skeletonWebAnimation.js +13 -0
  348. package/src/Skeleton/useSkeletonNativeAnimation.js +27 -0
  349. package/src/Spacer/Spacer.jsx +11 -4
  350. package/src/StackView/StackView.jsx +53 -23
  351. package/src/StackView/StackWrap.jsx +16 -7
  352. package/src/StackView/StackWrapBox.jsx +62 -28
  353. package/src/StackView/StackWrapGap.jsx +46 -24
  354. package/src/StackView/common.jsx +3 -2
  355. package/src/StackView/getStackedContent.jsx +8 -2
  356. package/src/StepTracker/Step.jsx +202 -0
  357. package/src/StepTracker/StepTracker.jsx +174 -0
  358. package/src/StepTracker/dictionary.js +10 -0
  359. package/src/StepTracker/index.js +3 -0
  360. package/src/Tabs/Tabs.jsx +97 -0
  361. package/src/Tabs/TabsItem.jsx +212 -0
  362. package/src/Tabs/index.js +3 -0
  363. package/src/Tags/Tags.jsx +219 -0
  364. package/src/Tags/index.js +3 -0
  365. package/src/TextInput/TextArea.jsx +79 -0
  366. package/src/TextInput/TextInput.jsx +18 -284
  367. package/src/TextInput/TextInputBase.jsx +217 -0
  368. package/src/TextInput/index.js +2 -1
  369. package/src/TextInput/propTypes.js +29 -0
  370. package/src/ThemeProvider/ThemeProvider.jsx +11 -7
  371. package/src/ThemeProvider/useSetTheme.js +4 -0
  372. package/src/ThemeProvider/useThemeTokens.js +56 -5
  373. package/src/ThemeProvider/utils/styles.js +18 -5
  374. package/src/ThemeProvider/utils/theme-tokens.js +74 -5
  375. package/src/ToggleSwitch/ToggleSwitch.jsx +51 -53
  376. package/src/Tooltip/{Backdrop.web.jsx → Backdrop.jsx} +0 -0
  377. package/src/Tooltip/Tooltip.jsx +135 -131
  378. package/src/TooltipButton/TooltipButton.jsx +23 -27
  379. package/src/Typography/Typography.jsx +72 -59
  380. package/src/index.js +31 -3
  381. package/src/utils/a11y/index.js +2 -0
  382. package/src/utils/a11y/semantics.js +162 -0
  383. package/src/utils/a11y/textSize.js +30 -0
  384. package/src/utils/children.jsx +119 -0
  385. package/src/utils/index.js +6 -0
  386. package/src/utils/info/index.js +8 -0
  387. package/src/utils/info/platform/index.js +11 -0
  388. package/src/utils/info/platform/platform.android.js +1 -0
  389. package/src/utils/info/platform/platform.ios.js +1 -0
  390. package/src/utils/info/platform/platform.js +1 -0
  391. package/src/utils/info/platform/platform.native.js +4 -0
  392. package/src/utils/info/versions.js +6 -0
  393. package/src/utils/input.js +36 -25
  394. package/src/utils/pressability.js +96 -0
  395. package/src/utils/propTypes.js +291 -90
  396. package/src/utils/useCopy.js +30 -4
  397. package/src/utils/useHash.js +39 -0
  398. package/src/utils/useHash.native.js +6 -0
  399. package/stories/A11yText/A11yText.stories.jsx +6 -10
  400. package/stories/ActivityIndicator/ActivityIndicator.stories.jsx +1 -1
  401. package/stories/Box/Box.stories.jsx +1 -1
  402. package/stories/Button/Button.stories.jsx +7 -2
  403. package/stories/Button/ButtonGroup.stories.jsx +1 -1
  404. package/stories/Button/ButtonLink.stories.jsx +1 -1
  405. package/stories/Card/Card.stories.jsx +1 -1
  406. package/stories/Checkbox/Checkbox.stories.jsx +94 -0
  407. package/stories/Divider/Divider.stories.jsx +1 -1
  408. package/stories/ExpandCollapse/ExpandCollapse.stories.jsx +2 -2
  409. package/stories/Feedback/Feedback.stories.jsx +5 -6
  410. package/stories/FlexGrid/01 FlexGrid.stories.jsx +1 -1
  411. package/stories/FlexGrid/02 Row.stories.jsx +1 -1
  412. package/stories/FlexGrid/03 Col.stories.jsx +1 -1
  413. package/stories/Icon/Icon.stories.jsx +27 -7
  414. package/stories/IconButton/IconButton.stories.jsx +50 -0
  415. package/stories/InputLabel/InputLabel.stories.jsx +1 -1
  416. package/stories/Link/ChevronLink.stories.jsx +1 -1
  417. package/stories/Link/Link.stories.jsx +28 -18
  418. package/stories/Link/TextButton.stories.jsx +1 -1
  419. package/stories/List/List.stories.jsx +117 -0
  420. package/stories/Modal/Modal.stories.jsx +29 -0
  421. package/stories/Notification/Notification.stories.jsx +82 -0
  422. package/stories/Pagination/Pagination.stories.jsx +1 -1
  423. package/stories/Progress/Progress.stories.jsx +93 -0
  424. package/stories/Radio/Radio.stories.jsx +100 -0
  425. package/stories/RadioCard/RadioCard.stories.jsx +98 -0
  426. package/stories/Search/Search.stories.jsx +16 -0
  427. package/stories/Select/Select.stories.jsx +55 -0
  428. package/stories/SideNav/SideNav.stories.jsx +1 -1
  429. package/stories/SideNav/SideNavItem.stories.jsx +1 -1
  430. package/stories/SideNav/SideNavItemsGroup.stories.jsx +1 -1
  431. package/stories/Skeleton/Skeleton.stories.jsx +36 -0
  432. package/stories/Spacer/Spacer.stories.jsx +1 -1
  433. package/stories/StackView/StackView.stories.jsx +1 -1
  434. package/stories/StackView/StackWrap.stories.jsx +1 -1
  435. package/stories/StepTracker/StepTracker.stories.jsx +71 -0
  436. package/stories/Tabs/Tabs.stories.jsx +97 -0
  437. package/stories/Tags/Tags.stories.jsx +69 -0
  438. package/stories/TextInput/TextArea.stories.jsx +100 -0
  439. package/stories/TextInput/TextInput.stories.jsx +1 -1
  440. package/stories/ToggleSwitch/ToggleSwitch.stories.jsx +1 -1
  441. package/stories/Tooltip/Tooltip.stories.jsx +1 -1
  442. package/stories/TooltipButton/TooltipButton.stories.jsx +1 -1
  443. package/stories/Typography/Typography.stories.jsx +1 -1
  444. package/stories/{platform-supports.web.jsx → platform-supports.jsx} +1 -1
  445. package/stories/supports.jsx +38 -4
  446. package/__fixtures__/accessible.icon.svg +0 -6
  447. package/babel.config.json +0 -8
  448. package/docs/Contributing.stories.mdx +0 -9
  449. package/docs/Fonts.stories.mdx +0 -104
  450. package/docs/Icons.stories.mdx +0 -144
  451. package/docs/Introduction.stories.mdx +0 -9
  452. package/lib/ActivityIndicator/Spinner.web.js +0 -55
  453. package/lib/InputLabel/LabelContent.web.js +0 -17
  454. package/lib/config/svgr-icons-web.js +0 -9
  455. package/lib/config/svgr-icons.js +0 -52
  456. package/src/InputLabel/LabelContent.web.jsx +0 -13
  457. package/src/config/svgr-icons-web.js +0 -11
  458. package/src/config/svgr-icons.js +0 -46
@@ -1,6 +1,24 @@
1
1
  import PropTypes from 'prop-types'
2
2
  import { Linking, Platform } from 'react-native'
3
- import { tokenKeys } from '@telus-uds/tools-theme'
3
+ import { components as tokenKeys } from '@telus-uds/system-theme-tokens'
4
+
5
+ export const paddingProp = {
6
+ propType: PropTypes.shape({
7
+ paddingBottom: PropTypes.number,
8
+ paddingLeft: PropTypes.number,
9
+ paddingRight: PropTypes.number,
10
+ paddingTop: PropTypes.number
11
+ })
12
+ }
13
+
14
+ export const rectProp = {
15
+ propType: PropTypes.shape({
16
+ bottom: PropTypes.number,
17
+ left: PropTypes.number,
18
+ right: PropTypes.number,
19
+ top: PropTypes.number
20
+ })
21
+ }
4
22
 
5
23
  /**
6
24
  * @typedef {{[key: string]: string|number|boolean}} AppearanceSet
@@ -21,29 +39,61 @@ export const variantProp = {
21
39
  )
22
40
  }
23
41
 
24
- // Tokens can be primitive values (e.g. `'rgba(0,0,0,0'`, `12`), or objects of such values
25
- // such as tokens that describe shadow (e.g. shadow: { inset: true, color: 'rgba(...)' ... })
26
- const tokenValue = PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool])
42
+ // Tokens can be primitive values (e.g. `'rgba(0,0,0,0'`, `12`), or objects of such values,
43
+ // such as tokens that describe shadow (e.g. shadow: { inset: true, color: 'rgba(...)' ... }),
44
+ // or components (e.g. Icon tokens)
45
+ const tokenValue = PropTypes.oneOfType([
46
+ PropTypes.string,
47
+ PropTypes.number,
48
+ PropTypes.bool,
49
+ PropTypes.elementType
50
+ ])
27
51
  const tokenValueType = PropTypes.oneOfType([tokenValue, PropTypes.objectOf(tokenValue)])
28
52
 
29
- const getTokenNames = (componentName) => {
30
- const componentTokenNames = tokenKeys[componentName]
31
- if (!componentTokenNames) {
32
- throw new Error(`No "${componentName}" tokenKeys in @telus-uds/tools-theme`)
53
+ export const getTokenNames = (componentName) => {
54
+ const componentTokenSchema = tokenKeys[componentName]
55
+ if (!componentTokenSchema) {
56
+ throw new Error(`No "${componentName}" tokenKeys in @telus-uds/system-theme-tokens`)
33
57
  }
34
- return componentTokenNames
58
+ return Object.keys(componentTokenSchema)
35
59
  }
36
60
 
37
61
  /**
38
62
  * Returns the subset of a set of tokens that may be accepted by the `tokens` prop of a named component
63
+ * or by a provided array of tokens. A prefix may be provided, for example:
64
+ *
65
+ * @example
66
+ * ```jsx
67
+ * // returns tokens from `themeTokens` that exist in the theme schema for `Button`.
68
+ * selectTokens('Button', themeTokens)
69
+ * ```
70
+ *
71
+ * @example
72
+ * ```jsx
73
+ * // returns `{ backgroundColor, width }` where the values of those keys come from
74
+ * // the source object's `{ containerBackgroundColor, containerWidth }` properties.
75
+ * selectTokens(['backgroundColor', 'width'], themeTokens, 'container')
76
+ * ```
77
+ *
78
+ * @example
79
+ * ```jsx
80
+ * // returns tokens that are defined in the `Button` theme schema, from tokens with
81
+ * // a prefix `'button'` e.g. a token `buttonBorderWidth` outputs as `borderWidth`.
82
+ * selectTokens('Button', themeTokens, 'button')
83
+ * ```
84
+ *
85
+ * @param {string[]|string} specifier - a name of a component in the theme schema, or an array of token names
86
+ * @param {object} tokens - a source object of theme tokens
87
+ * @param {string} [prefix] - if provided, matches keys in the source object with this as the first camelCase item
88
+ * @returns {object} - subset of theme tokens
39
89
  */
40
- export const selectTokens = (componentName, tokens) => {
41
- const tokenNames = getTokenNames(componentName)
42
- const filteredTokens = Object.entries(tokens).reduce(
43
- (validTokens, [key, value]) =>
44
- tokenNames.includes(key) ? { ...validTokens, [key]: value } : validTokens,
45
- {}
46
- )
90
+ export const selectTokens = (specifier, tokens, prefix) => {
91
+ const tokenNames = typeof specifier === 'string' ? getTokenNames(specifier) : specifier
92
+ const filteredTokens = tokenNames.reduce((validTokens, key) => {
93
+ const prefixedKey = prefix ? `${prefix}${key[0].toUpperCase()}${key.slice(1)}` : key
94
+ const token = tokens[prefixedKey]
95
+ return token !== undefined ? { ...validTokens, [key]: token } : validTokens
96
+ }, {})
47
97
  return filteredTokens
48
98
  }
49
99
 
@@ -59,14 +109,83 @@ export const selectTokens = (componentName, tokens) => {
59
109
  *
60
110
  * This prop is intended to be used as an 'escape hatch' for difficult or exceptional cases
61
111
  * where the main theming system doesn't apply. It is intentionally permissive about values.
112
+ *
113
+ * @param {...string} componentsNames - one or more ComponentName, which tokens keys are accepted
114
+ * @return {function} - a custom PropTypes validator
115
+ *
116
+ * @example
117
+ * Component.propTypes = {
118
+ * // accepts all tokens keys defined in Component schema
119
+ * tokens: getTokensPropType('Component')
120
+ * }
121
+ *
122
+ * Component.propTypes = {
123
+ * // accepts all tokens keys defined in schemas for Component1 and Component2
124
+ * tokens: getTokensPropType('Component1', 'Component2')
125
+ * }
126
+ */
127
+ export const getTokensPropType = (...componentsNames) => (props, propName, componentName) => {
128
+ PropTypes.checkPropTypes(
129
+ {
130
+ [propName]: PropTypes.oneOfType([PropTypes.object, PropTypes.func])
131
+ },
132
+ props,
133
+ propName,
134
+ componentName
135
+ )
136
+
137
+ if (typeof props[propName] !== 'function') {
138
+ PropTypes.checkPropTypes(
139
+ {
140
+ [propName]: PropTypes.exact(
141
+ Object.fromEntries(
142
+ componentsNames.flatMap((component) =>
143
+ getTokenNames(component).map((key) => [key, tokenValueType])
144
+ )
145
+ )
146
+ )
147
+ },
148
+ props,
149
+ propName,
150
+ componentName
151
+ )
152
+ }
153
+ }
154
+
155
+ /**
156
+ * Get a proptypes validator for a set of tokens that is not based on a component in the theme schema.
157
+ *
158
+ * For example, for a set of tokens used in a common style, or for a set of tokens required by
159
+ * a themeless component whose tokens are set by a parent but requires tokens of a certain shape.
160
+ *
161
+ * By default, requires an object with a complete set of tokens (allowing `null`, but not `undefined`).
162
+ *
163
+ * @param {string[]} componentTokenKeys - array of strings of token names
164
+ * @param {object} [options]
165
+ * @param {boolean} [options.partial] - if true, allows tokens to be undefined
166
+ * @param {boolean} [options.allowFunction] - if true, allows functions as well as tokens objects
167
+ * @returns
62
168
  */
63
- export const getTokensPropType = (componentName) =>
64
- PropTypes.oneOfType([
65
- PropTypes.shape(
66
- Object.fromEntries(getTokenNames(componentName).map((key) => [key, tokenValueType]))
67
- ),
68
- PropTypes.func // function that takes current appearances and returns above shape
69
- ])
169
+ export const getTokensSetPropType = (
170
+ componentTokenKeys,
171
+ { partial = false, allowFunction = false } = {}
172
+ ) => {
173
+ const tokensObjectValidator = PropTypes.exact(
174
+ Object.fromEntries(
175
+ componentTokenKeys.map((key) => [
176
+ key,
177
+ partial
178
+ ? tokenValueType
179
+ : // Some theme tokens can validly resolve to `null`, but .isRequired treats null as undefined
180
+ (props, propName, ...args) =>
181
+ props[propName] !== null && tokenValueType.isRequired(props, propName, ...args)
182
+ ])
183
+ )
184
+ )
185
+ return allowFunction
186
+ ? PropTypes.oneOfType([tokensObjectValidator, PropTypes.func])
187
+ : tokensObjectValidator
188
+ }
70
189
 
71
190
  function getPropSelector(propTypes, regexp) {
72
191
  const keys = Object.keys(propTypes)
@@ -86,7 +205,6 @@ function getPropSelector(propTypes, regexp) {
86
205
  // React Native exports a11y prop definitions as TypeScript Interfaces, but no longer exports PropTypes
87
206
  // so we have to define them ourselves.
88
207
  const a11yPropTypes = {
89
- // react-native-web >= 0.15.0 ignores `accessible` and looks for `focusable`
90
208
  accessible: PropTypes.bool,
91
209
  focusable: PropTypes.bool,
92
210
 
@@ -119,7 +237,79 @@ const a11yPropTypes = {
119
237
  importantForAccessibility: PropTypes.oneOf(['auto', 'yes', 'no', 'no-hide-descendants']),
120
238
  onAccessibilityAction: PropTypes.func,
121
239
  onAccessibilityEscape: PropTypes.func,
122
- onAccessibilityTap: PropTypes.func
240
+ onAccessibilityTap: PropTypes.func,
241
+ ...Platform.select({
242
+ web: {
243
+ // React Native Web adds many a11y props that alias aria-* attributes
244
+ // Types based on https://necolas.github.io/react-native-web/docs/accessibility/
245
+ accessibilityActiveDescendant: PropTypes.string,
246
+ accessibilityAtomic: PropTypes.bool,
247
+ accessibilityAutoComplete: PropTypes.string,
248
+ accessibilityBusy: PropTypes.bool,
249
+ accessibilityChecked: PropTypes.oneOf([true, false, 'mixed']),
250
+ accessibilityColumnCount: PropTypes.number,
251
+ accessibilityColumnIndex: PropTypes.number,
252
+ accessibilityColumnSpan: PropTypes.number,
253
+ accessibilityControls: PropTypes.oneOfType([
254
+ PropTypes.string,
255
+ PropTypes.arrayOf(PropTypes.string)
256
+ ]),
257
+ accessibilityCurrent: PropTypes.oneOf([
258
+ true,
259
+ false,
260
+ 'page',
261
+ 'step',
262
+ 'location',
263
+ 'date',
264
+ 'time'
265
+ ]),
266
+ accessibilityDescribedBy: PropTypes.oneOfType([
267
+ PropTypes.string,
268
+ PropTypes.arrayOf(PropTypes.string)
269
+ ]),
270
+ accessibilityDetails: PropTypes.string,
271
+ accessibilityDisabled: PropTypes.bool,
272
+ accessibilityErrorMessage: PropTypes.string,
273
+ accessibilityExpanded: PropTypes.bool,
274
+ accessibilityFlowTo: PropTypes.oneOfType([
275
+ PropTypes.string,
276
+ PropTypes.arrayOf(PropTypes.string)
277
+ ]),
278
+ accessibilityHasPopup: PropTypes.string,
279
+ accessibilityHidden: PropTypes.bool,
280
+ accessibilityInvalid: PropTypes.bool,
281
+ accessibilityKeyShortcuts: PropTypes.string,
282
+ accessibilityLabelledBy: PropTypes.oneOfType([
283
+ PropTypes.string,
284
+ PropTypes.arrayOf(PropTypes.string)
285
+ ]),
286
+ accessibilityLevel: PropTypes.number,
287
+ accessibilityModal: PropTypes.bool,
288
+ accessibilityMultiline: PropTypes.bool,
289
+ accessibilityMultiSelectable: PropTypes.bool,
290
+ accessibilityOrientation: PropTypes.oneOf(['horizontal', 'vertical']),
291
+ accessibilityOwns: PropTypes.oneOfType([
292
+ PropTypes.string,
293
+ PropTypes.arrayOf(PropTypes.string)
294
+ ]),
295
+ accessibilityPlaceholder: PropTypes.string,
296
+ accessibilityPosInSet: PropTypes.number,
297
+ accessibilityPressed: PropTypes.bool,
298
+ accessibilityReadOnly: PropTypes.bool,
299
+ accessibilityRequired: PropTypes.bool,
300
+ accessibilityRoleDescription: PropTypes.string,
301
+ accessibilityRowCount: PropTypes.number,
302
+ accessibilityRowIndex: PropTypes.number,
303
+ accessibilityRowSpan: PropTypes.number,
304
+ accessibilitySelected: PropTypes.bool,
305
+ accessibilitySetSize: PropTypes.number,
306
+ accessibilitySort: PropTypes.oneOf(['ascending', 'descending', 'none', 'other']),
307
+ accessibilityValueMax: PropTypes.number,
308
+ accessibilityValueMin: PropTypes.number,
309
+ accessibilityValueNow: PropTypes.number,
310
+ accessibilityValueText: PropTypes.string
311
+ }
312
+ })
123
313
  }
124
314
 
125
315
  export const a11yProps = {
@@ -139,10 +329,9 @@ export const a11yProps = {
139
329
  * Use this to disable focus for elements which are visually hidden but still rendered.
140
330
  */
141
331
  nonFocusableProps: {
142
- focusable: false, // for android, and for keyboard nav in web (RNW >= 0.15.x)
332
+ focusable: false, // for android, and for keyboard nav in web
143
333
  ...Platform.select({
144
334
  web: {
145
- accessible: false, // workaround for web keyboard nav in RNW < 0.15.x
146
335
  accessibilityHidden: true // web screenreaders
147
336
  },
148
337
  android: {
@@ -152,7 +341,27 @@ export const a11yProps = {
152
341
  accessibilityElementsHidden: true
153
342
  }
154
343
  })
155
- }
344
+ },
345
+ /**
346
+ * Generates an object of platform-appropriate a11y props describing an item that has an
347
+ * ordered position in a set. Examples of usage by accessibility tools includes screenreaders
348
+ * saying "Item X of Y" when this item is select.
349
+ *
350
+ * @param {number} itemsCount - the number of items in the set
351
+ * @param {number} index - the current item's index in the set
352
+ * @returns {object} - platform-applicable a11y props describing this position (if available)
353
+ */
354
+ getPositionInSet: (itemsCount, index) =>
355
+ Platform.select({
356
+ web: {
357
+ // accessibilityPosInSet etc exists in React Native Web main branch
358
+ // but not in a release compatible with Expo etc; just use `aria-*`
359
+ 'aria-setsize': itemsCount,
360
+ 'aria-posinset': index + 1
361
+ },
362
+ // No equivalents exist on the native side
363
+ default: {}
364
+ })
156
365
  }
157
366
 
158
367
  // Props related to HTML <a> anchor link attributes.
@@ -176,30 +385,10 @@ export const hrefAttrsProp = {
176
385
  target
177
386
  },
178
387
  rest
179
- }),
180
- /**
181
- * Takes a hrefAttrs object and returns an object that can be spread into Pressable props
182
- * in a way that handles compatibility before and after React Native Web 0.15.0
183
- */
184
- spread: (hrefAttrs) => ({
185
- /**
186
- * React Native Web >= 0.15.0 supports hrefAttrs prop but requires React 17
187
- * so is incompatible with Expo until July 2021
188
- */
189
- hrefAttrs,
190
- /**
191
- * React Native Web < 0.15.0 uses `target` and `rel` props.
192
- * React Native Web >= 0.15.0 ignores these and reads hrefAttrs only.
193
- */
194
- rel: hrefAttrs?.rel,
195
- target: hrefAttrs?.target
196
- /**
197
- * Don't spread hrefAttrs.download, RNW <0.15.0 doesn't support it.
198
- */
199
388
  })
200
389
  }
201
390
 
202
- const pressPropTypes = {
391
+ const pressHandlerPropTypes = {
203
392
  onPress: PropTypes.func,
204
393
  onPressIn: PropTypes.func,
205
394
  onPressOut: PropTypes.func,
@@ -210,7 +399,21 @@ const pressPropTypes = {
210
399
  onFocus: PropTypes.func,
211
400
  onBlur: PropTypes.func
212
401
  },
213
- default: {}
402
+ default: {
403
+ onLongPress: PropTypes.func
404
+ }
405
+ })
406
+ }
407
+
408
+ const pressPropTypes = {
409
+ ...pressHandlerPropTypes,
410
+ disabled: PropTypes.bool,
411
+ ...Platform.select({
412
+ web: {},
413
+ default: {
414
+ hitSlop: PropTypes.number,
415
+ pressRetentionOffset: PropTypes.oneOfType([PropTypes.number, rectProp.propType])
416
+ }
214
417
  })
215
418
  }
216
419
 
@@ -222,7 +425,8 @@ export const pressProps = {
222
425
  /**
223
426
  * Filters a props object, returning only the platform-relevant press props defined above
224
427
  */
225
- select: getPropSelector(pressPropTypes)
428
+ select: getPropSelector(pressPropTypes),
429
+ selectHandlers: getPropSelector(pressHandlerPropTypes)
226
430
  }
227
431
 
228
432
  const linkPropTypes = {
@@ -242,25 +446,46 @@ export const linkProps = {
242
446
  */
243
447
  select: getPropSelector(linkPropTypes),
244
448
  /**
245
- * Turn hrefs into press handlers on Native and throw if not given `onPress` xor `href`.
449
+ * Turn hrefs into press handlers on Native and throw if not given `onPress` or `href`.
246
450
  *
247
451
  * @param {({ onPress?: () => void, href?: string })}
248
452
  * @returns {(() => void)|undefined} Returns a press handler, or undefined on web if href
249
453
  * string is provided. Expects calling component to use href string on web (e.g. in `<a>`).
250
454
  */
251
455
  handleHref: ({ onPress, href }) => {
252
- // TODO: revisit this when integrating routing packages
253
- // https://github.com/telus/universal-design-system/issues/24
254
- if (href && onPress) {
255
- throw new Error("handleHref currently doesn't support both href and onPress")
256
- }
257
456
  if (!href && !onPress) {
258
457
  throw new Error('handleHref requires either href or onPress')
259
458
  }
260
- return Platform.OS !== 'web' && href ? () => Linking.openURL(href) : onPress
459
+ return Platform.select({
460
+ web: onPress,
461
+ default: (...args) => {
462
+ if (onPress) onPress(...args)
463
+ if (href) Linking.openURL(href)
464
+ }
465
+ })
261
466
  }
262
467
  }
263
468
 
469
+ const viewPropTypes = {
470
+ pointerEvents: PropTypes.oneOf(['all', 'none', 'box-only', 'box-none']),
471
+ onLayout: PropTypes.func,
472
+ nativeID: PropTypes.string,
473
+ testID: PropTypes.string
474
+ }
475
+
476
+ export const viewProps = {
477
+ /**
478
+ * Subset of `View` proptypes that could conceivably be needed on any component
479
+ * that renders a single View.
480
+ */
481
+ types: viewPropTypes,
482
+ /**
483
+ * Filters a props object, returning only cross-platform View props that are potentially
484
+ * relevant to any basic layout component that renders one View.
485
+ */
486
+ select: getPropSelector(viewPropTypes)
487
+ }
488
+
264
489
  const getByViewport = (propType) => ({
265
490
  xs: propType,
266
491
  sm: propType,
@@ -344,20 +569,19 @@ export const spacingProps = {
344
569
  }
345
570
 
346
571
  /**
347
- * Returns a prop type validator which checks whether a prop is either a component or an array of components of a given
348
- * type, based on their `name` property.
572
+ * Returns a prop type validator which checks whether a prop is either a component or an array of
573
+ * components of a given type, based on their `name` or `displayName` properties.
349
574
  * Use an array of strings for `passedName` to accept more than one component type.
350
575
  * For an array the validation fails on the first occurrence of an invalid element.
351
576
  *
352
577
  * @param {string|string[]} passedName
353
- * @param {boolean} [checkDisplayName] - if `true` then `displayName` property on the component will be validated instead of `name`
354
578
  * @return {function}
355
579
  */
356
- export const componentPropType = (passedName, checkDisplayName = false) => {
580
+ export const componentPropType = (passedName) => {
357
581
  const passedNames = typeof passedName === 'string' ? [passedName] : passedName
358
582
 
359
583
  const checkProp = (props, propName, componentName) => {
360
- if (typeof props[propName] === 'undefined' || props[propName] === null) {
584
+ if (props[propName] === undefined || props[propName] === null) {
361
585
  return undefined
362
586
  }
363
587
 
@@ -369,25 +593,11 @@ export const componentPropType = (passedName, checkDisplayName = false) => {
369
593
  .find(Boolean)
370
594
  }
371
595
 
372
- const testNameInObject = () =>
373
- typeof props[propName] === 'object' &&
374
- ((!checkDisplayName && !passedNames.includes(props[propName].type.name)) ||
375
- (checkDisplayName && !passedNames.includes(props[propName].type.displayName)))
376
-
377
- const testNameInFunction = () =>
378
- typeof props[propName] === 'function' &&
379
- ((!checkDisplayName && !passedNames.includes(props[propName].name)) ||
380
- (checkDisplayName && !passedNames.includes(props[propName].displayName)))
381
-
382
- if (
383
- (props[propName] &&
384
- typeof props[propName] !== 'object' &&
385
- typeof props[propName] !== 'function') ||
386
- testNameInObject() ||
387
- testNameInFunction()
388
- ) {
596
+ const nameInProp = props[propName].type?.displayName || props[propName].type?.name
597
+ if (!nameInProp || !passedNames.includes(nameInProp)) {
598
+ const propDescription = nameInProp ? `Component ${nameInProp}` : typeof props[propName]
389
599
  return new Error(
390
- `${componentName}: Component passed to \`${propName}\` prop should be ${passedNames.join(
600
+ `${componentName}: ${propDescription} was passed to \`${propName}\` prop; should be ${passedNames.join(
391
601
  ' or '
392
602
  )}`
393
603
  )
@@ -427,12 +637,3 @@ export const componentPropType = (passedName, checkDisplayName = false) => {
427
637
  }
428
638
 
429
639
  export const copyPropTypes = PropTypes.oneOf(['en', 'fr'])
430
-
431
- export const paddingProp = {
432
- propType: PropTypes.shape({
433
- paddingBottom: PropTypes.number,
434
- paddingLeft: PropTypes.number,
435
- paddingRight: PropTypes.number,
436
- paddingTop: PropTypes.number
437
- })
438
- }
@@ -1,13 +1,39 @@
1
+ export const DEFAULT_COPY = 'en'
2
+
1
3
  /**
2
4
  * Extract translations from a keyed dictionary for a given language.
3
5
  * Returns a getter.
4
6
  *
5
- * @param {object} dictionary
6
- * @param {'en'|'fr'} copy - language
7
+ * @example
8
+ * const getCopy = useCopy({
9
+ * copy: 'en',
10
+ * dictionary: {
11
+ * en: { label: 'english label' },
12
+ * fr: { label: 'french label' }
13
+ * }
14
+ * })
15
+ *
16
+ * getCopy('label') => 'english label'
17
+ *
18
+ * @description The entire dictionary may be overridden by simply passing a single language object as `copy`:
19
+ * @example
20
+ * const getCopy = useCopy({
21
+ * copy: { label: 'custom label' }
22
+ * })
23
+ *
24
+ * getCopy('label') => 'custom label'
25
+ *
26
+ * @param {object} [dictionary]
27
+ * @param {'en'|'fr'|object} copy - language
7
28
  * @return {function(string): string}
8
29
  */
9
- function useCopy({ dictionary, copy }) {
10
- return (key) => dictionary[copy][key]
30
+ function useCopy({ dictionary, copy = DEFAULT_COPY }) {
31
+ if (typeof copy === 'string') {
32
+ return (key) => (key ? dictionary[copy][key] : dictionary[copy])
33
+ }
34
+
35
+ // support overriding the entire copy dictionary with an object for a single language
36
+ return (key) => copy[key]
11
37
  }
12
38
 
13
39
  export default useCopy
@@ -0,0 +1,39 @@
1
+ import { useEffect, useState } from 'react'
2
+
3
+ const doAction = (action, event) =>
4
+ typeof action === 'function' && action(window?.location?.hash, event)
5
+
6
+ /**
7
+ * @typedef {import('react').SyntheticEvent} SyntheticEvent
8
+ */
9
+
10
+ /**
11
+ * Calls a function (passing it the current hash) based on the current hash state on mount,
12
+ * and binds it to call it again any time the hash changes.
13
+ *
14
+ * Consider using `useCallback` on the function to minimise adding and removing of event listeners.
15
+ *
16
+ * On Native, this is replaced with a harmless no-op function as there is no direct equivalent.
17
+ *
18
+ * @param {(hash: string, event?: SyntheticEvent) => void} action - a function to act on the current hash on load and when it changes
19
+ * @returns
20
+ */
21
+ const useHash = (action, isReady = true) => {
22
+ const [isDone, setIsDone] = useState(false)
23
+ // Do the action just once when ready after component mount, from hash on page load
24
+ const isToDo = isReady && !isDone
25
+ useEffect(() => {
26
+ if (isToDo) {
27
+ setIsDone(true)
28
+ doAction(action)
29
+ }
30
+ }, [isToDo, action])
31
+
32
+ // Bind the action for each hash change; do re-bind if the function changes.
33
+ useEffect(() => {
34
+ const handleChange = (event) => doAction(action, event)
35
+ window.addEventListener('hashchange', handleChange)
36
+ return () => window.removeEventListener('hashchange', handleChange)
37
+ }, [action])
38
+ }
39
+ export default useHash
@@ -0,0 +1,6 @@
1
+ /**
2
+ * No URL hashes on Native, so do a no-op. Remembering scenes for reloads
3
+ * is handled at OS level and deep links have completely different usage.
4
+ */
5
+ const useHash = () => {}
6
+ export default useHash
@@ -1,9 +1,9 @@
1
1
  /* eslint-disable react/no-multi-comp */
2
2
  import React from 'react'
3
- import { StyleSheet, Text, View } from 'react-native'
3
+ import { StyleSheet, View } from 'react-native'
4
4
 
5
- import A11yText from '../../lib/A11yText'
6
- import { Button, Typography } from '../../lib'
5
+ import A11yText from '../../src/A11yText'
6
+ import { Button, Typography } from '../../src'
7
7
  import { EachParentType, parentTypesParams } from '../supports'
8
8
 
9
9
  const defaultArgs = {
@@ -44,13 +44,9 @@ A11yTextAsHeading.args = { ...defaultArgs, heading: true }
44
44
 
45
45
  export const A11yTextInButton = (args) => (
46
46
  <Button onPress={() => {}}>
47
- {({ textStyles }) => (
48
- <>
49
- <A11yText {...args} />
50
- <Text style={textStyles}>A11yText sandwich</Text>
51
- <A11yText {...args} />
52
- </>
53
- )}
47
+ <A11yText {...args} />
48
+ A11yText sandwich
49
+ <A11yText {...args} />
54
50
  </Button>
55
51
  )
56
52
  A11yTextInButton.args = defaultArgs
@@ -1,6 +1,6 @@
1
1
  /* eslint-disable react/no-multi-comp */
2
2
  import React from 'react'
3
- import { ActivityIndicator } from '../../lib'
3
+ import { ActivityIndicator } from '../../src'
4
4
  import { EachParentType, parentTypesParams } from '../supports'
5
5
 
6
6
  export default {
@@ -2,7 +2,7 @@
2
2
  import React from 'react'
3
3
 
4
4
  import { View, StyleSheet } from 'react-native'
5
- import { Box, Typography } from '../../lib'
5
+ import { Box, Typography } from '../../src'
6
6
  import {
7
7
  spacingObjectArg,
8
8
  Container,
@@ -1,8 +1,8 @@
1
1
  /* eslint-disable react/no-multi-comp */
2
2
  import React from 'react'
3
- import { Button, useTheme } from '../../lib'
3
+ import { Button, useTheme } from '../../src'
4
4
  import { Container, useVariants, EachParentType, parentTypesParams } from '../supports'
5
- import { getComponentTheme } from '../../lib/ThemeProvider/utils'
5
+ import { getComponentTheme } from '../../src/ThemeProvider/utils'
6
6
 
7
7
  export const Default = (args) => <Button {...args} />
8
8
  Default.storyName = 'Button'
@@ -55,6 +55,11 @@ LongLabelButtonVariants.args = {
55
55
  children: 'This button has a label that is much longer than is considered advisable'
56
56
  }
57
57
 
58
+ export const ShortLabelButtonVariants = VariantsTemplate.bind({})
59
+ ShortLabelButtonVariants.args = {
60
+ children: 'k'
61
+ }
62
+
58
63
  export const ParentTypes = (args) => (
59
64
  <EachParentType componentThemeName="Button" {...args}>
60
65
  {({ label, variant }) => (
@@ -1,7 +1,7 @@
1
1
  /* eslint-disable react/no-multi-comp */
2
2
  import React, { useState } from 'react'
3
3
  import { View } from 'react-native'
4
- import { ButtonGroup, Typography } from '../../lib'
4
+ import { ButtonGroup, Typography } from '../../src'
5
5
  import { Container } from '../supports'
6
6
 
7
7
  const defaultArgs = {