@telus-uds/components-base 1.8.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/CHANGELOG.md +13 -2
  2. package/package.json +4 -4
  3. package/.storybook/main.js +0 -11
  4. package/.storybook/preview.js +0 -37
  5. package/.turbo/turbo-build.log +0 -8
  6. package/.turbo/turbo-lint.log +0 -3
  7. package/CHANGELOG.json +0 -311
  8. package/__fixtures__/Accessible.js +0 -34
  9. package/__fixtures__/Accessible.native.js +0 -34
  10. package/__fixtures__/Theme.jsx +0 -13
  11. package/__fixtures__/Viewport.jsx +0 -17
  12. package/__fixtures__/test-utils.js +0 -25
  13. package/__fixtures__/testTheme.js +0 -1830
  14. package/__tests__/A11yText/A11yText.test.jsx +0 -34
  15. package/__tests__/ActivityIndicator/ActivityIndicator.test.jsx +0 -68
  16. package/__tests__/ActivityIndicator/__snapshots__/ActivityIndicator.test.jsx.snap +0 -287
  17. package/__tests__/Box/Box.test.jsx +0 -111
  18. package/__tests__/Button/Button.test.jsx +0 -86
  19. package/__tests__/Button/ButtonBase.test.jsx +0 -82
  20. package/__tests__/Button/ButtonGroup.test.jsx +0 -347
  21. package/__tests__/Button/ButtonLink.test.jsx +0 -61
  22. package/__tests__/Card/Card.test.jsx +0 -63
  23. package/__tests__/Checkbox/Checkbox.test.jsx +0 -94
  24. package/__tests__/Checkbox/CheckboxGroup.test.jsx +0 -246
  25. package/__tests__/Divider/Divider.test.jsx +0 -91
  26. package/__tests__/ExpandCollapse/ExpandCollapse.test.jsx +0 -109
  27. package/__tests__/Feedback/Feedback.test.jsx +0 -42
  28. package/__tests__/FlexGrid/Col.test.jsx +0 -261
  29. package/__tests__/FlexGrid/FlexGrid.test.jsx +0 -136
  30. package/__tests__/FlexGrid/Row.test.jsx +0 -273
  31. package/__tests__/HorizontalScroll/HorizontalScroll.test.jsx +0 -165
  32. package/__tests__/Icon/Icon.test.jsx +0 -61
  33. package/__tests__/IconButton/IconButton.test.jsx +0 -52
  34. package/__tests__/InputLabel/InputLabel.test.jsx +0 -28
  35. package/__tests__/InputLabel/__snapshots__/InputLabel.test.jsx.snap +0 -3
  36. package/__tests__/InputSupports/InputSupports.test.jsx +0 -60
  37. package/__tests__/Link/Link.test.jsx +0 -63
  38. package/__tests__/Link/TextButton.test.jsx +0 -35
  39. package/__tests__/List/List.test.jsx +0 -60
  40. package/__tests__/Modal/Modal.test.jsx +0 -47
  41. package/__tests__/Notification/Notification.test.jsx +0 -20
  42. package/__tests__/Pagination/Pagination.test.jsx +0 -160
  43. package/__tests__/Progress/Progress.test.jsx +0 -79
  44. package/__tests__/Radio/Radio.test.jsx +0 -87
  45. package/__tests__/Radio/RadioGroup.test.jsx +0 -220
  46. package/__tests__/RadioCard/RadioCard.test.jsx +0 -87
  47. package/__tests__/RadioCard/RadioCardGroup.test.jsx +0 -246
  48. package/__tests__/Search/Search.test.jsx +0 -73
  49. package/__tests__/Select/Select.test.jsx +0 -94
  50. package/__tests__/SideNav/SideNav.test.jsx +0 -110
  51. package/__tests__/Skeleton/Skeleton.test.jsx +0 -61
  52. package/__tests__/Spacer/Spacer.test.jsx +0 -63
  53. package/__tests__/StackView/StackView.test.jsx +0 -216
  54. package/__tests__/StackView/StackWrap.test.jsx +0 -47
  55. package/__tests__/StackView/getStackedContent.test.jsx +0 -295
  56. package/__tests__/StepTracker/StepTracker.test.jsx +0 -94
  57. package/__tests__/Tabs/Tabs.test.jsx +0 -40
  58. package/__tests__/Tags/Tags.test.jsx +0 -327
  59. package/__tests__/TextInput/TextArea.test.jsx +0 -35
  60. package/__tests__/TextInput/TextInputBase.test.jsx +0 -125
  61. package/__tests__/ThemeProvider/ThemeProvider.test.jsx +0 -77
  62. package/__tests__/ThemeProvider/useThemeTokens.test.jsx +0 -514
  63. package/__tests__/ThemeProvider/utils/theme-tokens.test.js +0 -41
  64. package/__tests__/ToggleSwitch/ToggleSwitch.test.jsx +0 -82
  65. package/__tests__/ToggleSwitch/ToggleSwitchGroup.test.jsx +0 -192
  66. package/__tests__/Tooltip/Tooltip.test.jsx +0 -65
  67. package/__tests__/Tooltip/getTooltipPosition.test.js +0 -79
  68. package/__tests__/Typography/typography.test.jsx +0 -90
  69. package/__tests__/utils/children.test.jsx +0 -128
  70. package/__tests__/utils/containUniqueFields.test.js +0 -25
  71. package/__tests__/utils/input.test.js +0 -375
  72. package/__tests__/utils/props.test.js +0 -36
  73. package/__tests__/utils/semantics.test.jsx +0 -34
  74. package/__tests__/utils/useCopy.test.js +0 -42
  75. package/__tests__/utils/useResponsiveProp.test.jsx +0 -202
  76. package/__tests__/utils/useSpacingScale.test.jsx +0 -273
  77. package/__tests__/utils/useUniqueId.test.js +0 -31
  78. package/babel.config.js +0 -35
  79. package/generate-component-docs.js +0 -72
  80. package/jest.config.js +0 -32
  81. package/stories/A11yText/A11yText.stories.jsx +0 -71
  82. package/stories/ActivityIndicator/ActivityIndicator.stories.jsx +0 -22
  83. package/stories/Box/Box.stories.jsx +0 -143
  84. package/stories/Button/Button.stories.jsx +0 -72
  85. package/stories/Button/ButtonGroup.stories.jsx +0 -81
  86. package/stories/Button/ButtonLink.stories.jsx +0 -30
  87. package/stories/Card/Card.stories.jsx +0 -62
  88. package/stories/Checkbox/Checkbox.stories.jsx +0 -94
  89. package/stories/Divider/Divider.stories.jsx +0 -68
  90. package/stories/ExpandCollapse/ExpandCollapse.stories.jsx +0 -112
  91. package/stories/Feedback/Feedback.stories.jsx +0 -96
  92. package/stories/FlexGrid/01 FlexGrid.stories.jsx +0 -54
  93. package/stories/FlexGrid/02 Row.stories.jsx +0 -41
  94. package/stories/FlexGrid/03 Col.stories.jsx +0 -141
  95. package/stories/Icon/Icon.stories.jsx +0 -79
  96. package/stories/IconButton/IconButton.stories.jsx +0 -50
  97. package/stories/InputLabel/InputLabel.stories.jsx +0 -39
  98. package/stories/Link/ChevronLink.stories.jsx +0 -48
  99. package/stories/Link/Link.stories.jsx +0 -90
  100. package/stories/Link/TextButton.stories.jsx +0 -79
  101. package/stories/List/List.stories.jsx +0 -117
  102. package/stories/Modal/Modal.stories.jsx +0 -54
  103. package/stories/Notification/Notification.stories.jsx +0 -82
  104. package/stories/Pagination/Pagination.stories.jsx +0 -64
  105. package/stories/Progress/Progress.stories.jsx +0 -93
  106. package/stories/Radio/Radio.stories.jsx +0 -100
  107. package/stories/RadioCard/RadioCard.stories.jsx +0 -98
  108. package/stories/Search/Search.stories.jsx +0 -66
  109. package/stories/Select/Select.stories.jsx +0 -55
  110. package/stories/SideNav/SideNav.stories.jsx +0 -42
  111. package/stories/SideNav/SideNavItem.stories.jsx +0 -9
  112. package/stories/SideNav/SideNavItemsGroup.stories.jsx +0 -17
  113. package/stories/Skeleton/Skeleton.stories.jsx +0 -36
  114. package/stories/Spacer/Spacer.stories.jsx +0 -38
  115. package/stories/StackView/StackView.stories.jsx +0 -75
  116. package/stories/StackView/StackWrap.stories.jsx +0 -64
  117. package/stories/StepTracker/StepTracker.stories.jsx +0 -71
  118. package/stories/Tabs/Tabs.stories.jsx +0 -98
  119. package/stories/Tags/Tags.stories.jsx +0 -69
  120. package/stories/TextInput/TextArea.stories.jsx +0 -101
  121. package/stories/TextInput/TextInput.stories.jsx +0 -141
  122. package/stories/ToggleSwitch/ToggleSwitch.stories.jsx +0 -64
  123. package/stories/ToggleSwitch/ToggleSwitchGroup.stories.jsx +0 -81
  124. package/stories/Tooltip/Tooltip.stories.jsx +0 -81
  125. package/stories/TooltipButton/TooltipButton.stories.jsx +0 -11
  126. package/stories/Typography/Typography.stories.jsx +0 -49
  127. package/stories/platform-supports.jsx +0 -32
  128. package/stories/platform-supports.native.jsx +0 -3
  129. package/stories/supports.jsx +0 -236
