@telus-uds/components-base 0.0.2-prerelease.4 → 0.0.2-prerelease.5

package/src/StackView/StackView.jsx

@@ -0,0 +1,103 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+import { View } from 'react-native'
+
+import Divider from '../Divider'
+import { spacingProps, a11yProps } from '../utils'
+import { useThemeTokens } from '../ThemeProvider'
+import getStackedContent from './getStackedContent'
+import { staticStyles, selectFlexStyles } from './common'
+
+/**
+ * StackView evenly spaces its children, by default placing `Spacer` components between them.
+ *
+ * ## Spacing
+ *
+ * StackView takes the same spacing props as `Spacer` and passes them directly to the layout components
+ * it uses for spacing.
+ *
+ * ## Direction
+ *
+ * Use `direction` to control how the children are stacked:
+ *
+ * - `'column'` (default) stacks and spaces the children vertically.
+ * - `'row'` stacks and spaces the children horizontally.
+ * - `'column-reverse'` acts the same as `'column'`, but reverses the direction.
+ * - `'row-reverse'` acts the same as `'row'`, but reverses the direction.
+ *
+ * ## Theming, alignment and justification
+ *
+ * `StackView` is a pure layout component and has no theme styles beyond a small set of layout styles
+ * (`alignItems`, `justifyContent`, `flexGrow`) which may be set using the `tokens` prop.
+ *
+ * All other styling such as borders, background colours, padding etc should be applied by wrapping
+ * the `StackView` in other components. For example, a `StackView` may be the child of a `Card`.
+ *
+ * ## Separator options
+ *
+ * By default, StackView inserts a `<Spacer>` component between each rendered child.
+ *
+ * With the `divider` prop, it instead renders a `Divider` instead of a `Spacer`. The gap between
+ * items will be double what it would be without this prop plus the width of the divider.
+ *
+ * ## Accessibility
+ *
+ * `StackView` may take any React Native accessibility props and applies them to the outer `View`.
+ * It applies no accessibility props of its own, unless `divider` prop is passed (`Divider` has a
+ * semantic role but only on web, not within native apps).
+ */
+const StackView = ({
+  space = 1,
+  divider,
+  direction = 'column',
+  inherit,
+  children,
+  variant,
+  tokens,
+  ...rest
+}) => {
+  const a11y = a11yProps.select({ ...rest })
+  const content = getStackedContent(children, { direction, divider, space })
+  const themeTokens = useThemeTokens('StackView', tokens, variant)
+  const flexStyles = selectFlexStyles(themeTokens)
+
+  return inherit ? (
+    content
+  ) : (
+    <View {...a11y} style={[flexStyles, staticStyles[direction]]}>
+      {content}
+    </View>
+  )
+}
+
+StackView.propTypes = {
+  ...a11yProps.propTypes,
+  /**
+   * Sets the `flexDirection` of the container and, if `divider` is used, gives the Divider the appropriate direction.
+   */
+  direction: PropTypes.oneOf(['column', 'row', 'column-reverse', 'row-reverse']),
+  /**
+   * If true, renders a UDS `Divider` component between each item. If an object is passed,
+   * this object is passes as props to each Divider.
+   */
+  divider: PropTypes.oneOfType([PropTypes.bool, PropTypes.shape(Divider.propTypes)]),
+  /**
+   * If true, does not render any container and returns an array of spaced children, inheriting
+   * flex styles from the StackView's parent. That parent must have a `flexDirection` style corresponding
+   * to the StackView's `direction` prop for `divider` prop to behave correctly.
+   */
+  inherit: PropTypes.bool,
+  /**
+   * The size of the spacer according to the theme's spacing scale.
+   * Either a number corresponding to a position on the theme's spacing scale (1 is smallest, 2 is second smallest, etc),
+   * or, a SpacingObject with viewport keys and options (see `useSpacingScale` for details).
+   */
+  space: spacingProps.types.spacingValue,
+  /**
+   * A StackView may take any children, but will have no effect if it is only passed one child or is passed children
+   * wrapped in a component. If necessary, children may be wrapped in one React Fragment.
+   */
+  children: PropTypes.node
+}
+
+export default StackView

