@telus-uds/components-base 0.0.2-prerelease.5 → 0.0.2-prerelease.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ultra.cache.json +1 -0
- package/CHANGELOG.md +65 -0
- package/__fixtures__/Accessible.js +33 -0
- package/__fixtures__/Accessible.native.js +32 -0
- package/__fixtures__/testTheme.js +871 -52
- package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +1 -1
- package/__tests__/Button/ButtonBase.test.jsx +3 -32
- package/__tests__/Button/ButtonGroup.test.jsx +2 -2
- package/__tests__/Checkbox/Checkbox.test.jsx +94 -0
- package/__tests__/Checkbox/CheckboxGroup.test.jsx +247 -0
- package/__tests__/Icon/Icon.test.jsx +3 -3
- package/__tests__/IconButton/IconButton.test.jsx +52 -0
- package/__tests__/InputSupports/InputSupports.test.jsx +50 -0
- package/__tests__/List/List.test.jsx +60 -0
- package/__tests__/Modal/Modal.test.jsx +47 -0
- package/__tests__/Notification/Notification.test.jsx +20 -0
- package/__tests__/Pagination/Pagination.test.jsx +2 -2
- package/__tests__/Progress/Progress.test.jsx +79 -0
- package/__tests__/Radio/Radio.test.jsx +87 -0
- package/__tests__/Radio/RadioGroup.test.jsx +221 -0
- package/__tests__/RadioCard/RadioCard.test.jsx +87 -0
- package/__tests__/RadioCard/RadioCardGroup.test.jsx +247 -0
- package/__tests__/Search/Search.test.jsx +72 -0
- package/__tests__/Select/Select.test.jsx +93 -0
- package/__tests__/Skeleton/Skeleton.test.jsx +61 -0
- package/__tests__/StackView/StackView.test.jsx +0 -26
- package/__tests__/StepTracker/StepTracker.test.jsx +94 -0
- package/__tests__/Tabs/Tabs.test.jsx +200 -0
- package/__tests__/Tags/Tags.test.jsx +328 -0
- package/__tests__/TextInput/TextArea.test.jsx +34 -0
- package/__tests__/TextInput/{TextInput.test.jsx → TextInputBase.test.jsx} +20 -46
- package/__tests__/Tooltip/Tooltip.test.jsx +65 -0
- package/__tests__/Tooltip/getTooltipPosition.test.js +79 -0
- package/__tests__/utils/input.test.js +58 -0
- package/__tests__/utils/useCopy.test.js +42 -0
- package/__tests__/utils/useResponsiveProp.test.jsx +202 -0
- package/__tests__/utils/{spacing.test.jsx → useSpacingScale.test.jsx} +1 -1
- package/babel.config.js +20 -0
- package/jest.config.js +13 -4
- package/lib/A11yInfoProvider/index.js +54 -26
- package/lib/A11yText/index.js +37 -14
- package/lib/ActivityIndicator/Spinner.js +78 -0
- package/lib/ActivityIndicator/Spinner.native.js +121 -87
- package/lib/ActivityIndicator/index.js +28 -12
- package/lib/ActivityIndicator/shared.js +27 -12
- package/lib/BaseProvider/index.js +34 -11
- package/lib/Box/Box.js +54 -31
- package/lib/Box/index.js +13 -2
- package/lib/Button/Button.js +38 -10
- package/lib/Button/ButtonBase.js +115 -94
- package/lib/Button/ButtonGroup.js +94 -86
- package/lib/Button/ButtonLink.js +41 -13
- package/lib/Button/index.js +31 -4
- package/lib/Button/propTypes.js +32 -9
- package/lib/Card/Card.js +36 -41
- package/lib/Card/CardBase.js +78 -0
- package/lib/Card/PressableCardBase.js +137 -0
- package/lib/Card/index.js +40 -2
- package/lib/Checkbox/Checkbox.js +344 -0
- package/lib/Checkbox/CheckboxGroup.js +231 -0
- package/lib/Checkbox/CheckboxInput.js +74 -0
- package/lib/Checkbox/CheckboxInput.native.js +14 -0
- package/lib/Checkbox/index.js +21 -0
- package/lib/Divider/Divider.js +50 -24
- package/lib/Divider/index.js +13 -2
- package/lib/ExpandCollapse/Accordion.js +20 -7
- package/lib/ExpandCollapse/Control.js +50 -27
- package/lib/ExpandCollapse/ExpandCollapse.js +41 -24
- package/lib/ExpandCollapse/Panel.js +75 -37
- package/lib/ExpandCollapse/index.js +25 -7
- package/lib/Feedback/Feedback.js +85 -34
- package/lib/Feedback/index.js +13 -2
- package/lib/Fieldset/Fieldset.js +160 -0
- package/lib/Fieldset/FieldsetContainer.js +41 -0
- package/lib/Fieldset/FieldsetContainer.native.js +33 -0
- package/lib/Fieldset/Legend.js +33 -0
- package/lib/Fieldset/Legend.native.js +43 -0
- package/lib/Fieldset/cssReset.js +21 -0
- package/lib/Fieldset/index.js +13 -0
- package/lib/FlexGrid/Col/Col.js +67 -38
- package/lib/FlexGrid/Col/index.js +13 -2
- package/lib/FlexGrid/FlexGrid.js +70 -45
- package/lib/FlexGrid/Row/Row.js +48 -27
- package/lib/FlexGrid/Row/index.js +13 -2
- package/lib/FlexGrid/helpers/index.js +9 -1
- package/lib/FlexGrid/index.js +13 -2
- package/lib/FlexGrid/providers/GutterContext.js +15 -3
- package/lib/Icon/Icon.js +52 -47
- package/lib/Icon/IconText.js +100 -0
- package/lib/Icon/index.js +31 -3
- package/lib/IconButton/IconButton.js +135 -0
- package/lib/IconButton/index.js +13 -0
- package/lib/InputLabel/InputLabel.js +70 -34
- package/lib/InputLabel/LabelContent.js +31 -0
- package/lib/InputLabel/LabelContent.native.js +9 -1
- package/lib/InputLabel/index.js +13 -2
- package/lib/InputSupports/InputSupports.js +104 -0
- package/lib/InputSupports/index.js +13 -0
- package/lib/InputSupports/propTypes.js +66 -0
- package/lib/InputSupports/useInputSupports.js +41 -0
- package/lib/Link/ChevronLink.js +57 -15
- package/lib/Link/InlinePressable.js +50 -0
- package/lib/Link/InlinePressable.native.js +101 -0
- package/lib/Link/Link.js +30 -13
- package/lib/Link/LinkBase.js +114 -145
- package/lib/Link/TextButton.js +47 -17
- package/lib/Link/index.js +39 -4
- package/lib/List/List.js +80 -0
- package/lib/List/ListItem.js +237 -0
- package/lib/List/index.js +13 -0
- package/lib/Modal/Modal.js +226 -0
- package/lib/Modal/dictionary.js +16 -0
- package/lib/Modal/index.js +13 -0
- package/lib/Notification/Notification.js +200 -0
- package/lib/Notification/dictionary.js +15 -0
- package/lib/Notification/index.js +13 -0
- package/lib/Pagination/PageButton.js +45 -46
- package/lib/Pagination/Pagination.js +70 -40
- package/lib/Pagination/SideButton.js +74 -58
- package/lib/Pagination/dictionary.js +9 -2
- package/lib/Pagination/index.js +13 -2
- package/lib/Pagination/usePagination.js +12 -2
- package/lib/Progress/Progress.js +99 -0
- package/lib/Progress/ProgressBar.js +146 -0
- package/lib/Progress/ProgressBarBackground.js +57 -0
- package/lib/Progress/index.js +16 -0
- package/lib/Radio/Radio.js +292 -0
- package/lib/Radio/RadioButton.js +141 -0
- package/lib/Radio/RadioGroup.js +233 -0
- package/lib/Radio/RadioInput.js +76 -0
- package/lib/Radio/RadioInput.native.js +14 -0
- package/lib/Radio/index.js +21 -0
- package/lib/RadioCard/RadioCard.js +240 -0
- package/lib/RadioCard/RadioCardGroup.js +251 -0
- package/lib/RadioCard/index.js +21 -0
- package/lib/Search/Search.js +243 -0
- package/lib/Search/dictionary.js +19 -0
- package/lib/Search/index.js +13 -0
- package/lib/Select/Group.js +33 -0
- package/lib/Select/Group.native.js +25 -0
- package/lib/Select/Item.js +29 -0
- package/lib/Select/Item.native.js +19 -0
- package/lib/Select/Picker.js +79 -0
- package/lib/Select/Picker.native.js +115 -0
- package/lib/Select/Select.js +300 -0
- package/lib/Select/index.js +19 -0
- package/lib/SideNav/Item.js +54 -33
- package/lib/SideNav/ItemContent.js +41 -15
- package/lib/SideNav/ItemsGroup.js +46 -27
- package/lib/SideNav/SideNav.js +92 -69
- package/lib/SideNav/index.js +15 -1
- package/lib/Skeleton/Skeleton.js +137 -0
- package/lib/Skeleton/index.js +13 -0
- package/lib/Skeleton/skeleton.constant.js +12 -0
- package/lib/Skeleton/skeletonWebAnimation.js +27 -0
- package/lib/Skeleton/useSkeletonNativeAnimation.js +37 -0
- package/lib/Spacer/Spacer.js +31 -12
- package/lib/Spacer/index.js +13 -2
- package/lib/StackView/StackView.js +57 -33
- package/lib/StackView/StackWrap.js +33 -10
- package/lib/StackView/StackWrap.native.js +13 -2
- package/lib/StackView/StackWrapBox.js +50 -23
- package/lib/StackView/StackWrapGap.js +45 -19
- package/lib/StackView/common.js +19 -4
- package/lib/StackView/getStackedContent.js +49 -19
- package/lib/StackView/index.js +29 -5
- package/lib/StepTracker/Step.js +245 -0
- package/lib/StepTracker/StepTracker.js +197 -0
- package/lib/StepTracker/dictionary.js +17 -0
- package/lib/StepTracker/index.js +13 -0
- package/lib/Tabs/HorizontalScroll.js +199 -0
- package/lib/Tabs/ScrollViewEnd.js +66 -0
- package/lib/Tabs/ScrollViewEnd.native.js +41 -0
- package/lib/Tabs/Tabs.js +117 -0
- package/lib/Tabs/TabsItem.js +234 -0
- package/lib/Tabs/TabsScrollButton.js +121 -0
- package/lib/Tabs/dictionary.js +18 -0
- package/lib/Tabs/index.js +13 -0
- package/lib/Tabs/itemPositions.js +128 -0
- package/lib/Tags/Tags.js +250 -0
- package/lib/Tags/index.js +13 -0
- package/lib/TextInput/TextArea.js +109 -0
- package/lib/TextInput/TextInput.js +41 -303
- package/lib/TextInput/TextInputBase.js +252 -0
- package/lib/TextInput/index.js +23 -2
- package/lib/TextInput/propTypes.js +42 -0
- package/lib/ThemeProvider/ThemeProvider.js +38 -14
- package/lib/ThemeProvider/index.js +61 -6
- package/lib/ThemeProvider/useSetTheme.js +14 -5
- package/lib/ThemeProvider/useTheme.js +13 -4
- package/lib/ThemeProvider/useThemeTokens.js +86 -19
- package/lib/ThemeProvider/utils/index.js +31 -2
- package/lib/ThemeProvider/utils/styles.js +52 -16
- package/lib/ThemeProvider/utils/theme-tokens.js +94 -16
- package/lib/ToggleSwitch/ToggleSwitch.js +76 -52
- package/lib/ToggleSwitch/index.js +13 -2
- package/lib/Tooltip/Backdrop.js +56 -0
- package/lib/Tooltip/Backdrop.native.js +59 -0
- package/lib/Tooltip/Tooltip.js +357 -0
- package/lib/Tooltip/dictionary.js +15 -0
- package/lib/Tooltip/getTooltipPosition.js +172 -0
- package/lib/Tooltip/index.js +13 -0
- package/lib/TooltipButton/TooltipButton.js +83 -0
- package/lib/TooltipButton/index.js +13 -0
- package/lib/Typography/Typography.js +58 -43
- package/lib/Typography/index.js +13 -2
- package/lib/ViewportProvider/ViewportProvider.js +46 -0
- package/lib/ViewportProvider/index.js +22 -38
- package/lib/ViewportProvider/useViewport.js +15 -0
- package/lib/ViewportProvider/useViewportListener.js +57 -0
- package/lib/index.js +518 -24
- package/lib/utils/a11y/index.js +18 -0
- package/lib/utils/a11y/textSize.js +49 -0
- package/lib/utils/animation/index.js +15 -2
- package/lib/utils/animation/useVerticalExpandAnimation.js +28 -11
- package/lib/utils/children.js +87 -0
- package/lib/utils/index.js +163 -4
- package/lib/utils/info/index.js +19 -0
- package/lib/utils/info/platform/index.js +23 -0
- package/lib/utils/info/platform/platform.android.js +8 -0
- package/lib/utils/info/platform/platform.ios.js +8 -0
- package/lib/utils/info/platform/platform.js +8 -0
- package/lib/utils/info/platform/platform.native.js +11 -0
- package/lib/utils/info/versions.js +16 -0
- package/lib/utils/input.js +51 -33
- package/lib/utils/pressability.js +120 -0
- package/lib/utils/propTypes.js +269 -116
- package/lib/utils/useCopy.js +51 -0
- package/lib/utils/useHash.js +48 -0
- package/lib/utils/useHash.native.js +15 -0
- package/lib/utils/useResponsiveProp.js +59 -0
- package/lib/utils/{spacing/useSpacingScale.js → useSpacingScale.js} +45 -12
- package/lib/utils/useUniqueId.js +13 -4
- package/package.json +12 -9
- package/release-context.json +4 -4
- package/src/ActivityIndicator/{Spinner.web.jsx → Spinner.jsx} +0 -0
- package/src/Box/Box.jsx +11 -4
- package/src/Button/Button.jsx +9 -5
- package/src/Button/ButtonBase.jsx +69 -69
- package/src/Button/ButtonGroup.jsx +11 -24
- package/src/Button/ButtonLink.jsx +14 -4
- package/src/Button/propTypes.js +12 -2
- package/src/Card/Card.jsx +4 -30
- package/src/Card/CardBase.jsx +57 -0
- package/src/Card/PressableCardBase.jsx +112 -0
- package/src/Card/index.js +3 -0
- package/src/Checkbox/Checkbox.jsx +274 -0
- package/src/Checkbox/CheckboxGroup.jsx +196 -0
- package/src/Checkbox/CheckboxInput.jsx +55 -0
- package/src/Checkbox/CheckboxInput.native.jsx +6 -0
- package/src/Checkbox/index.js +5 -0
- package/src/ExpandCollapse/Control.jsx +1 -1
- package/src/Feedback/Feedback.jsx +31 -22
- package/src/Fieldset/Fieldset.jsx +129 -0
- package/src/Fieldset/FieldsetContainer.jsx +22 -0
- package/src/Fieldset/FieldsetContainer.native.jsx +16 -0
- package/src/Fieldset/Legend.jsx +16 -0
- package/src/Fieldset/Legend.native.jsx +22 -0
- package/src/Fieldset/cssReset.js +14 -0
- package/src/Fieldset/index.js +3 -0
- package/src/Icon/Icon.jsx +21 -26
- package/src/Icon/IconText.jsx +63 -0
- package/src/Icon/index.js +3 -2
- package/src/IconButton/IconButton.jsx +107 -0
- package/src/IconButton/index.js +3 -0
- package/src/InputLabel/InputLabel.jsx +11 -4
- package/src/InputLabel/{LabelContent.web.jsx → LabelContent.jsx} +0 -0
- package/src/InputSupports/InputSupports.jsx +75 -0
- package/src/InputSupports/index.js +3 -0
- package/src/InputSupports/propTypes.js +44 -0
- package/src/InputSupports/useInputSupports.js +30 -0
- package/src/Link/ChevronLink.jsx +28 -7
- package/src/Link/InlinePressable.jsx +37 -0
- package/src/Link/InlinePressable.native.jsx +73 -0
- package/src/Link/Link.jsx +17 -13
- package/src/Link/LinkBase.jsx +67 -148
- package/src/Link/TextButton.jsx +25 -11
- package/src/Link/index.js +2 -1
- package/src/List/List.jsx +47 -0
- package/src/List/ListItem.jsx +187 -0
- package/src/List/index.js +3 -0
- package/src/Modal/Modal.jsx +185 -0
- package/src/Modal/dictionary.js +9 -0
- package/src/Modal/index.js +3 -0
- package/src/Notification/Notification.jsx +149 -0
- package/src/Notification/dictionary.js +8 -0
- package/src/Notification/index.js +3 -0
- package/src/Pagination/PageButton.jsx +3 -17
- package/src/Pagination/SideButton.jsx +27 -38
- package/src/Progress/Progress.jsx +77 -0
- package/src/Progress/ProgressBar.jsx +110 -0
- package/src/Progress/ProgressBarBackground.jsx +34 -0
- package/src/Progress/index.js +6 -0
- package/src/Radio/Radio.jsx +233 -0
- package/src/Radio/RadioButton.jsx +131 -0
- package/src/Radio/RadioGroup.jsx +198 -0
- package/src/Radio/RadioInput.jsx +57 -0
- package/src/Radio/RadioInput.native.jsx +6 -0
- package/src/Radio/index.js +5 -0
- package/src/RadioCard/RadioCard.jsx +191 -0
- package/src/RadioCard/RadioCardGroup.jsx +211 -0
- package/src/RadioCard/index.js +5 -0
- package/src/Search/Search.jsx +204 -0
- package/src/Search/dictionary.js +12 -0
- package/src/Search/index.js +3 -0
- package/src/Select/Group.jsx +15 -0
- package/src/Select/Group.native.jsx +14 -0
- package/src/Select/Item.jsx +11 -0
- package/src/Select/Item.native.jsx +10 -0
- package/src/Select/Picker.jsx +67 -0
- package/src/Select/Picker.native.jsx +95 -0
- package/src/Select/Select.jsx +255 -0
- package/src/Select/index.js +8 -0
- package/src/SideNav/Item.jsx +2 -2
- package/src/Skeleton/Skeleton.jsx +98 -0
- package/src/Skeleton/index.js +3 -0
- package/src/Skeleton/skeleton.constant.js +3 -0
- package/src/Skeleton/skeletonWebAnimation.js +13 -0
- package/src/Skeleton/useSkeletonNativeAnimation.js +27 -0
- package/src/StackView/StackView.jsx +25 -17
- package/src/StackView/StackWrap.jsx +9 -1
- package/src/StackView/StackWrapBox.jsx +19 -7
- package/src/StackView/StackWrapGap.jsx +15 -5
- package/src/StackView/getStackedContent.jsx +8 -2
- package/src/StepTracker/Step.jsx +202 -0
- package/src/StepTracker/StepTracker.jsx +163 -0
- package/src/StepTracker/dictionary.js +10 -0
- package/src/StepTracker/index.js +3 -0
- package/src/Tabs/HorizontalScroll.jsx +165 -0
- package/src/Tabs/ScrollViewEnd.jsx +53 -0
- package/src/Tabs/ScrollViewEnd.native.jsx +24 -0
- package/src/Tabs/Tabs.jsx +89 -0
- package/src/Tabs/TabsItem.jsx +204 -0
- package/src/Tabs/TabsScrollButton.jsx +100 -0
- package/src/Tabs/dictionary.js +11 -0
- package/src/Tabs/index.js +3 -0
- package/src/Tabs/itemPositions.js +101 -0
- package/src/Tags/Tags.jsx +207 -0
- package/src/Tags/index.js +3 -0
- package/src/TextInput/TextArea.jsx +78 -0
- package/src/TextInput/TextInput.jsx +17 -290
- package/src/TextInput/TextInputBase.jsx +210 -0
- package/src/TextInput/index.js +2 -1
- package/src/TextInput/propTypes.js +29 -0
- package/src/ThemeProvider/useThemeTokens.js +56 -5
- package/src/ThemeProvider/utils/styles.js +18 -5
- package/src/ThemeProvider/utils/theme-tokens.js +46 -5
- package/src/ToggleSwitch/ToggleSwitch.jsx +3 -4
- package/src/Tooltip/Backdrop.jsx +60 -0
- package/src/Tooltip/Backdrop.native.jsx +33 -0
- package/src/Tooltip/Tooltip.jsx +294 -0
- package/src/Tooltip/dictionary.js +8 -0
- package/src/Tooltip/getTooltipPosition.js +161 -0
- package/src/Tooltip/index.js +3 -0
- package/src/TooltipButton/TooltipButton.jsx +49 -0
- package/src/TooltipButton/index.js +3 -0
- package/src/Typography/Typography.jsx +10 -20
- package/src/ViewportProvider/ViewportProvider.jsx +21 -0
- package/src/ViewportProvider/index.jsx +2 -41
- package/src/ViewportProvider/useViewport.js +5 -0
- package/src/ViewportProvider/useViewportListener.js +43 -0
- package/src/index.js +31 -3
- package/src/utils/a11y/index.js +1 -0
- package/src/utils/a11y/textSize.js +30 -0
- package/src/utils/children.jsx +66 -0
- package/src/utils/index.js +11 -1
- package/src/utils/info/index.js +8 -0
- package/src/utils/info/platform/index.js +11 -0
- package/src/utils/info/platform/platform.android.js +1 -0
- package/src/utils/info/platform/platform.ios.js +1 -0
- package/src/utils/info/platform/platform.js +1 -0
- package/src/utils/info/platform/platform.native.js +4 -0
- package/src/utils/info/versions.js +6 -0
- package/src/utils/input.js +20 -12
- package/src/utils/pressability.js +96 -0
- package/src/utils/propTypes.js +195 -56
- package/src/utils/useCopy.js +39 -0
- package/src/utils/useHash.js +34 -0
- package/src/utils/useHash.native.js +6 -0
- package/src/utils/useResponsiveProp.js +50 -0
- package/src/utils/{spacing/useSpacingScale.js → useSpacingScale.js} +25 -10
- package/stories/A11yText/A11yText.stories.jsx +4 -8
- package/stories/Button/Button.stories.jsx +5 -0
- package/stories/Card/Card.stories.jsx +1 -1
- package/stories/Checkbox/Checkbox.stories.jsx +94 -0
- package/stories/Feedback/Feedback.stories.jsx +5 -6
- package/stories/Icon/Icon.stories.jsx +27 -7
- package/stories/IconButton/IconButton.stories.jsx +50 -0
- package/stories/InputLabel/InputLabel.stories.jsx +8 -3
- package/stories/Link/ChevronLink.stories.jsx +3 -3
- package/stories/Link/Link.stories.jsx +28 -18
- package/stories/List/List.stories.jsx +117 -0
- package/stories/Modal/Modal.stories.jsx +29 -0
- package/stories/Notification/Notification.stories.jsx +82 -0
- package/stories/Progress/Progress.stories.jsx +93 -0
- package/stories/Radio/Radio.stories.jsx +100 -0
- package/stories/RadioCard/RadioCard.stories.jsx +98 -0
- package/stories/Search/Search.stories.jsx +16 -0
- package/stories/Select/Select.stories.jsx +55 -0
- package/stories/Skeleton/Skeleton.stories.jsx +36 -0
- package/stories/Spacer/Spacer.stories.jsx +7 -2
- package/stories/StackView/StackView.stories.jsx +10 -0
- package/stories/StackView/StackWrap.stories.jsx +12 -0
- package/stories/StepTracker/StepTracker.stories.jsx +71 -0
- package/stories/Tabs/Tabs.stories.jsx +97 -0
- package/stories/Tags/Tags.stories.jsx +69 -0
- package/stories/TextInput/TextArea.stories.jsx +100 -0
- package/stories/Tooltip/Tooltip.stories.jsx +81 -0
- package/stories/TooltipButton/TooltipButton.stories.jsx +11 -0
- package/stories/{platform-supports.web.jsx → platform-supports.jsx} +0 -0
- package/stories/supports.jsx +36 -2
- package/__fixtures__/accessible.icon.svg +0 -6
- package/babel.config.json +0 -8
- package/docs/Contributing.stories.mdx +0 -9
- package/docs/Fonts.stories.mdx +0 -104
- package/docs/Icons.stories.mdx +0 -144
- package/docs/Introduction.stories.mdx +0 -9
- package/lib/ActivityIndicator/Spinner.web.js +0 -55
- package/lib/InputLabel/LabelContent.web.js +0 -17
- package/lib/Pagination/useCopy.js +0 -10
- package/lib/config/svgr-icons-web.js +0 -9
- package/lib/config/svgr-icons.js +0 -52
- package/lib/utils/spacing/index.js +0 -2
- package/lib/utils/spacing/utils.js +0 -32
- package/src/Pagination/useCopy.js +0 -7
- package/src/config/svgr-icons-web.js +0 -11
- package/src/config/svgr-icons.js +0 -46
- package/src/utils/spacing/index.js +0 -3
- package/src/utils/spacing/utils.js +0 -28
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { useCallback } from 'react'
|
|
2
2
|
import useTheme from './useTheme'
|
|
3
|
-
import { getComponentTheme, getThemeTokens,
|
|
3
|
+
import { getComponentTheme, getThemeTokens, resolveThemeTokens, mergeAppearances } from './utils'
|
|
4
4
|
/**
|
|
5
5
|
* @typedef {import('../utils/propTypes.js').AppearanceSet} AppearanceSet
|
|
6
6
|
* @typedef {import('../utils/propTypes.js').TokensProp} TokensProp
|
|
@@ -11,6 +11,22 @@ import { getComponentTheme, getThemeTokens, resolveTokens, mergeAppearances } fr
|
|
|
11
11
|
* Returns a complete set of theme tokens for a component based on which of the
|
|
12
12
|
* component's theme rules apply to the current set of theme appearances.
|
|
13
13
|
*
|
|
14
|
+
* When applying theme tokens as styles to a component, don't spread the theme tokens
|
|
15
|
+
* object, explicitly select each property. This way, if new theme tokens are added to the
|
|
16
|
+
* component's theme in a minor or patch release of the theme package, the appearance
|
|
17
|
+
* of the component in sites and apps will only change when the component itself is updated.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* const seletContainerTokens = ({ color, width, height }) => ({
|
|
21
|
+
* backgroundColor: color, width, height
|
|
22
|
+
* })
|
|
23
|
+
* const MyComponent = ({ tokens, variant, children }) => {
|
|
24
|
+
* const viewport = useViewport()
|
|
25
|
+
* const themeTokens = useThemeTokens('MyComponent', tokens, variant, { viewport })
|
|
26
|
+
* const style = seletContainerTokens(themeTokens)
|
|
27
|
+
* return <View style={style}>{children}</View>
|
|
28
|
+
* }
|
|
29
|
+
*
|
|
14
30
|
* @param {string} componentName - the name as defined in the theme schema of the component whose theme is to be used
|
|
15
31
|
* @param {TokensProp} [tokens] - every themed component should accept an optional `tokens` prop allowing theme tokens to be overridden
|
|
16
32
|
* @param {AppearanceSet} [variants] - every themed component should accept an optional `variants` prop specifying theme variants
|
|
@@ -26,13 +42,48 @@ export const useThemeTokens = (componentName, tokens = {}, variants = {}, states
|
|
|
26
42
|
|
|
27
43
|
/**
|
|
28
44
|
* Returns a memoised tokens getter function that gets tokens similar to calling useThemeTokens.
|
|
29
|
-
* Scenarios where useThemeTokensCallback should be used instead of useThemeTokens include:
|
|
45
|
+
* Scenarios where `useThemeTokensCallback` should be used instead of `useThemeTokens` include:
|
|
30
46
|
*
|
|
31
|
-
* - Where tokens to be obtained from state accessible only in scopes like callbacks
|
|
32
|
-
* where calling useThemeTokens directly would be disallowed by React's hook rules.
|
|
47
|
+
* - Where tokens are to be obtained from state that is accessible only in scopes like callbacks
|
|
48
|
+
* and render functions, where calling useThemeTokens directly would be disallowed by React's hook rules.
|
|
33
49
|
* - Passing a tokens getter down via a child component's `tokens` prop, applying rules using the
|
|
34
50
|
* child component's current state. Consider wrapping the returned tokens in `selectTokens()`.
|
|
35
51
|
*
|
|
52
|
+
* The function returned by `useThemeTokens` may be called with an object of state appearances to get an object
|
|
53
|
+
* of tokens, or may be passed as a `tokens` prop to other themed components or `useThemeTokens`/`useThemeTokensCallback`
|
|
54
|
+
* hooks.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* // Resolving tokens inside Pressable's style function, based on Pressable state
|
|
58
|
+
* const PressMe = ({ tokens, variant, children }) => {
|
|
59
|
+
* const getTokens = useThemeTokensCallback('PressMe', tokens, variant)
|
|
60
|
+
* const getPressableStyle = ({ pressed }) => {
|
|
61
|
+
* const { color, width, height } = getTokens({ pressed })
|
|
62
|
+
* return { backgroundColor: color, width, height }
|
|
63
|
+
* }
|
|
64
|
+
* return <Pressable style={getPressableStyle}>{children}</Pressable>
|
|
65
|
+
* }
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* // Setting the theme in a parent and resolving it in a child based on child's state
|
|
69
|
+
* const MenuButton = ({ tokens, variant, ...buttonProps }) => {
|
|
70
|
+
* // Define what theme, variant etc we want in this component...
|
|
71
|
+
* const getTokens = useThemeTokensCallback('Button', tokens, variant)
|
|
72
|
+
* // ...resolve them in another component based on its state (e.g. press, hover...)
|
|
73
|
+
* return <ButtonBase tokens={getTokens} accessibilityRole="menuitem" {...buttonProps} />
|
|
74
|
+
* }
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* // Chaining multiple themes together, sharing the same variants and state
|
|
78
|
+
* const GlowingLink = ({ tokens, variant, children }) => {
|
|
79
|
+
* // applies a small theme for a glowing effect, using same variants and states as "link"
|
|
80
|
+
* const getGlowTokens = useThemeCallback('GlowingLink', tokens, variant)
|
|
81
|
+
* // applies link state to get "Link" theme tokens and merge "GlowingLink" tokens on top
|
|
82
|
+
* const getTokens = useThemeCallback('Link', getGlowTokens, variant)
|
|
83
|
+
* // renders a link with both themes applied, both based on current link state
|
|
84
|
+
* return <LinkBase tokens={getTokens}>{children}</LinkBase>
|
|
85
|
+
* }
|
|
86
|
+
*
|
|
36
87
|
* @param {string} componentName - the name as defined in the theme schema of the component whose theme is to be used
|
|
37
88
|
* @param {TokensProp} [tokens] - every themed component should accept a `tokens` prop allowing theme tokens to be overridden
|
|
38
89
|
* @param {AppearanceSet} [variants] - variants passed in as props that don't change dynamically
|
|
@@ -47,7 +98,7 @@ export const useThemeTokensCallback = (componentName, tokens = {}, variants = {}
|
|
|
47
98
|
const getThemeTokensCallback = useCallback(
|
|
48
99
|
(states, tokenOverrides) => {
|
|
49
100
|
const appearances = mergeAppearances(variants, states)
|
|
50
|
-
const resolvedTokens =
|
|
101
|
+
const resolvedTokens = resolveThemeTokens(tokens, appearances, tokenOverrides)
|
|
51
102
|
return getThemeTokens(componentTheme, resolvedTokens, appearances)
|
|
52
103
|
},
|
|
53
104
|
[componentTheme, tokens, variants]
|
|
@@ -9,6 +9,7 @@ import { fontBasePixels } from '@telus-uds/system-constants'
|
|
|
9
9
|
// Make design tokens fit React Native's text styles' specific requirements and quirks
|
|
10
10
|
export function applyTextStyles({
|
|
11
11
|
fontSize,
|
|
12
|
+
fontScaleCap,
|
|
12
13
|
lineHeight,
|
|
13
14
|
letterSpacing,
|
|
14
15
|
fontWeight = '400',
|
|
@@ -27,7 +28,7 @@ export function applyTextStyles({
|
|
|
27
28
|
styles.lineHeight = lineHeight * (fontSize || fontBasePixels)
|
|
28
29
|
}
|
|
29
30
|
|
|
30
|
-
if (typeof letterSpacing === 'number') {
|
|
31
|
+
if (typeof letterSpacing === 'number' && letterSpacing) {
|
|
31
32
|
// Same as for line heights - React Native expects absolute letter spacing value
|
|
32
33
|
styles.letterSpacing = letterSpacing * (fontSize || fontBasePixels)
|
|
33
34
|
}
|
|
@@ -133,7 +134,19 @@ export function verticalAlignRow(verticalAlign, reverse = false) {
|
|
|
133
134
|
}
|
|
134
135
|
}
|
|
135
136
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
137
|
+
/**
|
|
138
|
+
* Use on an outer container to create an outer border with an optional gap around it
|
|
139
|
+
* that matches the border radius of any inner border.
|
|
140
|
+
*/
|
|
141
|
+
export const applyOuterBorder = ({
|
|
142
|
+
outerBorderColor,
|
|
143
|
+
outerBorderWidth = 0,
|
|
144
|
+
outerBorderGap = 0,
|
|
145
|
+
borderRadius = 0
|
|
146
|
+
}) => ({
|
|
147
|
+
margin: 0 - outerBorderWidth - outerBorderGap,
|
|
148
|
+
padding: outerBorderGap,
|
|
149
|
+
borderRadius: borderRadius + outerBorderGap + outerBorderWidth,
|
|
150
|
+
borderWidth: outerBorderWidth,
|
|
151
|
+
borderColor: outerBorderColor
|
|
152
|
+
})
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import PropTypes from 'prop-types'
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* @typedef {import('../../utils/propTypes.js').AppearanceSet} AppearanceSet
|
|
3
5
|
* @typedef {import('../../utils/propTypes.js').TokensProp} TokensProp
|
|
@@ -37,15 +39,22 @@ export const doesThemeRuleApply = (rule, appearances) =>
|
|
|
37
39
|
Object.entries(rule.if).every((condition) => doesThemeConditionApply(condition, appearances))
|
|
38
40
|
|
|
39
41
|
/**
|
|
40
|
-
* Turns a tokens prop
|
|
41
|
-
* into one tokens
|
|
42
|
+
* Turns a tokens prop (which may be either a tokens object or a tokens getter function)
|
|
43
|
+
* into one resolved tokens object, based on current appearances state.
|
|
44
|
+
*
|
|
45
|
+
* This is used inside `useThemeTokens` and `useThemeTokensCallback` for handling the `tokens`
|
|
46
|
+
* props of themed components. It may also be used directly in cases where a non-themed component
|
|
47
|
+
* needs to resolve a tokens prop that may be a tokens getter function or a resolved tokens object.
|
|
48
|
+
*
|
|
49
|
+
* A second tokens prop of tokens overrides may optionally be passed; it will be resolved to an object
|
|
50
|
+
* based on provided appearance state and then shallow-merged over the first set of tokens.
|
|
42
51
|
*
|
|
43
52
|
* @param {TokensProp} defaultTokens - a set of tokens or tokens getter function which may be overridden
|
|
44
|
-
* @param {TokensProp} [tokenOverrides] - optional set of tokens or tokens getter function to override the default
|
|
45
53
|
* @param {AppearanceSet} [appearances] - optional appearance set to pass to tokens getter functions
|
|
54
|
+
* @param {TokensProp} [tokenOverrides] - optional set of tokens or tokens getter function to override the default
|
|
46
55
|
* @returns {TokensSet} - object containing resolved tokens with overrides applied
|
|
47
56
|
*/
|
|
48
|
-
export const
|
|
57
|
+
export const resolveThemeTokens = (defaultTokens, appearances = {}, tokenOverrides) => {
|
|
49
58
|
const resolve = (tokens) => (typeof tokens === 'function' ? tokens(appearances) : tokens)
|
|
50
59
|
if (!tokenOverrides) return resolve(defaultTokens)
|
|
51
60
|
|
|
@@ -56,6 +65,27 @@ export const resolveTokens = (defaultTokens, tokenOverrides, appearances = {}) =
|
|
|
56
65
|
)
|
|
57
66
|
}
|
|
58
67
|
|
|
68
|
+
/**
|
|
69
|
+
* Gives a prop types error if a set of resolved tokens doesn't match a provided prop
|
|
70
|
+
* types validator.
|
|
71
|
+
*
|
|
72
|
+
* In production, this is a no-op (PropTypes.checkPropTypes is automatically replaced
|
|
73
|
+
* with a no-op function).
|
|
74
|
+
*
|
|
75
|
+
* @param {TokensSet} themeTokens - object containing resolved theme tokens
|
|
76
|
+
* @param {function} validator - PropTypes validator function
|
|
77
|
+
* @param {string} componentName - identifier to display in PropType error messages
|
|
78
|
+
*/
|
|
79
|
+
export const validateThemeTokens = (themeTokens, validator, componentName) => {
|
|
80
|
+
PropTypes.checkPropTypes(
|
|
81
|
+
{ tokens: validator },
|
|
82
|
+
{ tokens: themeTokens },
|
|
83
|
+
'resolved token',
|
|
84
|
+
componentName
|
|
85
|
+
)
|
|
86
|
+
return themeTokens
|
|
87
|
+
}
|
|
88
|
+
|
|
59
89
|
/**
|
|
60
90
|
* Merges variants over states. Must be merged in that order to allow static showcases of a state,
|
|
61
91
|
* e.g. `<Button variant={{ pressed: true }} />` where button's pressed state is `false` by default.
|
|
@@ -68,6 +98,17 @@ export const resolveTokens = (defaultTokens, tokenOverrides, appearances = {}) =
|
|
|
68
98
|
export const mergeAppearances = (variants = {}, states) =>
|
|
69
99
|
states ? { ...states, ...variants } : variants
|
|
70
100
|
|
|
101
|
+
/**
|
|
102
|
+
* Get a set of theme tokens by applying a theme's component rules based on a component's variants and state.
|
|
103
|
+
*
|
|
104
|
+
* This is used internally in `useThemeTokens` and `useThemeTokensCallback` and should not normally be called directly.
|
|
105
|
+
*
|
|
106
|
+
* @param {object} componentTheme - object containing a theme's `tokens` and `rules` for a component
|
|
107
|
+
* @param {object|function} [tokensProp] - UDS tokens prop containing theming overrides
|
|
108
|
+
* @param {object} [variants] - UDS variant prop containing the variant options for this component instance
|
|
109
|
+
* @param {object} [states] - object containing current state options for this component instance
|
|
110
|
+
* @returns {object} Set of resolved theme tokens
|
|
111
|
+
*/
|
|
71
112
|
export const getThemeTokens = (
|
|
72
113
|
{ rules = [], tokens: defaultThemeTokens = {} },
|
|
73
114
|
tokensProp,
|
|
@@ -88,7 +129,7 @@ export const getThemeTokens = (
|
|
|
88
129
|
: mergedTokens,
|
|
89
130
|
defaultThemeTokens
|
|
90
131
|
)
|
|
91
|
-
return
|
|
132
|
+
return resolveThemeTokens(themeTokens, appearances, tokensProp)
|
|
92
133
|
}
|
|
93
134
|
|
|
94
135
|
export const toArray = (strOrArr) => (Array.isArray(strOrArr) ? strOrArr : [strOrArr])
|
|
@@ -21,8 +21,7 @@ const selectButtonTokens = (tokens) =>
|
|
|
21
21
|
})
|
|
22
22
|
|
|
23
23
|
// Map and rename icon-specific tokens to name used within Icon
|
|
24
|
-
const selectIconTokens = ({ iconSize, iconColor
|
|
25
|
-
opacity: iconOpacity,
|
|
24
|
+
const selectIconTokens = ({ iconSize, iconColor }) => ({
|
|
26
25
|
size: iconSize,
|
|
27
26
|
color: iconColor
|
|
28
27
|
})
|
|
@@ -103,7 +102,7 @@ const ToggleSwitch = ({
|
|
|
103
102
|
return (
|
|
104
103
|
<View style={[staticStyles.track, trackStyles]}>
|
|
105
104
|
<View style={[staticStyles.switch, switchStyles, switchPositionStyle]}>
|
|
106
|
-
{IconComponent && <IconComponent
|
|
105
|
+
{IconComponent && <IconComponent {...iconTokens} />}
|
|
107
106
|
</View>
|
|
108
107
|
</View>
|
|
109
108
|
)
|
|
@@ -142,7 +141,7 @@ ToggleSwitch.propTypes = {
|
|
|
142
141
|
|
|
143
142
|
const staticStyles = StyleSheet.create({
|
|
144
143
|
track: {
|
|
145
|
-
|
|
144
|
+
flexGrow: 1,
|
|
146
145
|
alignSelf: 'stretch',
|
|
147
146
|
flexDirection: 'row'
|
|
148
147
|
},
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { useEffect, useState } from 'react'
|
|
2
|
+
import ReactDOM from 'react-dom'
|
|
3
|
+
import PropTypes from 'prop-types'
|
|
4
|
+
|
|
5
|
+
function createPortalNode(nodeId) {
|
|
6
|
+
const node = document.createElement('div')
|
|
7
|
+
|
|
8
|
+
node.id = nodeId
|
|
9
|
+
|
|
10
|
+
// we're mimicking React Native's Modal component, except for using an `absolute` position
|
|
11
|
+
// this way the backdrop stays in place when scrolling the window - that's why we need to
|
|
12
|
+
// position it at the scroll position when rendering
|
|
13
|
+
node.style.cssText = `
|
|
14
|
+
position: absolute;
|
|
15
|
+
top: ${window.scrollY}px;
|
|
16
|
+
left: ${window.scrollX}px;
|
|
17
|
+
right: 0;
|
|
18
|
+
bottom: 0;
|
|
19
|
+
z-index: 9999;
|
|
20
|
+
pointer-events: none;
|
|
21
|
+
`
|
|
22
|
+
|
|
23
|
+
document.body.appendChild(node)
|
|
24
|
+
|
|
25
|
+
return node
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
function removePortalNode(nodeId) {
|
|
29
|
+
const node = document.getElementById(nodeId)
|
|
30
|
+
|
|
31
|
+
node.parentElement.removeChild(node)
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* The Web version of Backdrop utilizes React Portal for overlaying page content, so it is
|
|
36
|
+
* dependent on ReactDOM. Tooltip's closing is handled by the onBlur callback of the control.
|
|
37
|
+
*/
|
|
38
|
+
function Backdrop({ children }) {
|
|
39
|
+
const [portalNode, setPortalNode] = useState()
|
|
40
|
+
|
|
41
|
+
useEffect(() => {
|
|
42
|
+
const nodeId = `tooltip-backdrop-${Date.now()}`
|
|
43
|
+
|
|
44
|
+
const node = createPortalNode(nodeId)
|
|
45
|
+
|
|
46
|
+
setPortalNode(node)
|
|
47
|
+
|
|
48
|
+
return () => {
|
|
49
|
+
removePortalNode(nodeId)
|
|
50
|
+
}
|
|
51
|
+
}, [])
|
|
52
|
+
|
|
53
|
+
return portalNode ? ReactDOM.createPortal(children, portalNode) : null
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
Backdrop.propTypes = {
|
|
57
|
+
children: PropTypes.node
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export default Backdrop
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import React from 'react'
|
|
2
|
+
import { TouchableWithoutFeedback, Modal, StyleSheet, View } from 'react-native'
|
|
3
|
+
import PropTypes from 'prop-types'
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* The Native version of Backdrop utilizes React Native's Modal component for overlaying
|
|
7
|
+
* the app's content, since this is the only reliable to do it. The only drawback of this
|
|
8
|
+
* approach is that a press on the Backdrop will actually stop the press event from propagating,
|
|
9
|
+
* i.e. anything rendered beneath the Backdrop can't be pressed until the Backdrop is closed.
|
|
10
|
+
*/
|
|
11
|
+
function Backdrop({ onPress, children }) {
|
|
12
|
+
return (
|
|
13
|
+
<Modal transparent>
|
|
14
|
+
<TouchableWithoutFeedback onPress={onPress}>
|
|
15
|
+
<View style={staticStyles.backdrop}>{children}</View>
|
|
16
|
+
</TouchableWithoutFeedback>
|
|
17
|
+
</Modal>
|
|
18
|
+
)
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export default Backdrop
|
|
22
|
+
|
|
23
|
+
Backdrop.propTypes = {
|
|
24
|
+
onPress: PropTypes.func,
|
|
25
|
+
children: PropTypes.node
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const staticStyles = StyleSheet.create({
|
|
29
|
+
backdrop: {
|
|
30
|
+
flexBasis: '100%',
|
|
31
|
+
backgroundColor: 'rgba(255, 255, 255, 0.5)' // to visually mark that the content beneath is not pressable
|
|
32
|
+
}
|
|
33
|
+
})
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
import React, { useEffect, useRef, useState } from 'react'
|
|
2
|
+
import { Dimensions, Platform, Pressable, StyleSheet, Text, View } from 'react-native'
|
|
3
|
+
|
|
4
|
+
import PropTypes from 'prop-types'
|
|
5
|
+
import { applyShadowToken, applyTextStyles, useThemeTokens } from '../ThemeProvider'
|
|
6
|
+
import { getTokensPropType, selectTokens, variantProp } from '../utils'
|
|
7
|
+
import Backdrop from './Backdrop'
|
|
8
|
+
import getTooltipPosition from './getTooltipPosition'
|
|
9
|
+
import TooltipButton from '../TooltipButton'
|
|
10
|
+
import useCopy from '../utils/useCopy'
|
|
11
|
+
import dictionary from './dictionary'
|
|
12
|
+
|
|
13
|
+
const selectTooltipStyles = ({
|
|
14
|
+
backgroundColor,
|
|
15
|
+
paddingTop,
|
|
16
|
+
paddingBottom,
|
|
17
|
+
paddingLeft,
|
|
18
|
+
paddingRight,
|
|
19
|
+
borderRadius
|
|
20
|
+
}) => ({
|
|
21
|
+
backgroundColor,
|
|
22
|
+
paddingTop,
|
|
23
|
+
paddingBottom,
|
|
24
|
+
paddingLeft,
|
|
25
|
+
paddingRight,
|
|
26
|
+
borderRadius
|
|
27
|
+
})
|
|
28
|
+
const selectTooltipShadowStyles = ({ shadow, borderRadius }) => ({
|
|
29
|
+
borderRadius,
|
|
30
|
+
...applyShadowToken(shadow)
|
|
31
|
+
})
|
|
32
|
+
const selectTooltipPositionStyles = ({ top, left, width }) => {
|
|
33
|
+
return { top, left, width }
|
|
34
|
+
}
|
|
35
|
+
const selectArrowStyles = (
|
|
36
|
+
{ backgroundColor, arrowWidth, arrowBorderRadius, shadow },
|
|
37
|
+
{ position, width: tooltipWidth, height: tooltipHeight }
|
|
38
|
+
) => {
|
|
39
|
+
// the arrow width is actually a diagonal of the rectangle that we'll use as a tip
|
|
40
|
+
const rectangleSide = Math.sqrt((arrowWidth * arrowWidth) / 2)
|
|
41
|
+
|
|
42
|
+
// position the arrow at the side and center of the tooltip - this happens before rotation
|
|
43
|
+
// so we use the rectangle size as basis
|
|
44
|
+
const verticalOffset = (-1 * rectangleSide) / 2
|
|
45
|
+
const horizontalOffset = rectangleSide / 2
|
|
46
|
+
|
|
47
|
+
// percentage-based absolute positioning doesn't act well on native, so we have to
|
|
48
|
+
// calculate the pixel values
|
|
49
|
+
const directionalStyles = {
|
|
50
|
+
above: {
|
|
51
|
+
bottom: verticalOffset,
|
|
52
|
+
left: tooltipWidth / 2 - horizontalOffset,
|
|
53
|
+
transform: [{ rotateZ: '45deg' }]
|
|
54
|
+
},
|
|
55
|
+
below: {
|
|
56
|
+
top: verticalOffset,
|
|
57
|
+
left: tooltipWidth / 2 - horizontalOffset,
|
|
58
|
+
transform: [{ rotateZ: '-135deg' }]
|
|
59
|
+
},
|
|
60
|
+
left: {
|
|
61
|
+
right: verticalOffset,
|
|
62
|
+
top: tooltipHeight / 2 - horizontalOffset,
|
|
63
|
+
transform: [{ rotateZ: '-45deg' }]
|
|
64
|
+
},
|
|
65
|
+
right: {
|
|
66
|
+
left: verticalOffset,
|
|
67
|
+
top: tooltipHeight / 2 - horizontalOffset,
|
|
68
|
+
transform: [{ rotateZ: '135deg' }]
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
return {
|
|
73
|
+
backgroundColor,
|
|
74
|
+
width: rectangleSide,
|
|
75
|
+
height: rectangleSide,
|
|
76
|
+
borderBottomRightRadius: arrowBorderRadius, // this corner will be the arrow tip after rotation
|
|
77
|
+
...applyShadowToken(shadow),
|
|
78
|
+
...directionalStyles[position]
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
const selectTextStyles = (tokens) => applyTextStyles(selectTokens('Typography', tokens))
|
|
83
|
+
const defaultControl = (pressableState, variant) => (
|
|
84
|
+
<TooltipButton pressableState={pressableState} variant={variant} />
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Tooltip provides a descriptive and detailed explanation or instructions. It can be used next to an input label
|
|
89
|
+
* to help a user fill it in, or as a standalone component.
|
|
90
|
+
*
|
|
91
|
+
* By default the TooltipButton component will be used as a control for triggering the tooltip, but you may attach
|
|
92
|
+
* a tooltip to any other component. A render function can be used to adjust the control's styling on state changes (hover, focus, etc.).
|
|
93
|
+
*
|
|
94
|
+
* ### Positioning
|
|
95
|
+
* By default a Tooltip will be automatically positioned in a way that ensures it fits within the viewport.
|
|
96
|
+
* You may suggest a position with a prop - it will be used, unless the tooltip would end up outside the viewport.
|
|
97
|
+
*
|
|
98
|
+
* ### Usage criteria
|
|
99
|
+
* - You may use one when the information is useful only to a small percentage of users (ie. tech savvy people wouldn't need this info).
|
|
100
|
+
* - Tooltips may also be useful when vertical space is an issue.
|
|
101
|
+
*/
|
|
102
|
+
const Tooltip = ({ children, content, position = 'auto', copy = 'en', tokens, variant }) => {
|
|
103
|
+
const [isOpen, setIsOpen] = useState(false)
|
|
104
|
+
|
|
105
|
+
const controlRef = useRef()
|
|
106
|
+
const [controlLayout, setControlLayout] = useState(null)
|
|
107
|
+
const [tooltipDimensions, setTooltipDimensions] = useState(null)
|
|
108
|
+
const [windowDimensions, setWindowDimensions] = useState(Dimensions.get('window'))
|
|
109
|
+
const [tooltipPosition, setTooltipPosition] = useState(null)
|
|
110
|
+
|
|
111
|
+
const getCopy = useCopy({ dictionary, copy })
|
|
112
|
+
const themeTokens = useThemeTokens('Tooltip', tokens, variant)
|
|
113
|
+
|
|
114
|
+
const { arrowWidth, arrowOffset } = themeTokens
|
|
115
|
+
|
|
116
|
+
useEffect(() => {
|
|
117
|
+
const subscription = Dimensions.addEventListener('change', ({ window }) => {
|
|
118
|
+
setWindowDimensions(window)
|
|
119
|
+
})
|
|
120
|
+
|
|
121
|
+
return () => subscription?.remove()
|
|
122
|
+
})
|
|
123
|
+
|
|
124
|
+
const toggleIsOpen = () => setIsOpen(!isOpen)
|
|
125
|
+
const close = () => setIsOpen(false)
|
|
126
|
+
|
|
127
|
+
const getPressableState = ({ pressed, hovered, focused }) => ({
|
|
128
|
+
pressed,
|
|
129
|
+
hover: hovered,
|
|
130
|
+
focus: focused
|
|
131
|
+
})
|
|
132
|
+
|
|
133
|
+
const onTooltipLayout = ({
|
|
134
|
+
nativeEvent: {
|
|
135
|
+
layout: { width, height }
|
|
136
|
+
}
|
|
137
|
+
}) => {
|
|
138
|
+
if (
|
|
139
|
+
tooltipDimensions === null ||
|
|
140
|
+
tooltipDimensions.width !== width ||
|
|
141
|
+
tooltipDimensions.height !== height
|
|
142
|
+
) {
|
|
143
|
+
setTooltipDimensions({
|
|
144
|
+
width: Platform.select({
|
|
145
|
+
web: width + 0.3, // avoids often unnecessary line breaks due to subpixel rendering of fonts
|
|
146
|
+
native: width
|
|
147
|
+
}),
|
|
148
|
+
height
|
|
149
|
+
})
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
useEffect(() => {
|
|
154
|
+
if (isOpen) {
|
|
155
|
+
controlRef.current.measureInWindow((x, y, width, height) => {
|
|
156
|
+
setControlLayout({ x, y, width, height })
|
|
157
|
+
})
|
|
158
|
+
} else {
|
|
159
|
+
setControlLayout(null)
|
|
160
|
+
setTooltipDimensions(null)
|
|
161
|
+
setTooltipPosition(null)
|
|
162
|
+
}
|
|
163
|
+
}, [isOpen])
|
|
164
|
+
|
|
165
|
+
useEffect(() => {
|
|
166
|
+
setIsOpen(false)
|
|
167
|
+
}, [windowDimensions])
|
|
168
|
+
|
|
169
|
+
useEffect(() => {
|
|
170
|
+
if (
|
|
171
|
+
(tooltipPosition !== null && !tooltipPosition?.isNormalized) ||
|
|
172
|
+
!isOpen ||
|
|
173
|
+
controlLayout === null ||
|
|
174
|
+
tooltipDimensions == null
|
|
175
|
+
) {
|
|
176
|
+
return
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
const updatedPosition = getTooltipPosition(position, {
|
|
180
|
+
controlLayout,
|
|
181
|
+
tooltipDimensions,
|
|
182
|
+
windowDimensions,
|
|
183
|
+
arrowWidth,
|
|
184
|
+
arrowOffset
|
|
185
|
+
})
|
|
186
|
+
|
|
187
|
+
// avoid ending up in an infinite normalization loop
|
|
188
|
+
if (tooltipPosition?.isNormalized && updatedPosition.isNormalized) {
|
|
189
|
+
return
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
setTooltipPosition(updatedPosition)
|
|
193
|
+
}, [
|
|
194
|
+
isOpen,
|
|
195
|
+
position,
|
|
196
|
+
tooltipDimensions,
|
|
197
|
+
controlLayout,
|
|
198
|
+
windowDimensions,
|
|
199
|
+
arrowWidth,
|
|
200
|
+
arrowOffset,
|
|
201
|
+
tooltipPosition
|
|
202
|
+
])
|
|
203
|
+
|
|
204
|
+
const control = children !== undefined ? children : defaultControl
|
|
205
|
+
const pressableStyles =
|
|
206
|
+
control === defaultControl ? Platform.select({ web: { outline: 'none' } }) : undefined
|
|
207
|
+
const pressableHitSlop =
|
|
208
|
+
control === defaultControl ? { top: 10, bottom: 10, left: 10, right: 10 } : undefined
|
|
209
|
+
|
|
210
|
+
return (
|
|
211
|
+
<View style={staticStyles.container}>
|
|
212
|
+
<Pressable
|
|
213
|
+
onPress={toggleIsOpen}
|
|
214
|
+
ref={controlRef}
|
|
215
|
+
onBlur={close}
|
|
216
|
+
style={pressableStyles}
|
|
217
|
+
hitSlop={pressableHitSlop}
|
|
218
|
+
accessibilityLabel={getCopy('a11yText')}
|
|
219
|
+
accessibilityRole="button"
|
|
220
|
+
>
|
|
221
|
+
{typeof control === 'function'
|
|
222
|
+
? (pressableState) => control(getPressableState(pressableState), variant)
|
|
223
|
+
: control}
|
|
224
|
+
</Pressable>
|
|
225
|
+
{isOpen && (
|
|
226
|
+
<Backdrop onPress={close}>
|
|
227
|
+
<View
|
|
228
|
+
style={[
|
|
229
|
+
staticStyles.tooltip,
|
|
230
|
+
selectTooltipShadowStyles(themeTokens), // applied separately so that it doesn't cover the arrow
|
|
231
|
+
tooltipPosition && selectTooltipPositionStyles(tooltipPosition),
|
|
232
|
+
(tooltipPosition === null || tooltipPosition?.isNormalized) &&
|
|
233
|
+
staticStyles.tooltipHidden // visually hide the tooltip until we have a final measurement
|
|
234
|
+
]}
|
|
235
|
+
onLayout={onTooltipLayout}
|
|
236
|
+
accessibilityRole="alert"
|
|
237
|
+
>
|
|
238
|
+
<View
|
|
239
|
+
style={[
|
|
240
|
+
staticStyles.arrow,
|
|
241
|
+
tooltipPosition && selectArrowStyles(themeTokens, tooltipPosition)
|
|
242
|
+
]}
|
|
243
|
+
/>
|
|
244
|
+
<View style={selectTooltipStyles(themeTokens)}>
|
|
245
|
+
<Text style={selectTextStyles(themeTokens)}>{content}</Text>
|
|
246
|
+
</View>
|
|
247
|
+
</View>
|
|
248
|
+
</Backdrop>
|
|
249
|
+
)}
|
|
250
|
+
</View>
|
|
251
|
+
)
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
Tooltip.propTypes = {
|
|
255
|
+
/**
|
|
256
|
+
* Used to render the control (i.e. tooltip trigger). If a render function is used it will receive the
|
|
257
|
+
* pressable state and tooltip variant as an argument.
|
|
258
|
+
*/
|
|
259
|
+
children: PropTypes.oneOfType([PropTypes.func, PropTypes.node]),
|
|
260
|
+
/**
|
|
261
|
+
* The message. Can be raw text or text components.
|
|
262
|
+
*/
|
|
263
|
+
content: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
|
|
264
|
+
/**
|
|
265
|
+
* Select english or french copy for the accessible label.
|
|
266
|
+
*/
|
|
267
|
+
copy: PropTypes.oneOf(['en', 'fr']),
|
|
268
|
+
/**
|
|
269
|
+
* Use to place the tooltip in a specific location (only if it fits within viewport).
|
|
270
|
+
*/
|
|
271
|
+
position: PropTypes.oneOf(['auto', 'above', 'right', 'below', 'left']),
|
|
272
|
+
tokens: getTokensPropType('Tooltip'),
|
|
273
|
+
variant: variantProp.propType
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
export default Tooltip
|
|
277
|
+
|
|
278
|
+
const staticStyles = StyleSheet.create({
|
|
279
|
+
container: {
|
|
280
|
+
alignItems: 'flex-start'
|
|
281
|
+
},
|
|
282
|
+
tooltip: {
|
|
283
|
+
position: 'absolute',
|
|
284
|
+
maxWidth: 240,
|
|
285
|
+
top: 0,
|
|
286
|
+
left: 0
|
|
287
|
+
},
|
|
288
|
+
tooltipHidden: {
|
|
289
|
+
opacity: 0
|
|
290
|
+
},
|
|
291
|
+
arrow: {
|
|
292
|
+
position: 'absolute'
|
|
293
|
+
}
|
|
294
|
+
})
|