@telus-uds/components-base 0.0.2-prerelease.9 → 1.1.0

package/src/Box/Box.jsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import PropTypes from 'prop-types'
 import { View, ScrollView } from 'react-native'
 import { useThemeTokens } from '../ThemeProvider'
@@ -8,7 +8,9 @@ import {
   variantProp,
   getTokensPropType,
   useSpacingScale,
-  viewProps
+  viewProps,
+  getA11yPropsFromHtmlTag,
+  layoutTags
 } from '../utils'
 /**
  * @typedef {import('../utils/propTypes.js').SpacingValue} SpacingValue
@@ -94,63 +96,147 @@ const selectBoxStyles = (tokens) => {
  * text content is inside a scrollable box, as screens are not scrollable by default and even very
  * short text will require scrolling on small devices at the highest accessibility text scaling settings.
  */
-const Box = ({
-  space,
-  horizontal = space,
-  vertical = space,
-  top = vertical,
-  bottom = vertical,
-  left = horizontal,
-  right = horizontal,
-  children,
-  variant,
-  tokens,
-  scroll,
-  testID,
-  ...rest
-}) => {
-  const props = { ...a11yProps.select(rest), ...viewProps.select(rest) }
+const Box = forwardRef(
+  (
+    {
+      space,
+      horizontal = space,
+      vertical = space,
+      top = vertical,
+      bottom = vertical,
+      left = horizontal,
+      right = horizontal,
+      flex,
+      children,
+      variant,
+      tokens,
+      scroll,
+      tag,
+      accessibilityRole,
+      testID,
+      dataSet,
+      ...rest
+    },
+    ref
+  ) => {
+    const props = {
+      ...getA11yPropsFromHtmlTag(tag, accessibilityRole),
+      ...a11yProps.select(rest),
+      ...viewProps.select(rest)
+    }
 
-  const themeTokens = useThemeTokens('Box', tokens, variant)
-  const styles = {
-    paddingLeft: useSpacingScale(left),
-    paddingRight: useSpacingScale(right),
-    paddingTop: useSpacingScale(top),
-    paddingBottom: useSpacingScale(bottom),
-    ...selectBoxStyles(themeTokens)
-  }
+    const themeTokens = useThemeTokens('Box', tokens, variant)
+    const styles = {
+      flex,
+      paddingLeft: useSpacingScale(left),
+      paddingRight: useSpacingScale(right),
+      paddingTop: useSpacingScale(top),
+      paddingBottom: useSpacingScale(bottom),
+      ...selectBoxStyles(themeTokens)
+    }
 
-  if (scroll) {
-    const scrollProps = typeof scroll === 'object' ? scroll : {}
-    scrollProps.contentContainerStyle = [styles, scrollProps.contentContainerStyle]
+    if (scroll) {
+      const scrollProps = typeof scroll === 'object' ? scroll : {}
+      scrollProps.contentContainerStyle = [styles, scrollProps.contentContainerStyle]
+      return (
+        <ScrollView {...scrollProps} {...props} testID={testID} dataSet={dataSet} ref={ref}>
+          {children}
+        </ScrollView>
+      )
+    }
     return (
-      <ScrollView {...scrollProps} {...props} testID={testID}>
+      <View {...props} style={styles} testID={testID} dataSet={dataSet} ref={ref}>
         {children}
-      </ScrollView>
+      </View>
     )
   }
-  return (
-    <View {...props} style={styles} testID={testID}>
-      {children}
-    </View>
-  )
-}
+)
+Box.displayName = 'Box'
 
 Box.propTypes = {
+  ...a11yProps.propTypes,
+  ...viewProps.types,
+  variant: variantProp.propType,
+  tokens: getTokensPropType('Box'),
+  /**
+   * Sets default padding on all sides of the box using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   space: spacingProps.types.spacingValue,
+  /**
+   * Sets top and bottom padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   vertical: spacingProps.types.spacingValue,
+  /**
+   * Sets left and right padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   horizontal: spacingProps.types.spacingValue,
+  /**
+   * Sets bottom padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   bottom: spacingProps.types.spacingValue,
+  /**
+   * Sets left padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   left: spacingProps.types.spacingValue,
+  /**
+   * Sets right padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   right: spacingProps.types.spacingValue,
+  /**
+   * Sets top padding using the theme's spacing scale.
+   *
+   * @see {@link SpacingValue}
+   */
   top: spacingProps.types.spacingValue,
+  /**
+   * Sets the `flex` style, which controls `flexGrow`, `flexShrink` and `flexBasis` styles.
+   *
+   * Set as 1 for the box to stretch and grow to fit in the available space, or another number to share
+   * space disproportionately with siblings. See https://reactnative.dev/docs/flexbox#flex for details.
+   *
+   * With the default `0`, the box takes its minimum width from its content.
+   */
+  flex: PropTypes.number,
+  /**
+   * Renders a scrollable ScrollView instead of an unscrollable View.
+   *
+   * May take an object of ScrollView props which are passed to the rendered ScrollView.
+   */
   scroll: PropTypes.oneOfType([
     PropTypes.bool,
     ScrollView.propTypes ? PropTypes.shape(ScrollView.propTypes) : PropTypes.object
   ]),
-  variant: variantProp.propType,
-  tokens: getTokensPropType('Box'),
+  /**
+   * Optional semantic HTML tag, to apply to the container on web. Does not change styling.
+   *
+   * In native apps, if a header tag is provided ("h1", "h2" etc) and accessibilityRole prop
+   * is not defined, the accessibilityRole will default to "heading".
+   */
+  tag: PropTypes.oneOf(layoutTags),
+  /**
+   * Use in tests if the box itself needs to be targetted and no other way of selecting the
+   * box is available (e.g. it cannot be targetted using an appropriate `accessibilityRole`).
+   */
   testID: PropTypes.string,
+  /**
+   * @ignore
+   */
+  dataSet: PropTypes.object,
+  /**
+   * Box accepts any content as children.
+   */
   children: PropTypes.node.isRequired
 }
 

package/src/Button/Button.jsx

@@ -1,14 +1,17 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 
 import ButtonBase from './ButtonBase'
 import buttonPropTypes, { textAndA11yText } from './propTypes'
 import { useThemeTokensCallback } from '../ThemeProvider'
 import { a11yProps } from '../utils/propTypes'
 
-const Button = ({ accessibilityRole = 'button', tokens, variant, ...props }) => {
+const Button = forwardRef(({ accessibilityRole = 'button', tokens, variant, ...props }, ref) => {
   const getTokens = useThemeTokensCallback('Button', tokens, variant)
-  return <ButtonBase {...props} tokens={getTokens} accessibilityRole={accessibilityRole} />
-}
+  return (
+    <ButtonBase {...props} tokens={getTokens} accessibilityRole={accessibilityRole} ref={ref} />
+  )
+})
+Button.displayName = 'Button'
 
 Button.propTypes = {
   ...a11yProps.types,

package/src/Button/ButtonBase.jsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import { Pressable, View, StyleSheet, Platform } from 'react-native'
 
 import { applyTextStyles, applyShadowToken, applyOuterBorder } from '../ThemeProvider/utils'
@@ -130,83 +130,92 @@ const selectWebOnlyStyles = (inactive, themeTokens, { accessibilityRole }) => {
   })
 }
 