package/src/StackView/StackWrap.jsx

@@ -0,0 +1,33 @@
+import React from 'react'
+
+import StackWrapBox from './StackWrapBox'
+import StackWrapGap from './StackWrapGap'
+
+// CSS.supports needs an example of the type of value you intend to use.
+// Will be an integer appended `px` after hooks and JSX styles are resolved.
+const exampleGapValue = '1px'
+
+/**
+ * StackWrap is an alternative to StackView where the spaced items are allowed to wrap.
+ *
+ * As well as providing space between the items, StackWrap provides `gap` space between
+ * wrapped lines of items. By default, this `gap` is the same as the gap between spaced items.
+ * If a different spacing is desired between wrapped lines, pass a spacing value to the `gap` prop.
+ */
+const StackWrap = (props) => {
+  const { space } = props
+  // Don't apply separate gap if `null` or `undefined`, so can be unset in Storybook etc
+  // eslint-disable-next-line react/destructuring-assignment
+  const gap = props.gap ?? space
+
+  return gap === space && CSS?.supports('gap', exampleGapValue) ? (
+    // If possible, use the cleaner implementation that applies CSS `gap` styles to the container.
+    <StackWrapGap {...props} />
+  ) : (
+    // Else, use the fallback implementation which renders a `Box` component around each child.
+    <StackWrapBox {...props} />
+  )
+}
+StackWrap.propTypes = StackWrapBox.propTypes
+
+export default StackWrap

package/src/StackView/StackWrap.native.jsx

@@ -0,0 +1,4 @@
+import StackWrapBox from './StackWrapBox'
+
+// No support for CSS `gap` on React Native, so always use the fallback "box" implementation.
+export default StackWrapBox

package/src/StackView/StackWrapBox.jsx

@@ -0,0 +1,82 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+import { View } from 'react-native'
+
+import { spacingProps, a11yProps, useSpacingScale } from '../utils'
+import { useThemeTokens } from '../ThemeProvider'
+import getStackedContent from './getStackedContent'
+import { staticStyles, selectFlexStyles } from './common'
+
+const offsetSides = {
+  row: 'marginBottom',
+  column: 'marginRight'
+}
+
+const gapSides = {
+  row: 'bottom',
+  column: 'right'
+}
+
+const spaceSides = {
+  row: 'right',
+  column: 'bottom'
+}
+
+/**
+ * An alternative fallback implementation of `StackWrap` that doesn't use CSS `gap`.
+ *
+ * This is not intended to be used directly. It will automatically be used instead of StackWrap in:
+ *
+ * - Native apps (no `gap` style prop in React Native).
+ * - Older (~<=2020) browsers which don't support CSS `gap`.
+ * - Cases where the `space` between items should be different to the `gap` between wrapped rows .
+ *
+ * Unlike the cleaner and more side-effect-free CSS gap StackWrap implementation, this renders a Box (View)
+ * between the container and the stacked children, and requires a negative margin on the container.
+ */
+const StackWrapBox = ({
+  space = 1,
+  gap = space,
+  direction = 'row',
+  children,
+  tokens,
+  variant,
+  ...rest
+}) => {
+  const themeTokens = useThemeTokens('StackView', tokens, variant)
+  const flexStyles = selectFlexStyles(themeTokens)
+  const a11y = a11yProps.select({ ...rest })
+
+  // Mimic CSS `gap` using box spacing on the side after a wrapped row then offsetting it on the last row.
+  const gapSize = useSpacingScale(gap)
+  const offsetStyle = { [offsetSides[direction]]: -1 * gapSize }
+  const boxProps = { [gapSides[direction]]: gap, [spaceSides[direction]]: space }
+  const content = getStackedContent(children, { direction, space: 0, box: boxProps })
+
+  return (
+    <View {...a11y} style={[flexStyles, staticStyles.wrap, staticStyles[direction], offsetStyle]}>
+      {content}
+    </View>
+  )
+}
+
+StackWrapBox.propTypes = {
+  ...a11yProps.propTypes,
+  /**
+   * Sets the `flexDirection` of the container, or if 'inherit' returns spaced children as an array.
+   */
+  direction: PropTypes.oneOf(['column', 'row']),
+  /**
+   * The size of the spacer according to the theme's spacing scale.
+   * Either a number corresponding to a position on the theme's spacing scale (1 is smallest, 2 is second smallest, etc),
+   * or, a SpacingObject with viewport keys and options (see `useSpacingScale` for details).
+   */
+  space: spacingProps.types.spacingValue,
+  /**
+   * A StackWrap may take any children, but will have no effect if it is only passed one child or is passed children
+   * wrapped in a component. If necessary, children may be wrapped in one React Fragment.
+   */
+  children: PropTypes.node
+}
+
+export default StackWrapBox