@@ -1,64 +0,0 @@
1
- /* eslint-disable react/no-multi-comp */
2
- import React, { useState } from 'react'
3
- import { View } from 'react-native'
4
- import { ToggleSwitch, Typography } from '../../src'
5
- import { Container, EachParentType, parentTypesParams } from '../supports'
6
-
7
- export const Default = (args) => <ToggleSwitch {...args} />
8
- Default.storyName = 'ToggleSwitch'
9
-
10
- export default {
11
- title: 'ToggleSwitch',
12
- component: ToggleSwitch,
13
- args: {
14
- label: 'Enable data',
15
- tooltip: 'Toggle this on to enable data'
16
- }
17
- }
18
-
19
- export const ToggleSwitchControlled = (args) => {
20
- // Simulate saving and retrieving data from a server
21
- const [isSaving, setIsSaving] = useState(false)
22
- const [currentValue, setValue] = useState(false)
23
- const handleChange = (newValue) => {
24
- setIsSaving(true)
25
- setTimeout(() => {
26
- setValue(newValue)
27
- setIsSaving(false)
28
- }, 400)
29
- }
30
- const text = isSaving ? 'Saving...' : 'Saved'
31
- return (
32
- <View>
33
- <Container padding={4} margin={0}>
34
- <Typography variant={{ size: 'small', colour: 'secondary' }}>{text}</Typography>
35
- </Container>
36
- <Container padding={4} margin={0}>
37
- <ToggleSwitch {...args} value={currentValue} onChange={handleChange} inactive={isSaving} />
38
- </Container>
39
- </View>
40
- )
41
- }
42
-
43
- export const ToggleSwitchInactive = (args) => (
44
- <>
45
- <Container>
46
- <ToggleSwitch {...args} inactive />
47
- </Container>
48
- <Container>
49
- <ToggleSwitch {...args} inactive value={true} />
50
- </Container>
51
- </>
52
- )
53
-
54
- export const ParentTypes = (args) => (
55
- <EachParentType componentThemeName="ToggleSwitch" {...args}>
56
- {({ label, variant }) => (
57
- <>
58
- <Typography>{`${label} `}</Typography>
59
- <ToggleSwitch {...args} variant={variant} />
60
- </>
61
- )}
62
- </EachParentType>
63
- )
64
- ParentTypes.parameters = parentTypesParams
@@ -1,81 +0,0 @@
1
- /* eslint-disable react/no-multi-comp */
2
- import React, { useState } from 'react'
3
- import { View } from 'react-native'
4
- import { ToggleSwitchGroup, Typography } from '../../src'
5
- import { Container } from '../supports'
6
-
7
- const defaultArgs = {
8
- items: [
9
- { label: 'First item', id: 'first' },
10
- { label: 'Second item', id: 'second' },
11
- { label: 'Third item', id: 'third' },
12
- { label: 'Fourth item', id: 'fourth' },
13
- { label: 'Fifth item', id: 'fifth' },
14
- { label: 'Sixth item', id: 'sixth' }
15
- ],
16
- initialValues: ['second', 'fourth']
17
- }
18
- const defaultControlledArgs = {
19
- ...defaultArgs,
20
- values: defaultArgs.initialValues,
21
- initialValues: undefined
22
- }
23
-
24
- export default {
25
- title: 'ToggleSwitchGroup',
26
- component: ToggleSwitchGroup,
27
- args: {
28
- ...defaultArgs
29
- }
30
- }
31
-
32
- const UncontrolledTemplate = (args) => <ToggleSwitchGroup {...args} />
33
- UncontrolledTemplate.propTypes = ToggleSwitchGroup.propTypes
34
-
35
- const ControlledTemplate = ({ values, ...args }) => {
36
- // Simulate saving and retrieving data from a server
37
- const [isSaving, setIsSaving] = useState(false)
38
- const [currentValues, setValues] = useState(values)
39
- const handleChange = (newValue) => {
40
- setIsSaving(true)
41
- setTimeout(() => {
42
- setValues(newValue)
43
- setIsSaving(false)
44
- }, 400)
45
- }
46
-
47
- const text = isSaving ? 'Saving...' : `Saved selected IDs: "${currentValues.join('", "')}".`
48
- return (
49
- <View>
50
- <Container padding={4} margin={0}>
51
- <Typography variant={{ size: 'small', colour: 'secondary' }}>{text}</Typography>
52
- </Container>
53
- <Container padding={4} margin={0}>
54
- <ToggleSwitchGroup {...args} values={currentValues} onChange={handleChange} />
55
- </Container>
56
- </View>
57
- )
58
- }
59
-
60
- ControlledTemplate.propTypes = ToggleSwitchGroup.propTypes
61
-
62
- export const Default = UncontrolledTemplate.bind({})
63
- Default.storyName = 'ToggleSwitchGroup'
64
-
65
- export const ToggleSwitchGroupMaxThree = UncontrolledTemplate.bind({})
66
- ToggleSwitchGroupMaxThree.args = { maxValues: 3 }
67
-
68
- export const ToggleSwitchGroupMaxUnlimited = UncontrolledTemplate.bind({})
69
- ToggleSwitchGroupMaxUnlimited.args = { maxValues: null }
70
-
71
- export const ToggleSwitchGroupControlled = ControlledTemplate.bind({})
72
- ToggleSwitchGroupControlled.args = { ...defaultControlledArgs }
73
-
74
- export const ToggleSwitchGroupControlledMaxThree = ControlledTemplate.bind({})
75
- ToggleSwitchGroupControlledMaxThree.args = { ...defaultControlledArgs, maxValues: 3 }
76
-
77
- export const ToggleSwitchGroupControlledMaxUnlimited = ControlledTemplate.bind({})
78
- ToggleSwitchGroupControlledMaxUnlimited.args = { ...defaultControlledArgs, maxValues: null }
79
-
80
- export const ToggleSwitchGroupInactive = UncontrolledTemplate.bind({})
81
- ToggleSwitchGroupInactive.args = { inactive: true }
@@ -1,81 +0,0 @@
1
- /* eslint-disable react-native/no-inline-styles */
2
- /* eslint-disable react/no-multi-comp */
3
- import React from 'react'
4
- import { View, Text } from 'react-native'
5
-
6
- import { Tooltip, Typography } from '../../src'
7
- import { Container } from '../supports'
8
-
9
- export default {
10
- title: 'Tooltip',
11
- component: Tooltip
12
- }
13
-
14
- const Template = (args) => <Tooltip {...args} />
15
-
16
- export const Default = Template.bind({})
17
- Default.args = {
18
- content: 'This is a tooltip'
19
- }
20
-
21
- export const Positioning = () => (
22
- <>
23
- <Typography>Here to preload the fonts</Typography>
24
- <Container>
25
- <Tooltip content="position is forced to left" position="left" />
26
- </Container>
27
- <Container>
28
- <Tooltip content="automatically positioned" />
29
- </Container>
30
- <Container>
31
- <View style={{ alignSelf: 'center', marginRight: 140 }}>
32
- <Tooltip content="position is forced to below" position="below" />
33
- </View>
34
- </Container>
35
- <Container>
36
- <View style={{ alignSelf: 'center' }}>
37
- <Tooltip
38
- content="(automatically positioned) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam
39
- luctus sapien in felis auctor commodo. Mauris sagittis, lorem eu rhoncus mattis, mi erat
40
- mollis lectus, in ornare"
41
- />
42
- </View>
43
- </Container>
44
- <Container>
45
- <View style={{ alignSelf: 'center', marginLeft: 140 }}>
46
- <Tooltip content="automatically positioned" />
47
- </View>
48
- </Container>
49
- <Container>
50
- <View style={{ alignSelf: 'flex-end' }}>
51
- <Tooltip content="automatically positioned automatically positioned" />
52
- </View>
53
- </Container>
54
- <Container>
55
- <View style={{ alignSelf: 'flex-end', marginTop: 500 }}>
56
- <Tooltip position="right" content="position is forced to right" />
57
- </View>
58
- </Container>
59
- </>
60
- )
61
-
62
- export const CustomControl = () => (
63
- <Tooltip content="Amazing 😍">
64
- <Text>Tooltip is applied to this text</Text>
65
- </Tooltip>
66
- )
67
-
68
- export const CustomControlFunction = () => (
69
- <Tooltip content="Tooltip content">
70
- {(pressableState, variant) => (
71
- <Text>
72
- Tooltip is applied to this text (state: {pressableState.hover ? 'hover' : 'default'},
73
- variant: {variant?.inverse ? 'inverse' : 'none'})
74
- </Text>
75
- )}
76
- </Tooltip>
77
- )
78
-
79
- export const ComponentsInContent = () => (
80
- <Tooltip content={<Typography tokens={{ color: 'white' }}>Typography in content</Typography>} />
81
- )
@@ -1,11 +0,0 @@
1
- import React from 'react'
2
-
3
- import { TooltipButton } from '../../src'
4
-
5
- export default {
6
- title: 'TooltipButton',
7
- component: TooltipButton
8
- }
9
-
10
- export const Default = () => <TooltipButton onPress={() => {}} />
11
- Default.storyName = 'TooltipButton'
@@ -1,49 +0,0 @@
1
- /* eslint-disable react/no-multi-comp */
2
- import React from 'react'
3
-
4
- import { useVariants, Container, EachParentType, parentTypesParams } from '../supports'
5
- import { Typography } from '../../src'
6
-
7
- export const Default = (args) => <Typography {...args} />
8
- Default.storyName = 'Typography'
9
-
10
- const defaultChildren = 'The quick brown fox jumps over the lazy dog'
11
-
12
- export default {
13
- title: 'Typography',
14
- component: Typography,
15
- args: {
16
- children: defaultChildren
17
- }
18
- }
19
-
20
- const VariantsTemplate = (args) => {
21
- const variants = useVariants('Typography')
22
- return variants.map(([key, value, label]) => (
23
- <Container key={`${key}:${value}`} padding={16} dark={key === 'inverse'}>
24
- <Typography {...args} variant={{ [key]: value }}>
25
- {[`Typography ${label}. `, args.children]}
26
- </Typography>
27
- </Container>
28
- ))
29
- }
30
-
31
- export const TypographyVariants = VariantsTemplate.bind({})
32
- TypographyVariants.args = { children: '' }
33
-
34
- export const LongTextTypographyVariants = VariantsTemplate.bind({})
35
- LongTextTypographyVariants.args = {
36
- children: [
37
- // Can't use `` template string for multi line paragraph as line breaks get converted to <br>s
38
- 'A longer sample of text content for demonstrating this variant of the Typography component. ',
39
- 'This sample of text should span across two or more lines, depending on which variants are currently active, ',
40
- 'and what the current screen size is of the window in which this component is being shown.'
41
- ]
42
- }
43
-
44
- export const ParentTypes = (args) => (
45
- <EachParentType componentThemeName="Typography" {...args}>
46
- {({ label, variant }) => <Typography {...args} variant={variant}>{`${label}. `}</Typography>}
47
- </EachParentType>
48
- )
49
- ParentTypes.parameters = parentTypesParams
@@ -1,32 +0,0 @@
1
- /* eslint-disable react/no-unescaped-entities */
2
- /* eslint-disable react-native/no-inline-styles */
3
- /* eslint-disable react/no-multi-comp */
4
- /* eslint-disable import/prefer-default-export */
5
- import React from 'react'
6
- import PropTypes from 'prop-types'
7
- import { Typography } from '../src'
8
-
9
- const BlockDiv = ({ children }) => <div>{children}</div>
10
- BlockDiv.propTypes = { children: PropTypes.node }
11
-
12
- const InlineBlockDiv = ({ children }) => <div style={{ display: 'inline-block' }}>{children}</div>
13
- InlineBlockDiv.propTypes = { children: PropTypes.node }
14
-
15
- const FloatDiv = ({ children }) => (
16
- <div>
17
- <div style={{ float: 'right', maxWidth: '85%', marginLeft: '10px' }}>{children}</div>
18
- <Typography block>
19
- Some lengthy text in a paragraph with a block above it containing the components to test,
20
- where the block above it has the style "float: right" applied and no other styles, giving the
21
- block a minimised dynamic width positioned to the right hand side of it and this text
22
- element's mutual parent.
23
- </Typography>
24
- </div>
25
- )
26
- FloatDiv.propTypes = { children: PropTypes.node }
27
-
28
- export const containers = {
29
- BlockDiv,
30
- InlineBlockDiv,
31
- FloatDiv
32
- }
@@ -1,3 +0,0 @@
1
- /* eslint-disable import/prefer-default-export */
2
- // Add any native-only containers for use in the Expo app here
3
- export const containers = {}
@@ -1,236 +0,0 @@
1
- /* eslint-disable react/no-multi-comp */
2
- import React from 'react'
3
- import PropTypes from 'prop-types'
4
- import { Platform, ScrollView, Text, View, StyleSheet } from 'react-native'
5
-
6
- /* eslint-disable import/no-extraneous-dependencies */
7
- import * as alliumIcons from '@telus-uds/palette-allium/build/rn/icons'
8
- import * as koodoIcons from '@telus-uds/palette-koodo/build/rn/icons'
9
- import * as pmIcons from '@telus-uds/palette-public-mobile/build/rn/icons'
10
- /* eslint-enable import/no-extraneous-dependencies */
11
-
12
- import { useTheme, getComponentTheme } from '../src/ThemeProvider'
13
- import { Typography } from '../src'
14
- import { containers as platformContainers } from './platform-supports'
15
-
16
- const iconSets = {
17
- allium: alliumIcons,
18
- koodo: koodoIcons,
19
- publicMobile: pmIcons
20
- }
21
-
22
- const RowWrap = ({ children }) => <View style={styles.rowWrap}>{children}</View>
23
- RowWrap.propTypes = { children: PropTypes.node }
24
-
25
- const RowStretch = ({ children }) => (
26
- <ScrollView horizontal contentContainerStyle={styles.rowStretch}>
27
- {children}
28
- </ScrollView>
29
- )
30
- RowStretch.propTypes = { children: PropTypes.node }
31
-
32
- const ColumnWrap = ({ children }) => (
33
- <ScrollView
34
- horizontal
35
- style={styles.columnWrapContainer}
36
- contentContainerStyle={styles.columnWrap}
37
- >
38
- {children}
39
- </ScrollView>
40
- )
41
- ColumnWrap.propTypes = { children: PropTypes.node }
42
-
43
- const ColumnStretch = ({ children }) => (
44
- <View containerStyle={styles.columnStretch}>{children}</View>
45
- )
46
- ColumnStretch.propTypes = { children: PropTypes.node }
47
-
48
- // TODO: find a way to give Base stories a complete empty SpacingObject for easy editting
49
- // while giving themed stories a simpler value.
50
- export const spacingObjectArg = { xs: 1, lg: 3 }
51
-
52
- export const parentTypes = {
53
- RowWrap,
54
- RowStretch,
55
- ColumnWrap,
56
- ColumnStretch,
57
- ...platformContainers
58
- }
59
-
60
- /**
61
- * React Native (and therefore also React Native Web) components are usually at some level based on
62
- * `View` and have some default layout styles that are quite different to regular web defaults:
63
- *
64
- * - `display: flex` instead of `display: block`
65
- * - `flexDirection: column` instead of `flexDirection: row` when flex
66
- * - `position: relative`
67
- *
68
- * It's easy to fall into the trap of developing and testing something that works fine in a regular
69
- * `View` but doesn't work as expected in other common layout containers. This is particularly true
70
- * for UDS where internally we are devleoping entirely within React Native but many real-world use cases
71
- * will mix UDS components with regular web HTML elements.
72
- *
73
- * The `EachParentType` support component and related `parentTypes` tooling are intended to make it easy
74
- * to routinely test and demonstrate how UDS components behave in a wide range of parent types.
75
- *
76
- * To use it, pass as `children` a render function that takes the following and places them appropriately
77
- * in a demonstration of your component (be careful to not wrap the component in a `View` or container as
78
- * that will defeat the point of the exercise!):
79
- *
80
- * - `variant` - each theme variant will be rendered as siblings, pass this to the component's `variant` prop.
81
- * - `label` - this will describe the parent type / variant combination and ideally should be somewhere easy to read
82
- * inside the component to help users understand what they are looking at.
83
- * - `index` - the index of the currently rendered component variant (`0` if the component has no variants).
84
- */
85
- export const EachParentType = ({ children, componentThemeName, ...args }) => {
86
- const variants = useVariants(componentThemeName)
87
- return Object.entries(parentTypes).map(([parentLabel, ParentType]) => (
88
- <Container key={parentLabel} offWhite>
89
- <ParentType>
90
- {variants.map(([key, value, variantLabel], index) => {
91
- const label = variantLabel ? `${parentLabel}: ${variantLabel}` : parentLabel
92
- const variant = { ...args.variant, [key]: value }
93
- return typeof children === 'function' ? children({ label, variant, index }) : children
94
- })}
95
- </ParentType>
96
- </Container>
97
- ))
98
- }
99
-
100
- const parentTypesList = `\`"${Object.keys(parentTypes).join('"`, `"')}"\``
101
-
102
- export const parentTypesParams = {
103
- docs: {
104
- storyDescription: `This tests how this component's variants render in each of the following types of container: ${parentTypesList}.`
105
- }
106
- }
107
-
108
- /**
109
- * Utility component that takes a render function as its child and runs it for each
110
- * icon entry in the RN build of the palette of the currently selected theme.
111
- *
112
- * If the theme isn't supported or named, it returns a message saying no icons found.
113
- */
114
- export const EachIcon = ({ children }) => {
115
- const theme = useTheme()
116
- const themeName = theme?.metadata?.name
117
- const iconSet = iconSets[themeName]
118
- return iconSet ? (
119
- Object.entries(iconSet).map((iconEntry) => children(iconEntry))
120
- ) : (
121
- <Text>{`No icons found for theme "${themeName}"`}</Text>
122
- )
123
- }
124
- EachIcon.propTypes = {
125
- children: PropTypes.func
126
- }
127
-
128
- export const Placeholder = ({ margin = false, ...props }) => (
129
- <View style={[styles.placeholder, margin && styles.margin]}>
130
- <Typography {...props} />
131
- </View>
132
- )
133
- Placeholder.propTypes = {
134
- margin: PropTypes.bool
135
- }
136
-
137
- export const Container = ({
138
- margin = 8,
139
- padding = 8,
140
- dark = false,
141
- offWhite = false,
142
- borderWidth,
143
- style,
144
- children
145
- }) => (
146
- <View
147
- style={[
148
- { margin, padding },
149
- dark && styles.dark,
150
- offWhite && styles.offWhite,
151
- { borderWidth },
152
- style
153
- ]}
154
- >
155
- {children}
156
- </View>
157
- )
158
- Container.propTypes = {
159
- margin: PropTypes.number,
160
- padding: PropTypes.number,
161
- borderWidth: PropTypes.number,
162
- dark: PropTypes.bool,
163
- offWhite: PropTypes.bool,
164
- style: PropTypes.object,
165
- children: PropTypes.node
166
- }
167
-
168
- const getVariantLabel = (key, value) => `${key}${typeof value === 'string' ? `: ${value}` : ''}`
169
- /**
170
- * For each "variant" appearance in a component theme, returns an array of
171
- * [key, value] tuple-like arrays for every value of every key
172
- */
173
- export const useVariants = (componentName) => {
174
- const theme = useTheme()
175
- if (!componentName) return [['default', {}]]
176
-
177
- const { appearances } = getComponentTheme(theme, componentName)
178
-
179
- if (!appearances) {
180
- throw new Error(
181
- `Theme ${theme.metadata?.name} does not have any appearances set for ${componentName}`
182
- )
183
- }
184
-
185
- const variants = Object.entries(appearances).reduce(
186
- (pairs, [key, { values, type } = {}]) =>
187
- type === 'variant'
188
- ? [...pairs, ...values.map((value) => [key, value, getVariantLabel(key, value)])]
189
- : pairs,
190
- [[undefined, undefined, 'default style']]
191
- )
192
- return variants
193
- }
194
-
195
- const styles = StyleSheet.create({
196
- rowWrap: {
197
- flexDirection: 'row',
198
- alignItems: 'flex-start',
199
- flexWrap: 'wrap',
200
- flex: 1
201
- },
202
- rowStretch: {
203
- flexDirection: 'row',
204
- flexGrow: 1
205
- },
206
- columnStretch: {
207
- // alignItems: 'stretch' and flexDirection: 'column' are the default
208
- },
209
- columnWrap: {
210
- flexDirection: 'column',
211
- alignItems: 'flex-start',
212
- flexWrap: 'wrap',
213
- // Ensure the content columns wrap
214
- ...Platform.select({ web: { maxHeight: 150 }, default: { height: 125, minWidth: '200%' } }),
215
- flexGrow: 1
216
- },
217
- content: {
218
- maxWidth: 200,
219
- paddingHorizontal: 16
220
- },
221
- placeholder: {
222
- padding: 16,
223
- textAlign: 'center',
224
- backgroundColor: '#f0f1ff',
225
- borderRadius: 2
226
- },
227
- margin: {
228
- marginVertical: 8
229
- },
230
- dark: {
231
- backgroundColor: 'rgb(35,35,35)'
232
- },
233
- offWhite: {
234
- backgroundColor: 'rgb(210,210,210)'
235
- }
236
- })