-const ButtonBase = ({
-  href,
-  hrefAttrs,
-  children,
-  onPress,
-  tokens = {},
-  disabled = false, // alias for inactive
-  inactive = disabled,
-  selected = false,
-  ...rest
-}) => {
-  const extraButtonState = { inactive, selected }
-  const resolveButtonTokens = (pressableState) =>
-    resolvePressableTokens(tokens, pressableState, extraButtonState)
-
-  const a11y = a11yProps.select(rest)
-
-  const getPressableStyle = (pressableState) => {
-    const themeTokens = resolveButtonTokens(pressableState)
-    return [
-      staticStyles.row,
-      selectWebOnlyStyles(inactive, themeTokens, a11y),
-      selectOuterContainerStyles(themeTokens),
-      selectOuterWidthStyles(themeTokens)
-    ]
-  }
+const ButtonBase = forwardRef(
+  (
+    {
+      href,
+      hrefAttrs,
+      children,
+      onPress,
+      tokens = {},
+      disabled = false, // alias for inactive
+      inactive = disabled,
+      selected = false,
+      dataSet,
+      ...rest
+    },
+    ref
+  ) => {
+    const extraButtonState = { inactive, selected }
+    const resolveButtonTokens = (pressableState) =>
+      resolvePressableTokens(tokens, pressableState, extraButtonState)
+
+    const a11y = a11yProps.select(rest)
+
+    const getPressableStyle = (pressableState) => {
+      const themeTokens = resolveButtonTokens(pressableState)
+      return [
+        staticStyles.row,
+        selectWebOnlyStyles(inactive, themeTokens, a11y),
+        selectOuterContainerStyles(themeTokens),
+        selectOuterWidthStyles(themeTokens)
+      ]
+    }
 
-  return (
-    <Pressable
-      href={href}
-      onPress={linkProps.handleHref({ href, onPress })}
-      style={getPressableStyle}
-      disabled={inactive}
-      hrefAttrs={hrefAttrs}
-      {...a11y}
-    >
-      {(pressableState) => {
-        const themeTokens = resolveButtonTokens(pressableState)
-        const containerStyles = selectInnerContainerStyles(themeTokens)
-        const borderStyles = selectBorderStyles(themeTokens)
-        const textStyles = [selectTextStyles(themeTokens), staticStyles.text]
-
-        // If the container has a width set, fill it instead of sizing from content.
-        // If in future we support text alignments other than center, add here.
-        const stretchStyles = themeTokens.width ? staticStyles.stretch : staticStyles.align
-
-        return (
-          <View
-            style={[
-              containerStyles,
-              borderStyles,
-              stretchStyles,
-              staticStyles.row,
-              Platform.select({
-                web: {
-                  maxWidth: '100%', // ensure overflowing content wraps
-                  // TODO: https://github.com/telus/universal-design-system/issues/487
-                  transition: 'background-color 200ms, border-color 200ms'
-                }
-              })
-            ]}
-          >
-            {wrapStringsInText(
-              typeof children === 'function'
-                ? children({
-                    ...resolvePressableState(pressableState, extraButtonState),
-                    textStyles
-                  })
-                : children,
-              { style: textStyles }
-            )}
-          </View>
-        )
-      }}
-    </Pressable>
-  )
-}
+    return (
+      <Pressable
+        ref={ref}
+        href={href}
+        onPress={linkProps.handleHref({ href, onPress })}
+        style={getPressableStyle}
+        disabled={inactive}
+        dataSet={dataSet}
+        hrefAttrs={hrefAttrs}
+        {...a11y}
+      >
+        {(pressableState) => {
+          const themeTokens = resolveButtonTokens(pressableState)
+          const containerStyles = selectInnerContainerStyles(themeTokens)
+          const borderStyles = selectBorderStyles(themeTokens)
+          const textStyles = [selectTextStyles(themeTokens), staticStyles.text]
+
+          // If the container has a width set, fill it instead of sizing from content.
+          // If in future we support text alignments other than center, add here.
+          const stretchStyles = themeTokens.width ? staticStyles.stretch : staticStyles.align
+
+          return (
+            <View
+              style={[
+                containerStyles,
+                borderStyles,
+                stretchStyles,
+                staticStyles.row,
+                Platform.select({
+                  web: {
+                    maxWidth: '100%', // ensure overflowing content wraps
+                    // TODO: https://github.com/telus/universal-design-system/issues/487
+                    transition: 'background-color 200ms, border-color 200ms'
+                  }
+                })
+              ]}
+            >
+              {wrapStringsInText(
+                typeof children === 'function'
+                  ? children({
+                      ...resolvePressableState(pressableState, extraButtonState),
+                      textStyles
+                    })
+                  : children,
+                { style: textStyles }
+              )}
+            </View>
+          )
+        }}
+      </Pressable>
+    )
+  }
+)
+ButtonBase.displayName = 'ButtonBase'
 
 ButtonBase.propTypes = {
   ...a11yProps.types,

package/src/Button/ButtonGroup.jsx

@@ -1,5 +1,6 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import PropTypes from 'prop-types'
+import ABBPropTypes from 'airbnb-prop-types'
 import { Platform } from 'react-native'
 
 import ButtonBase from './ButtonBase'
@@ -16,81 +17,88 @@ import {
 import { useMultipleInputValues } from '../utils/input'
 import { getPressHandlersWithArgs } from '../utils/pressability'
 
-const ButtonGroup = ({
-  variant,
-  tokens,
-  items = [],
-  values,
-  initialValues,
-  maxValues = 1,
-  onChange,
-  readOnly = false,
-  inactive = false,
-  accessibilityRole = maxValues === 1
-    ? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups
-    : Platform.select({ web: 'group', default: 'none' }),
-  ...rest
-}) => {
-  const viewport = useViewport()
-  const themeTokens = useThemeTokens('ButtonGroup', tokens, variant, { viewport })
-  const stackTokens = selectTokens('StackView', themeTokens)
-  const { direction, space } = themeTokens
+const ButtonGroup = forwardRef(
+  (
+    {
+      variant,
+      tokens,
+      items = [],
+      values,
+      initialValues,
+      maxValues = 1,
+      onChange,
+      readOnly = false,
+      inactive = false,
+      accessibilityRole = maxValues === 1
+        ? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups
+        : Platform.select({ web: 'group', default: 'none' }),
+      ...rest
+    },
+    ref
+  ) => {
+    const viewport = useViewport()
+    const themeTokens = useThemeTokens('ButtonGroup', tokens, variant, { viewport })
+    const stackTokens = selectTokens('StackView', themeTokens)
+    const { direction, space } = themeTokens
 
-  const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant)
+    const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant)
 
-  const { currentValues, toggleOneValue } = useMultipleInputValues({
-    initialValues,
-    values,
-    maxValues,
-    onChange,
-    readOnly
-  })
+    const { currentValues, toggleOneValue } = useMultipleInputValues({
+      initialValues,
+      values,
+      maxValues,
+      onChange,
+      readOnly
+    })
 
-  const a11y = a11yProps.select({
-    accessibilityRole,
-    ...rest
-  })
-  const itemA11yRole = a11y.accessibilityRole === 'radiogroup' ? 'radio' : 'checkbox'
+    const a11y = a11yProps.select({
+      accessibilityRole,
+      ...rest
+    })
+    const itemA11yRole = a11y.accessibilityRole === 'radiogroup' ? 'radio' : 'checkbox'
 
-  return (
-    <StackWrap {...a11y} space={space} direction={direction} tokens={stackTokens}>
-      {items.map(({ label, id = label, accessibilityLabel }, index) => {
-        const isSelected = currentValues.includes(id)
+    return (
+      <StackWrap {...a11y} space={space} direction={direction} tokens={stackTokens} ref={ref}>
+        {items.map(({ label, id = label, accessibilityLabel, ref: itemRef }, index) => {
+          const isSelected = currentValues.includes(id)
 
-        // Pass an object of relevant component state as first argument for any passed-in press handlers
-        const pressHandlers = getPressHandlersWithArgs(rest, [{ id, label, currentValues }])
+          // Pass an object of relevant component state as first argument for any passed-in press handlers
+          const pressHandlers = getPressHandlersWithArgs(rest, [{ id, label, currentValues }])
 
-        const handlePress = () => {
-          if (pressHandlers.onPress) pressHandlers.onPress()
-          toggleOneValue(id)
-        }
+          const handlePress = (event) => {
+            if (pressHandlers.onPress) pressHandlers.onPress()
+            toggleOneValue(id, event)
+          }
 
-        const itemA11y = {
-          accessibilityState: { checked: isSelected },
-          accessibilityRole: itemA11yRole,
-          accessibilityLabel,
-          ...a11yProps.getPositionInSet(items.length, index)
-        }
+          const itemA11y = {
+            accessibilityState: { checked: isSelected },
+            accessibilityRole: itemA11yRole,
+            accessibilityLabel,
+            ...a11yProps.getPositionInSet(items.length, index)
+          }
 
-        // Ensure button is direct child of group as MacOS voiceover only applies "X of Y" to
-        // "radio" if it's a direct child of "radiogroup", even if aria-posinset etc exists
-        return (
-          <ButtonBase
-            key={id}
-            {...pressHandlers}
-            onPress={handlePress}
-            tokens={getButtonTokens}
-            selected={isSelected}
-            inactive={inactive}
-            {...itemA11y}
-          >
-            {label}
-          </ButtonBase>
-        )
-      })}
-    </StackWrap>
-  )
-}
+          // Ensure button is direct child of group as MacOS voiceover only applies "X of Y" to
+          // "radio" if it's a direct child of "radiogroup", even if aria-posinset etc exists
+          return (
+            <ButtonBase
+              ref={itemRef}
+              key={id}
+              {...pressHandlers}
+              onPress={handlePress}
+              tokens={getButtonTokens}
+              selected={isSelected}
+              inactive={inactive}
+              {...itemA11y}
+            >
+              {label}
+            </ButtonBase>
+          )
+        })}
+      </StackWrap>
+    )
+  }
+)
+ButtonGroup.displayName = 'ButtonGroup'
 
 ButtonGroup.propTypes = {
   ...a11yProps.propTypes,
@@ -122,7 +130,11 @@ ButtonGroup.propTypes = {
        * which will be used in code and passed to any onChange function.
        * If not provided, the label is used.
        */
-      id: PropTypes.string
+      id: PropTypes.string,
+      /**
+       * An optional ref for one individual button in the ButtonGroup
+       */
+      ref: ABBPropTypes.ref()
     })
   ),
   /**

package/src/Button/ButtonLink.jsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import ButtonBase from './ButtonBase'
 import buttonPropTypes, { textAndA11yText } from './propTypes'
 import { a11yProps, hrefAttrsProp, linkProps } from '../utils/propTypes'
@@ -8,18 +8,23 @@ import { useThemeTokensCallback } from '../ThemeProvider'
  * `ButtonLink` is a component with the semantics and behaviour of a link, but with the visual appearance of a button.
  * ButtonLink is a block-level component and should not be used inline.
  */