package/src/StackView/StackWrapGap.jsx

@@ -0,0 +1,39 @@
+import React from 'react'
+import { View } from 'react-native'
+
+import StackWrapBox from './StackWrapBox'
+import { a11yProps, useSpacingScale } from '../utils'
+import { useThemeTokens } from '../ThemeProvider'
+import getStackedContent from './getStackedContent'
+import { staticStyles, selectFlexStyles } from './common'
+
+/**
+ * The primary implementation of StackWrap.
+ *
+ * This is not intended to be used directly. It will automatically be used instead of StackWrap if:
+ *
+ * - On web, and,
+ * - On a browser that supports CSS `gap` (most browser versions from 2020 onwards), and,
+ * - The `space` between items is the same as the `gap` between wrapped rows (this is the
+ *   default if `gap` prop is undefined)
+ */
+const StackWrapGap = ({ space = 1, tokens, variant, direction = 'row', children, ...rest }) => {
+  const themeTokens = useThemeTokens('StackView', tokens, variant)
+  const flexStyles = selectFlexStyles(themeTokens)
+  const a11y = a11yProps.select({ ...rest })
+
+  const size = useSpacingScale(space)
+  const gapStyle = { gap: size }
+
+  const content = getStackedContent(children, { direction, space: 0 })
+
+  return (
+    <View {...a11y} style={[flexStyles, staticStyles.wrap, staticStyles[direction], gapStyle]}>
+      {content}
+    </View>
+  )
+}
+
+StackWrapGap.propTypes = StackWrapBox.propTypes
+
+export default StackWrapGap

package/src/StackView/common.jsx

@@ -0,0 +1,28 @@
+import { StyleSheet } from 'react-native'
+
+export const selectFlexStyles = ({ alignItems, justifyContent, flexGrow }) => ({
+  alignItems,
+  justifyContent,
+  flexGrow
+})
+
+export const staticStyles = StyleSheet.create({
+  wrap: {
+    flexShrink: 1,
+    flexWrap: 'wrap'
+  },
+  row: {
+    flexDirection: 'row'
+  },
+  'row-reverse': {
+    flexDirection: 'row-reverse'
+  },
+  column: {
+    // This is the React Native View default, but also it's very fundamental to the behaviour,
+    // so make it explicit and allow it to be tested for.
+    flexDirection: 'column'
+  },
+  'column-reverse': {
+    flexDirection: 'column-reverse'
+  }
+})

package/src/StackView/getStackedContent.jsx

