@telus-uds/components-base 0.0.2-prerelease.1 → 0.0.2-prerelease.10

package/src/Button/Button.jsx

@@ -1,15 +1,19 @@
 import React from 'react'
+
 import ButtonBase from './ButtonBase'
-import buttonPropTypes from './propTypes'
+import buttonPropTypes, { textAndA11yText } from './propTypes'
+import { useThemeTokensCallback } from '../ThemeProvider'
 import { a11yProps } from '../utils/propTypes'
 
-const Button = ({ accessibilityRole = 'button', ...props }) => (
-  <ButtonBase {...props} accessibilityRole={accessibilityRole} />
-)
+const Button = ({ accessibilityRole = 'button', tokens, variant, ...props }) => {
+  const getTokens = useThemeTokensCallback('Button', tokens, variant)
+  return <ButtonBase {...props} tokens={getTokens} accessibilityRole={accessibilityRole} />
+}
 
 Button.propTypes = {
   ...a11yProps.types,
-  ...buttonPropTypes
+  ...buttonPropTypes,
+  children: textAndA11yText
 }
 
 export default Button

package/src/Button/ButtonBase.jsx

@@ -1,67 +1,53 @@
 import React from 'react'
-import { Pressable, Text, View, StyleSheet, Platform } from 'react-native'
+import { Pressable, View, StyleSheet, Platform } from 'react-native'
 
-import { useThemeTokensCallback } from '../ThemeProvider'
-import { applyTextStyles, applyShadowToken } from '../ThemeProvider/utils'
+import { applyTextStyles, applyShadowToken, applyOuterBorder } from '../ThemeProvider/utils'
 import buttonPropTypes from './propTypes'
-import { a11yProps, hrefAttrsProp, linkProps } from '../utils/propTypes'
-
-const getCursorStyle = (inactive, accessibilityRole) => {
-  if (inactive) return 'not-allowed'
-  // These roles should result in cursor: pointer but don't in current RNW releases
-  if (['checkbox', 'radio', 'switch'].includes(accessibilityRole)) return 'pointer'
-  // For everything else, let React Native Web figure it out internally
-  return undefined
-}
+import {
+  a11yProps,
+  getCursorStyle,
+  linkProps,
+  resolvePressableState,
+  resolvePressableTokens,
+  wrapStringsInText
+} from '../utils'
 
 const getOuterBorderOffset = ({ outerBorderGap = 0, outerBorderWidth = 0 }) =>
   outerBorderGap + outerBorderWidth
 
 const selectOuterContainerStyles = ({
+  alignSelf,
   opacity,
   outerBorderColor,
   outerBorderWidth,
-  outerBorderGap = 0,
-  outerBorderRadius = 0,
+  outerBorderGap,
+  borderRadius,
   outerBackgroundColor
 }) => ({
-  padding: outerBorderGap,
-  borderWidth: outerBorderWidth,
-  borderColor: outerBorderColor,
-  borderRadius: outerBorderRadius + outerBorderGap,
+  alignSelf,
   backgroundColor: outerBackgroundColor,
-  opacity
+  opacity,
+  ...applyOuterBorder({
+    outerBorderGap,
+    outerBorderWidth,
+    outerBorderColor,
+    borderRadius
+  })
 })
 