-const ButtonLink = ({ accessibilityRole = 'link', tokens, variant, ...props }) => {
-  const { hrefAttrs, rest } = hrefAttrsProp.bundle(props)
-  const getTokens = useThemeTokensCallback('Button', tokens, variant)
-  return (
-    <ButtonBase
-      accessibilityRole={accessibilityRole}
-      tokens={getTokens}
-      hrefAttrs={hrefAttrs}
-      {...rest}
-    />
-  )
-}
+const ButtonLink = forwardRef(
+  ({ accessibilityRole = 'link', tokens, variant, dataSet, ...props }, ref) => {
+    const { hrefAttrs, rest } = hrefAttrsProp.bundle(props)
+    const getTokens = useThemeTokensCallback('Button', tokens, variant)
+    return (
+      <ButtonBase
+        ref={ref}
+        accessibilityRole={accessibilityRole}
+        tokens={getTokens}
+        hrefAttrs={hrefAttrs}
+        dataSet={dataSet}
+        {...rest}
+      />
+    )
+  }
+)
+ButtonLink.displayName = 'ButtonLink'
 
 ButtonLink.propTypes = {
   ...a11yProps.types,

package/src/Card/Card.jsx

@@ -55,11 +55,11 @@ import CardBase from './CardBase'
  * you automatically make inaccessible its children, which may or may not be appropriate
  * depending on what you are trying to achieve.
  */
-const Card = ({ children, tokens, variant, ...rest }) => {
+const Card = ({ children, tokens, variant, dataSet, ...rest }) => {
   const viewport = useViewport()
   const themeTokens = useThemeTokens('Card', tokens, variant, { viewport })
   return (
-    <CardBase tokens={themeTokens} {...rest}>
+    <CardBase tokens={themeTokens} dataSet={dataSet} {...rest}>
       {children}
     </CardBase>
   )

package/src/Card/CardBase.jsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import PropTypes from 'prop-types'
 import { View } from 'react-native'
 
@@ -37,20 +37,22 @@ const selectStyles = ({
  * A themeless base component for Card which components can apply theme tokens to. Not
  * intended to be used in apps or sites directly: build themed components on top of this.
  */
-const CardBase = ({ children, tokens, ...rest }) => {
+const CardBase = forwardRef(({ children, tokens, dataSet, ...rest }, ref) => {
   const cardStyle = selectStyles(typeof tokens === 'function' ? tokens() : tokens)
   const props = { ...a11yProps.select(rest), ...viewProps.select(rest) }
 
   return (
-    <View style={cardStyle} {...props}>
+    <View style={cardStyle} dataSet={dataSet} ref={ref} {...props}>
       {children}
     </View>
   )
-}
+})
+CardBase.displayName = 'CardBase'
 
 CardBase.propTypes = {
   children: PropTypes.node,
   tokens: getTokensPropType('Card'),
+  ...viewProps.types,
   ...a11yProps.types
 }