@@ -0,0 +1,106 @@
+import React, { Children, Fragment } from 'react'
+
+import Box from '../Box'
+import Divider from '../Divider'
+import Spacer from '../Spacer'
+
+/**
+ * @typedef {import('react').ReactChildren} ReactChildren
+ * @typedef {import('react').ReactElement} ReactElement
+ * @typedef {import('../utils/propTypes.js').SpacingValue} SpacingValue
+ */
+
+/**
+ * Takes valid React Children and inserts a specified amount of space between each valid (not nullish) top
+ * level element, according to the provided `options`.
+ *
+ * Returns an array of the original elements plus inserted spacing elements.
+ * This array of elements is keyed and may be used as a component's `children` without mapping.
+ *
+ * @param {ReactChildren} children
+ * @param {object} [options] -
+ *  - `space`: amount of space to insert using the theme spacing scale (see `useSpacingScale`)
+ *  - `direction`: if 'row' or 'row-reverse', applies space horizontally, if 'column' or 'column-reverse', applies space vertically
+ *  - `box`: if truthy, wraps each valid child in a Box component; if an object, passes it to Box as props
+ *  - `divider`: if truthy, inserts Divider components; if an object, passes it to Divider as props
+ * @param {SpacingValue} [options.space]
+ * @param {boolean | object} [options.divider]
+ * @param {"row" | "column" | "row-reverse" | "column-reverse"} [options.direction]
+ * @returns {ReactElement[]}
+ */
+const getStackedContent = (children, { divider, space, direction = 'column', box }) => {
+  const boxProps = box && typeof box === 'object' ? box : { space }
+  const dividerProps = divider && typeof divider === 'object' ? divider : {}
+
+  // Avoid surprises if children contains comments, nulls, or is a variable wrapped as a fragment
+  const validChildren = Children.toArray(unpackFragment(children)).filter(Boolean)
+  const content = validChildren.reduce((newChildren, child, index) => {
+    const boxID = `Stack-Box-${index}`
+    const item = box ? (
+      // If wrapped in Box, that Box needs a key.
+      // If possible, use an existing content key; use an index-based key only if necessary.
+      <Box {...boxProps} key={child.key || boxID} testID={boxID}>
+        {child}
+      </Box>
+    ) : (
+      child
+    )
+    if (!index || (!space && !divider)) return [...newChildren, item]
+
+    const testID = `Stack-${divider ? 'Divider' : 'Spacer'}-${index}`
+    const commonProps = { testID, key: testID, space }
+    const separator = divider ? (
+      <Divider vertical={direction.startsWith('row')} {...dividerProps} {...commonProps} />
+    ) : (
+      <Spacer direction={direction.startsWith('row') ? 'row' : 'column'} {...commonProps} />
+    )
+    return [...newChildren, separator, item]
+  }, [])
+
+  return content
+}
+
+/**
+ * Unpacks top-level fragments, so that common compositional patterns such as the following examples
+ * can be iterated as flat siblings (as if they were `<Child1 /><Child2 /><Child3 />`):
+ *
+ * - Setting `children` as a property wrapped in a fragment:
+ *
+ * ```jsx
+ * args.children = <><Child1 /><Child2 /><Child3 /></>
+ * ```
+ *
+ * - Defining `children` as a variable wrapped in a fragment:
+ *
+ * ```jsx
+ * const content = <><Child1 /><Child2 /><Child3 /></>
+ * if (someCondition) return <SomeWrapper>{content}</SomeWrapper>
+ * ```
+ *
+ * - Using fragments at the top level of a JSX block for conditional rendering:
+ *
+ * ```jsx
+ * <Child1 />
+ * {someCondition && (
+ *   <>
+ *     <Child2 />
+ *     <Child3 />
+ *   </>
+ * )}
+ * ```
+ *
+ * @param {ReactChildren} child
+ * @returns {ReactChildren}
+ */
+const unpackFragment = (child) => {
+  // If this level is a set of top-level siblings rather than one child, check each in turn
+  if (Children.count(child) > 1) return Children.map(child, unpackFragment)
+
+  // When a fragment is found, unpack its children to the top level and check them
+  if (child?.type === Fragment) return unpackFragment(child.props?.children)
+
+  // Stop unpacking as soon as any non-fragment child is found
+  return child
+}
+
+export default getStackedContent

package/src/StackView/index.js

@@ -0,0 +1,6 @@
+import StackView from './StackView'
+import StackWrap from './StackWrap'
+
+export default StackView
+export { StackWrap }
+export { default as getStackedContent } from './getStackedContent'