-const selectOuterWidthStyles = ({
-  outerBorderGap,
-  outerBorderWidth,
-  width,
-  // TODO: make margin the responsibility of a parent
-  // https://github.com/telus/universal-design-system/issues/525
-  marginTop = 0,
-  marginBottom = 0,
-  marginLeft = 0,
-  marginRight = 0
-}) => {
+const selectOuterWidthStyles = ({ outerBorderGap, outerBorderWidth, width }) => {
   // The inner container's bounding box is the bounding box of the button overall
   // so this many device pixels will sit outside of the overall bounding box
   const outerBorderOffset = getOuterBorderOffset({ outerBorderGap, outerBorderWidth })
-  const widthStyles = {
-    marginTop: marginTop - outerBorderOffset,
-    marginBottom: marginBottom - outerBorderOffset,
-    marginLeft: marginLeft - outerBorderOffset,
-    marginRight: marginRight - outerBorderOffset
-  }
+  const widthStyles = {}
 
   if (!width) {
     return {
       ...widthStyles,
       // Wrap content, stopping a flex parent's default align-items: stretch stretching focus ring beyond content
       ...Platform.select({
-        web: { width: 'fit-content' },
-        // No fit-content or inline-block in RN. TODO: we might need to provide a prop to allow flex-end or center
-        native: { alignSelf: 'flex-start' }
+        // width: fit-content isn't supported on Firefox; can't cascade props like CSS `width: fit-content; width: --moz-fit-content;`
+        web: { display: 'inline-flex' }
       })
     }
   }
@@ -95,7 +81,8 @@ const selectInnerContainerStyles = ({
   paddingTop,
   paddingBottom,
   shadow,
-  borderWidth
+  borderWidth,
+  minWidth
 }) => {
   // Subtract border width from padding so overall button width/height doesn't
   // jump around if the border width changes (avoiding NaN and negative padding)
@@ -110,6 +97,7 @@ const selectInnerContainerStyles = ({
     paddingTop: offsetBorder(paddingTop),
     paddingBottom: offsetBorder(paddingBottom),
     backgroundColor,
+    minWidth,
     ...applyShadowToken(shadow)
   }
 }
@@ -130,77 +118,63 @@ const selectTextStyles = ({ fontSize, color, lineHeight, fontName, fontWeight, t
     textAlign
   })
 
-const selectWebOnlyStyles = (inactive, themeTokens, { accessibilityRole }) =>
-  Platform.OS === 'web'
-    ? {
-        // if it would overflow the container, wraps instead
-        maxWidth: `calc(100% + ${getOuterBorderOffset(themeTokens) * 2}px)`,
-        cursor: getCursorStyle(inactive, accessibilityRole),
-        outline: 'none' // removes the default browser :focus outline
-      }
-    : {}
+const selectWebOnlyStyles = (inactive, themeTokens, { accessibilityRole }) => {
+  return Platform.select({
+    web: {
+      // if it would overflow the container, wraps instead
+      maxWidth: `calc(100% + ${getOuterBorderOffset(themeTokens) * 2}px)`,
+      outline: 'none', // removes the default browser :focus outline
+      ...getCursorStyle(inactive, accessibilityRole)
+    },
+    default: {}
+  })
+}
 
 const ButtonBase = ({
   href,
   hrefAttrs,
   children,
-  variant,
   onPress,
-  tokens,
+  tokens = {},
   disabled = false, // alias for inactive
   inactive = disabled,
   selected = false,
   ...rest
 }) => {
-  const getTokens = useThemeTokensCallback('Button')
-  const getButtonState = ({ pressed, focused, hovered }) => ({
-    pressed,
-    focus: focused,
-    hover: hovered,
-    inactive,
-    selected
-  })
-  const getTokensByPressableState = (pressableState) =>
-    getTokens(tokens, variant, getButtonState(pressableState))
+  const extraButtonState = { inactive, selected }
+  const resolveButtonTokens = (pressableState) =>
+    resolvePressableTokens(tokens, pressableState, extraButtonState)
 
   const a11y = a11yProps.select(rest)
 
   const getPressableStyle = (pressableState) => {
-    const themeTokens = getTokensByPressableState(pressableState)
+    const themeTokens = resolveButtonTokens(pressableState)
     return [
-      staticStyles.wrapper,
+      staticStyles.row,
       selectWebOnlyStyles(inactive, themeTokens, a11y),
       selectOuterContainerStyles(themeTokens),
       selectOuterWidthStyles(themeTokens)
     ]
   }
 
-  const handlePress = linkProps.handleHref({ href, onPress })
-
   return (
     <Pressable
-      onPress={handlePress}
+      href={href}
+      onPress={linkProps.handleHref({ href, onPress })}
       style={getPressableStyle}
       disabled={inactive}
-      href={href}
-      {...hrefAttrsProp.spread(hrefAttrs)}
+      hrefAttrs={hrefAttrs}
       {...a11y}
     >
       {(pressableState) => {
-        const themeTokens = getTokensByPressableState(pressableState)
+        const themeTokens = resolveButtonTokens(pressableState)
         const containerStyles = selectInnerContainerStyles(themeTokens)
         const borderStyles = selectBorderStyles(themeTokens)
-        const textStyles = {
-          ...selectTextStyles(themeTokens),
-          ...Platform.select({
-            // TODO: https://github.com/telus/universal-design-system/issues/487
-            web: { transition: 'color 200ms' }
-          })
-        }
+        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.center
+        const stretchStyles = themeTokens.width ? staticStyles.stretch : staticStyles.align
 
         return (
           <View
@@ -208,6 +182,7 @@ const ButtonBase = ({
               containerStyles,
               borderStyles,
               stretchStyles,
+              staticStyles.row,
               Platform.select({
                 web: {
                   maxWidth: '100%', // ensure overflowing content wraps
@@ -217,13 +192,14 @@ const ButtonBase = ({
               })
             ]}
           >
-            {typeof children === 'function' ? (
-              children({
-                ...getButtonState(pressableState),
-                textStyles
-              })
-            ) : (
-              <Text style={textStyles}>{children}</Text>
+            {wrapStringsInText(
+              typeof children === 'function'
+                ? children({
+                    ...resolvePressableState(pressableState, extraButtonState),
+                    textStyles
+                  })
+                : children,
+              { style: textStyles }
             )}
           </View>
         )
@@ -239,10 +215,21 @@ ButtonBase.propTypes = {
 }
 
 const staticStyles = StyleSheet.create({
-  wrapper: {
-    flexDirection: 'row' // ensures alignSelf is horizontal
+  row: {
+    // Apply all button alignment horizontally; no vertical stacking within a button
+    flexDirection: 'row'
+  },
+  text: {
+    flexGrow: 1, // On native but not web, flexShrink here wraps text prematurely
+    ...Platform.select({
+      // TODO: https://github.com/telus/universal-design-system/issues/487
+      web: { transition: 'color 200ms' }
+    })
+  },
+  align: {
+    alignItems: 'center'
   },
-  center: {
+  stretch: {
     flex: 1,
     alignItems: 'center',
     justifyContent: 'center'

package/src/Button/ButtonGroup.jsx

@@ -1,24 +1,23 @@
 import React from 'react'
 import PropTypes from 'prop-types'
-import { View, Platform } from 'react-native'
+import { Platform } from 'react-native'
 
 import ButtonBase from './ButtonBase'
+import { StackWrap } from '../StackView'
 import { useViewport } from '../ViewportProvider'
-import { useThemeTokens } from '../ThemeProvider'
-import { a11yProps, pressProps, variantProp, getTokensPropType } from '../utils/propTypes'
+import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider'
+import {
+  a11yProps,
+  pressProps,
+  variantProp,
+  getTokensPropType,
+  selectTokens
+} from '../utils/propTypes'
 import { useMultipleInputValues } from '../utils/input'
-
-const selectContainerStyles = ({ direction }) => ({
-  flexDirection: direction
-})
-
-const selectItemTokens = ({ gap }, index) => ({
-  marginLeft: index && gap
-})
+import { getPressHandlersWithArgs } from '../utils/pressability'
 
 const ButtonGroup = ({
   variant,
-  buttonVariant = {},
   tokens,
   items = [],
   values,
@@ -28,13 +27,16 @@ const ButtonGroup = ({
   readOnly = false,
   inactive = false,
   accessibilityRole = maxValues === 1
-    ? 'radioGroup' // radioGroup is cross-platform; only web aria has generic groups
+    ? '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 containerStyles = selectContainerStyles(themeTokens)
+  const stackTokens = selectTokens('StackView', themeTokens)
+  const { direction, space } = themeTokens
+
+  const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant)
 
   const { currentValues, toggleOneValue } = useMultipleInputValues({
     initialValues,
@@ -48,54 +50,36 @@ const ButtonGroup = ({
     accessibilityRole,
     ...rest
   })
-  const itemA11yRole = a11y.accessibilityRole === 'radioGroup' ? 'radio' : 'checkbox'
+  const itemA11yRole = a11y.accessibilityRole === 'radiogroup' ? 'radio' : 'checkbox'
 
   return (
-    <View style={containerStyles} {...a11y}>
+    <StackWrap {...a11y} space={space} direction={direction} tokens={stackTokens}>
       {items.map(({ label, id = label, accessibilityLabel }, index) => {
-        const itemTokens = selectItemTokens(themeTokens, index)
         const isSelected = currentValues.includes(id)
 
-        // Allow handlers to be passed down for blur, hover, focus, pressIn, etc
-        const pressHandlers = Object.fromEntries(
-          Object.entries(pressProps.select(rest)).map(([key, handler]) => ({
-            [key]: (args) => {
-              // Pass each handler data on this button and current selection
-              handler({ id, label, currentValues }, ...args)
-            }
-          }))
-        )
-        const handlePress = () => {
+        // 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 = (event) => {
           if (pressHandlers.onPress) pressHandlers.onPress()
-          toggleOneValue(id)
+          toggleOneValue(id, event)
         }
 
         const itemA11y = {
           accessibilityState: { checked: isSelected },
           accessibilityRole: itemA11yRole,
           accessibilityLabel,
-          ...Platform.select({
-            web: {
-              // accessibilityPosInSet etc exists in React Native Web main branch
-              // but not in a release compatible with Expo etc; just use `aria-*`
-              'aria-setsize': items.length,
-              'aria-posinset': index + 1
-            },
-            default: {}
-          })
+          ...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
-        // See also: TODO: make margin the responsibility of a parent
-        // https://github.com/telus/universal-design-system/issues/525
         return (
           <ButtonBase
             key={id}
             {...pressHandlers}
             onPress={handlePress}
-            variant={{ component: 'ButtonGroup', ...buttonVariant }}
-            tokens={itemTokens}
+            tokens={getButtonTokens}
             selected={isSelected}
             inactive={inactive}
             {...itemA11y}
@@ -104,7 +88,7 @@ const ButtonGroup = ({
           </ButtonBase>
         )
       })}
-    </View>
+    </StackWrap>
   )
 }
 
@@ -113,7 +97,6 @@ ButtonGroup.propTypes = {
   ...pressProps.propTypes,
   tokens: getTokensPropType('ButtonGroup'),
   variant: variantProp.propType,
-  buttonVariant: variantProp.propType,
   /**
    * The maximum number of items a user may select at once. Defaults to 1 and behaves
    * like radio buttons. To have no limit and allow any number of selections, pass `null`.

package/src/Button/ButtonLink.jsx

@@ -1,21 +1,31 @@
 import React from 'react'
 import ButtonBase from './ButtonBase'
-import buttonPropTypes from './propTypes'
+import buttonPropTypes, { textAndA11yText } from './propTypes'
 import { a11yProps, hrefAttrsProp, linkProps } from '../utils/propTypes'
+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', ...props }) => {
+const ButtonLink = ({ accessibilityRole = 'link', tokens, variant, ...props }) => {
   const { hrefAttrs, rest } = hrefAttrsProp.bundle(props)
-  return <ButtonBase accessibilityRole={accessibilityRole} hrefAttrs={hrefAttrs} {...rest} />
+  const getTokens = useThemeTokensCallback('Button', tokens, variant)
+  return (
+    <ButtonBase
+      accessibilityRole={accessibilityRole}
+      tokens={getTokens}
+      hrefAttrs={hrefAttrs}
+      {...rest}
+    />
+  )
 }
 
 ButtonLink.propTypes = {
   ...a11yProps.types,
   ...buttonPropTypes,
-  ...linkProps.types
+  ...linkProps.types,
+  children: textAndA11yText
 }
 
 export default ButtonLink

package/src/Button/propTypes.js

@@ -1,5 +1,11 @@
 import PropTypes from 'prop-types'
+import ABBPropTypes from 'airbnb-prop-types'
 import { variantProp } from '../utils/propTypes'
+import A11yText from '../A11yText'
+
+export const textAndA11yText = ABBPropTypes.childrenOf(
+  PropTypes.oneOfType([ABBPropTypes.elementType(A11yText), PropTypes.string])
+)
 
 const buttonPropTypes = {
   /**
@@ -12,10 +18,14 @@ const buttonPropTypes = {
    */
   disabled: PropTypes.bool,
   /**
-   * Button's children must be either a text string, or a render function which is passed an object of
+   * Button's children must be either:
+   *  - One or more text strings and / or A11yText components
+   *  - A render function with contents that responds to current button state by being passed an object of:
+   * ```
    * { hovered<bool>, focused<bool>, pressed<bool>, inactive<bool>, selected<bool>, textStyles<RNStyle> }
+   * ```
    */
-  children: PropTypes.oneOfType([PropTypes.string, PropTypes.func]).isRequired,
+  children: PropTypes.oneOfType([PropTypes.func, textAndA11yText]).isRequired,
   /**
    * Function called when the button is pressed. Required unless the button has a href.
    */

package/src/Card/Card.jsx

@@ -0,0 +1,75 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+
+import { useThemeTokens } from '../ThemeProvider'
+import { getTokensPropType, variantProp } from '../utils'
+import { useViewport } from '../ViewportProvider'
+import { a11yProps } from '../utils/propTypes'
+import CardBase from './CardBase'
+
+/**
+ * A basic card component, unstyled by default.
+ *
+ * ## Component API
+ *
+ * ### Background
+ *
+ * In order to control the background of a card, the following tokens are currently
+ * supported:
+ *
+ * - `backgroundColor`
+ *
+ * ### Border
+ *
+ * The following border tokens can be used:
+ *
+ * - `borderColor`
+ * - `borderRadius`
+ * - `borderWidth`
+ *
+ * ### Padding
+ *
+ * Please use the following tokens to control the padding:
+ *
+ * - `paddingBottom`
+ * - `paddingLeft`
+ * - `paddingRight`
+ * - `paddingTop`
+ *
+ * Note that various viewport sizes are supported as well.
+ *
+ * ### Shadow
+ *
+ * Feel free to use the following properties within the `shadow` token:
+ *
+ * - `inset`: boolean
+ * - `color`: string
+ * - `offsetX`: number
+ * - `offsetY`: number
+ * - `blur`: number
+ * - `spread`: number
+ *
+ * ## Accessibility
+ *
+ * Card supports all the common a11y props. Please remember that by marking a card as `accessible`
+ * 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 viewport = useViewport()
+  const themeTokens = useThemeTokens('Card', tokens, variant, { viewport })
+  return (
+    <CardBase tokens={themeTokens} {...rest}>
+      {children}
+    </CardBase>
+  )
+}
+
+Card.propTypes = {
+  children: PropTypes.node,
+  tokens: getTokensPropType('Card'),
+  variant: variantProp.propType,
+  ...a11yProps.types
+}
+
+export default Card

package/src/Card/CardBase.jsx

@@ -0,0 +1,57 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+import { View } from 'react-native'
+
+import { applyShadowToken } from '../ThemeProvider'
+import { getTokensPropType } from '../utils'
+import { a11yProps, viewProps } from '../utils/propTypes'
+
+// Ensure explicit selection of tokens
+const selectStyles = ({
+  flex,
+  backgroundColor,
+  borderColor,
+  borderRadius,
+  borderWidth,
+  paddingBottom,
+  paddingLeft,
+  paddingRight,
+  paddingTop,
+  minWidth,
+  shadow
+}) => ({
+  flex,
+  backgroundColor,
+  borderColor,
+  borderRadius,
+  borderWidth,
+  paddingBottom,
+  paddingLeft,
+  paddingRight,
+  paddingTop,
+  minWidth,
+  ...applyShadowToken(shadow)
+})
+
+/**
+ * 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 cardStyle = selectStyles(typeof tokens === 'function' ? tokens() : tokens)
+  const props = { ...a11yProps.select(rest), ...viewProps.select(rest) }
+
+  return (
+    <View style={cardStyle} {...props}>
+      {children}
+    </View>
+  )
+}
+
+CardBase.propTypes = {
+  children: PropTypes.node,
+  tokens: getTokensPropType('Card'),
+  ...a11yProps.types
+}
+
+export default CardBase