@telus-uds/components-base 1.4.0 → 1.6.1

package/src/Checkbox/CheckboxGroup.jsx

@@ -4,11 +4,27 @@ import ABBPropTypes from 'airbnb-prop-types'
 
 import { useViewport } from '../ViewportProvider'
 import { useThemeTokens } from '../ThemeProvider'
-import { getTokensPropType, useMultipleInputValues, variantProp } from '../utils'
+import {
+  a11yProps,
+  containUniqueFields,
+  focusHandlerProps,
+  getTokensPropType,
+  selectSystemProps,
+  useMultipleInputValues,
+  variantProp,
+  viewProps
+} from '../utils'
 import { getStackedContent } from '../StackView'
 import Checkbox from './Checkbox'
 import Fieldset from '../Fieldset'
 
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
+const [selectItemProps, selectedItemPropTypes] = selectSystemProps([
+  a11yProps,
+  focusHandlerProps,
+  viewProps
+])
+
 /**
  * A group of Checkboxs that behave as a fieldset. Use when users select any number of choices from options.
  *
@@ -73,7 +89,8 @@ const CheckboxGroup = forwardRef(
       onChange,
       readOnly,
       name: inputGroupName,
-      inactive
+      inactive,
+      ...rest
     },
     ref
   ) => {
@@ -89,27 +106,37 @@ const CheckboxGroup = forwardRef(
       onChange,
       readOnly: readOnly || inactive
     })
-    const checkboxes = items.map(({ label, id, onChange: itemOnChange, ref: itemRef }, index) => {
-      const checkboxId = id || `Checkbox[${index}]`
-      const handleChange = (newCheckedState, event) => {
-        if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event)
-        toggleOneValue(checkboxId, event)
+
+    const uniqueFields = ['id', 'label']
+    if (!containUniqueFields(items, uniqueFields)) {
+      throw new Error(`CheckboxGroup items must have unique ${uniqueFields.join(', ')}`)
+    }
+
+    const checkboxes = items.map(
+      ({ label, id, onChange: itemOnChange, ref: itemRef, ...itemRest }, index) => {
+        const checkboxId = id || `Checkbox[${index}]`
+        const handleChange = (newCheckedState, event) => {
+          if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event)
+          toggleOneValue(checkboxId, event)
+        }
+
+        return (
+          <Checkbox
+            ref={itemRef}
+            key={checkboxId}
+            id={checkboxId}
+            checked={currentValues.includes(checkboxId)}
+            onChange={handleChange}
+            inactive={inactive}
+            label={label}
+            name={inputGroupName}
+            tokens={radioTokens}
+            variant={variant}
+            {...selectItemProps(itemRest)}
+          />
+        )
       }
-      return (
-        <Checkbox
-          ref={itemRef}
-          key={checkboxId}
-          id={checkboxId}
-          checked={currentValues.includes(checkboxId)}
-          onChange={handleChange}
-          inactive={inactive}
-          label={label}
-          name={inputGroupName}
-          tokens={radioTokens}
-          variant={variant}
-        />
-      )
-    })
+    )
 
     return (
       <Fieldset
@@ -122,6 +149,7 @@ const CheckboxGroup = forwardRef(
         feedback={feedback}
         inactive={inactive}
         validation={validation}
+        {...selectProps(rest)}
       >
         {getStackedContent(checkboxes, { space, direction: 'column' })}
       </Fieldset>
@@ -131,6 +159,7 @@ const CheckboxGroup = forwardRef(
 CheckboxGroup.displayName = 'CheckboxGroup'
 
 CheckboxGroup.propTypes = {
+  ...selectedSystemPropTypes,
   /**
    * Optional theme token overrides for the outer CheckboxGroup component
    */
@@ -148,6 +177,7 @@ CheckboxGroup.propTypes = {
    */
   items: PropTypes.arrayOf(
     PropTypes.exact({
+      ...selectedItemPropTypes,
       label: PropTypes.string,
       id: PropTypes.string,
       onChange: PropTypes.func,

package/src/ExpandCollapse/Panel.jsx

@@ -74,8 +74,8 @@ const ExpandCollapsePanel = forwardRef(
     }
 
     const onContainerLayout = (event) => {
-      if (containerHeight === null) {
-        const { layout: { height = 0 } = {} } = event.nativeEvent
+      const { layout: { height = 0 } = {} } = event.nativeEvent
+      if (Platform.OS === 'web' || (Platform.OS !== 'web' && containerHeight === null)) {
         setContainerHeight(height)
       }
     }
@@ -104,14 +104,14 @@ const ExpandCollapsePanel = forwardRef(
         >
           {control}
         </ExpandCollapseControl>
-        <View style={overflowContainerStyles} {...focusabilityProps}>
-          <Animated.View
-            onLayout={onContainerLayout}
-            style={[staticStyles.itemsContainer, animatedStyles]}
-          >
+        <Animated.View
+          style={[overflowContainerStyles, animatedStyles, staticStyles.itemsContainer]}
+          {...focusabilityProps}
+        >
+          <View onLayout={onContainerLayout}>
             <View style={selectContainerStyles(themeTokens)}>{children}</View>
-          </Animated.View>
-        </View>
+          </View>
+        </Animated.View>
       </View>
     )
   }

package/src/FlexGrid/Col/Col.jsx

@@ -23,6 +23,7 @@ const Col = forwardRef(
       mdOffset,
       lgOffset,
       xlOffset,
+      flex,
       ...viewProps
     },
     ref
@@ -106,7 +107,10 @@ const Col = forwardRef(
 
     let hidingStyles = {}
 
-    const shown = Platform.OS === 'web' ? 'block' : 'flex'
+    // TODO: consider setting this to always 'flex' in a major release.
+    // `display: block` is invalid in native apps.
+    // See https://telusdigital.atlassian.net/browse/UDS1-92
+    const shown = !flex && Platform.OS === 'web' ? 'block' : 'flex'
 
     if (viewPort === viewports.xs) {
       hidingStyles = {
@@ -267,7 +271,12 @@ Col.propTypes = {
    */
   horizontalAlign: responsiveProps.getTypeOptionallyByViewport(
     PropTypes.oneOf(['left', 'center', 'right'])
-  )
+  ),
+  /**
+   * (web only) Stretches the column to fill vertical space using `display: flex`.
+   * In native apps, FlexGrid.Col behaves as if this is always true (as do all `View`s).
+   */
+  flex: PropTypes.bool
 }
 
 export default Col

package/src/FlexGrid/Row/Row.jsx

@@ -72,21 +72,27 @@ const Row = forwardRef(
     const reverseLevel = applyInheritance([xsReverse, smReverse, mdReverse, lgReverse, xlReverse])
 
     let flexDirection = ''
+    let flexWrap = ''
 
     if (viewPort === viewports.xs) {
       flexDirection = reverseLevel[0] ? 'row-reverse' : 'row'
+      flexWrap = reverseLevel[0] ? 'wrap-reverse' : 'wrap'
     }
     if (viewPort === viewports.sm) {
       flexDirection = reverseLevel[1] ? 'row-reverse' : 'row'
+      flexWrap = reverseLevel[1] ? 'wrap-reverse' : 'wrap'
     }
     if (viewPort === viewports.md) {
       flexDirection = reverseLevel[2] ? 'row-reverse' : 'row'
+      flexWrap = reverseLevel[2] ? 'wrap-reverse' : 'wrap'
     }
     if (viewPort === viewports.lg) {
       flexDirection = reverseLevel[3] ? 'row-reverse' : 'row'
+      flexWrap = reverseLevel[3] ? 'wrap-reverse' : 'wrap'
     }
     if (viewPort === viewports.xl) {
       flexDirection = reverseLevel[4] ? 'row-reverse' : 'row'
+      flexWrap = reverseLevel[4] ? 'wrap-reverse' : 'wrap'
     }
 
     return (
@@ -97,6 +103,7 @@ const Row = forwardRef(
           styles.row,
           {
             flexDirection,
+            flexWrap,
             ...horizontalAlignStyles(horizontalAlign),
             ...verticalAlignStyles(verticalAlign),
             ...distributeStyles(distribute)
@@ -118,8 +125,7 @@ const styles = StyleSheet.create({
     flexGrow: 0,
     flexShrink: 1,
     flexBasis: 'auto',
-    flexDirection: 'row',
-    flexWrap: 'wrap'
+    flexDirection: 'row'
   }
 })
 

package/src/HorizontalScroll/HorizontalScroll.jsx

@@ -129,7 +129,7 @@ const HorizontalScroll = forwardRef(
           showsHorizontalScrollIndicator={false}
           contentContainerStyle={[
             staticStyles.scrollContainer,
-            { marginBottom: gutter, borderBottomWidth, borderBottomColor }
+            { borderBottomWidth, borderBottomColor }
           ]}
           {...selectProps(rest)}
         >

package/src/HorizontalScroll/HorizontalScrollButton.jsx

@@ -1,35 +1,14 @@
 import React, { forwardRef } from 'react'
 import PropTypes from 'prop-types'
-import { Pressable, StyleSheet } from 'react-native'
-
-import { useThemeTokensCallback } from '../ThemeProvider'
-import {
-  resolvePressableTokens,
-  selectTokens,
-  variantProp,
-  getTokensPropType,
-  useCopy,
-  copyPropTypes,
-  a11yProps
-} from '../utils'
-import Icon from '../Icon'
-import Typography from '../Typography'
+import { StyleSheet, View } from 'react-native'
+import { variantProp, getTokensPropType, useCopy, copyPropTypes, a11yProps } from '../utils'
+import { useThemeTokens } from '../ThemeProvider'
+import IconButton from '../IconButton'
 import dictionary from './dictionary'
 
-const selectButtonStyles = (
-  { borderRadius, backgroundColor, borderColor, borderWidth, padding },
-  direction
-) => [
-  staticStyles.absolute,
-  staticStyles[direction],
-  {
-    borderRadius,
-    backgroundColor,
-    borderColor,
-    borderWidth,
-    padding
-  }
-]
+const selectContainerStyles = ({ offset }) => ({
+  marginTop: offset ? -offset : 0
+})
 
 /**
  * Button within a Tabs component showing users that content is available to the left or
@@ -40,41 +19,25 @@ const selectButtonStyles = (
  * @TODO when IconButton is complete and stable revisit this and update interaction state styles.
  */
 const HorizontalScrollButton = forwardRef(
-  ({ direction = 'next', icon, onPress, offset, variant, tokens, copy }, ref) => {
-    const getTokens = useThemeTokensCallback('HorizontalScrollButton', tokens, variant)
-    const resolveButtonTokens = (pressableState) =>
-      resolvePressableTokens(getTokens, pressableState)
-    const getPressableStyle = (pressableState) => [
-      selectButtonStyles(resolveButtonTokens(pressableState), direction),
-      { marginTop: -1 * (offset || 0) }
-    ]
-
+  ({ direction = 'next', icon, offset, onPress, variant, tokens, copy }, ref) => {
+    const themeTokens = useThemeTokens('HorizontalScrollButton', tokens, variant)
     const getCopy = useCopy({ dictionary, copy })
     const label = direction === 'previous' ? getCopy('previousText') : getCopy('nextText')
 
     return (
-      <Pressable
-        ref={ref}
-        style={getPressableStyle}
-        onPress={onPress}
-        accessibilityLabel={label}
-        accessibilityRole="button"
-        // For keyboard-tab or screenreader-swipe navigation, users can just go through all items
-        {...a11yProps.nonFocusableProps}
+      <View
+        style={[staticStyles.absolute, staticStyles[direction], selectContainerStyles({ offset })]}
       >
-        {(pressableState) => {
-          const iconTokens = selectTokens('Icon', resolveButtonTokens(pressableState), 'icon')
-          return icon ? (
-            <Icon icon={icon} tokens={iconTokens} />
-          ) : (
-            <Typography
-              tokens={{ fontSize: iconTokens.size, lineHeight: 1, color: iconTokens.color }}
-            >
-              {direction === 'next' ? '→' : '←'}
-            </Typography>
-          )
-        }}
-      </Pressable>
+        <IconButton
+          accessibilityLabel={label}
+          icon={icon}
+          onPress={onPress}
+          ref={ref}
+          tokens={themeTokens}
+          variant={variant}
+          {...a11yProps.nonFocusableProps}
+        />
+      </View>
     )
   }
 )

package/src/InputLabel/InputLabel.jsx

@@ -47,35 +47,46 @@ const InputLabel = forwardRef(
     const isHintInline = hintPosition === 'inline'
 
     return (
-      <View
-        ref={ref}
-        style={[staticStyles.container, !isHintInline && staticStyles.containerWithHintBelow]}
-        {...selectProps(rest)}
-      >
-        <Text
-          style={[selectLabelStyles(themeTokens), selectGapStyles(themeTokens), staticStyles.label]}
-        >
-          <LabelContent forId={forId}>{label}</LabelContent>
-        </Text>
-        {hint && isHintInline && (
+      <>
+        <View ref={ref} style={staticStyles.container} {...selectProps(rest)}>
           <Text
-            style={[selectHintStyles(themeTokens), hasTooltip && selectGapStyles(themeTokens)]}
-            nativeID={hintId}
+            style={[
+              selectLabelStyles(themeTokens),
+              selectGapStyles(themeTokens),
+              staticStyles.label
+            ]}
           >
-            {hint}
+            <LabelContent forId={forId}>{label}</LabelContent>
           </Text>
-        )}
-        {hasTooltip && (
-          <View style={staticStyles.tooltipAlign}>
-            <Tooltip content={tooltip} />
-          </View>
-        )}
+          {hint && isHintInline && (
+            <Text
+              style={[
+                selectHintStyles(themeTokens),
+                hasTooltip && selectGapStyles(themeTokens),
+                staticStyles.label
+              ]}
+              nativeID={hintId}
+            >
+              {hint}
+            </Text>
+          )}
+          {hasTooltip && (
+            <View
+              style={[
+                staticStyles.tooltipAlign,
+                { height: themeTokens.fontSize * themeTokens.lineHeight }
+              ]}
+            >
+              <Tooltip content={tooltip} />
+            </View>
+          )}
+        </View>
         {hint && !isHintInline && (
           <Text style={[selectHintStyles(themeTokens), staticStyles.hintBelow]} nativeID={hintId}>
             {hint}
           </Text>
         )}
-      </View>
+      </>
     )
   }
 )
@@ -115,21 +126,19 @@ export default InputLabel
 
 const staticStyles = StyleSheet.create({
   container: {
-    display: 'flex',
+    flexShrink: 1,
     flexDirection: 'row',
     alignItems: 'baseline'
   },
-  containerWithHintBelow: {
-    flexWrap: 'wrap'
-  },
   label: {
-    flexShrink: 0
+    flexShrink: 1
   },
   hintBelow: {
     flexBasis: '100%',
     flexShrink: 0
   },
   tooltipAlign: {
-    alignSelf: 'center'
+    alignSelf: 'flex-start',
+    justifyContent: 'center'
   }
 })

package/src/Link/LinkBase.jsx

@@ -45,10 +45,8 @@ const selectOuterBorderStyles = ({
       }
     : {}
 
-const selectTextStyles = ({ color, textLine, textLineStyle }) => ({
+const selectTextStyles = ({ color }) => ({
   color,
-  textDecorationLine: textLine,
-  textDecorationStyle: textLineStyle,
   ...Platform.select({
     web: {
       // TODO: https://github.com/telus/universal-design-system/issues/487
@@ -65,6 +63,18 @@ const selectBlockStyles = ({ blockFontWeight, blockFontSize, blockLineHeight, bl
     fontName: blockFontName
   })
 
+const selectDecorationStyles = ({ color, textLine, textLineStyle }) => ({
+  color,
+  textDecorationLine: textLine,
+  textDecorationStyle: textLineStyle,
+  ...Platform.select({
+    web: {
+      // TODO: https://github.com/telus/universal-design-system/issues/487
+      transition: 'color 200ms'
+    }
+  })
+})
+
 const selectIconTokens = ({ color, iconSize, iconTranslateX, iconTranslateY }) => ({
   color,
   translateX: iconTranslateX,
@@ -132,8 +142,14 @@ const LinkBase = forwardRef(
         style={(linkState) => {
           const themeTokens = resolveLinkTokens(linkState)
           const outerBorderStyles = selectOuterBorderStyles(themeTokens)
+          const decorationStyles = selectDecorationStyles(themeTokens)
           const hasIcon = Boolean(icon || themeTokens.icon)
-          return [outerBorderStyles, blockLeftStyle, hasIcon && staticStyles.rowContainer]
+          return [
+            outerBorderStyles,
+            blockLeftStyle,
+            decorationStyles,
+            hasIcon && staticStyles.rowContainer
+          ]
         }}
       >
         {(linkState) => {

package/src/Link/TextButton.jsx

@@ -10,19 +10,7 @@ import LinkBase from './LinkBase'
  * take place on the current page, or for navigation within an app.
  */
 const TextButton = forwardRef(
-  (
-    {
-      onPress,
-      children,
-      variant,
-      tokens,
-      // TODO: this may need to use `link` role on Web in the case of being passed both `href` and
-      // `onPress` in an omniplatform app that uses React Navigation's useLinkProps for internal nav.
-      accessibilityRole = 'button',
-      ...linkProps
-    },
-    ref
-  ) => {
+  ({ onPress, children, variant, tokens, accessibilityRole = 'button', ...linkProps }, ref) => {
     const getTokens = useThemeTokensCallback('Link', tokens, variant)
     return (
       <LinkBase
@@ -44,10 +32,4 @@ TextButton.propTypes = {
   onPress: PropTypes.func.isRequired
 }
 
-// Remove incompatible Link prop (if this build includes propTypes)
-// TODO: test if this works with web navigation in omniplatform React Navigation
-// https://github.com/telus/universal-design-system/issues/665
-// eslint-disable-next-line react/forbid-foreign-prop-types
-if (TextButton.propTypes?.href) delete TextButton.propTypes.href
-
 export default TextButton

package/src/Modal/Modal.jsx

@@ -16,10 +16,11 @@ import {
   selectSystemProps,
   useCopy,
   variantProp,
-  viewProps
+  viewProps,
+  selectTokens
 } from '../utils'
 import { useViewport } from '../ViewportProvider'
-import ButtonBase from '../Button/ButtonBase'
+import IconButton from '../IconButton'
 import dictionary from './dictionary'
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
@@ -70,11 +71,6 @@ const selectCloseButtonContainerStyles = ({ paddingRight, paddingTop }) => ({
   paddingTop
 })
 
-const selectCloseIconProps = ({ closeIconSize, closeIconColor }) => ({
-  size: closeIconSize,
-  color: closeIconColor
-})
-
 /**
  * A modal window is a secondary window that opens on top of the main one.
  * Users have to interact with it before they can carry out their task and return to the main window.
@@ -90,7 +86,7 @@ const selectCloseIconProps = ({ closeIconSize, closeIconColor }) => ({
  * - Don’t use modals consecutively
  */
 const Modal = forwardRef(
-  ({ children, isOpen, onClose, maxWidth, tokens, variant, copy, ...rest }, ref) => {
+  ({ children, isOpen, onClose, maxWidth, tokens, variant, copy, closeButton, ...rest }, ref) => {
     const viewport = useViewport()
     const themeTokens = useThemeTokens('Modal', tokens, variant, { viewport, maxWidth })
 
@@ -107,11 +103,14 @@ const Modal = forwardRef(
       if (event.key === 'Escape') onClose()
     }
 
+    // Show the custom react node passed to `closedButton` or the default close button if `closeButton` is `undefined`.
+    // Hide the close button if `closeButton` is `null`.
+    const showCloseButton = closeButton !== null
+
     if (!isOpen) {
       return null
     }
 
-    // TODO: replace the close button with IconButton when implemented (https://github.com/telus/universal-design-system/issues/281)
     return (
       <NativeModal transparent {...selectProps(rest)}>
         <View style={[staticStyles.positioningContainer]}>
@@ -124,23 +123,24 @@ const Modal = forwardRef(
               style={[staticStyles.modal, selectModalStyles(themeTokens)]}
               onKeyUp={handleKeyUp}
             >
-              <View
-                style={[
-                  staticStyles.closeButtonContainer,
-                  selectCloseButtonContainerStyles(themeTokens)
-                ]}
-              >
-                <ButtonBase
-                  onPress={handleClose}
-                  accessibilityRole="button"
-                  accessibilityLabel={closeLabel}
+              {showCloseButton && (
+                <View
+                  style={[
+                    staticStyles.closeButtonContainer,
+                    selectCloseButtonContainerStyles(themeTokens)
+                  ]}
                 >
-                  {
-                    // TODO: add close button interactive states after IconButton is done
-                    () => <CloseIconComponent {...selectCloseIconProps(themeTokens)} />
-                  }
-                </ButtonBase>
-              </View>
+                  {closeButton || (
+                    <IconButton
+                      onPress={handleClose}
+                      icon={CloseIconComponent}
+                      accessibilityRole="button"
+                      accessibilityLabel={closeLabel}
+                      tokens={selectTokens('IconButton', themeTokens, 'close')}
+                    />
+                  )}
+                </View>
+              )}
               {children}
             </View>
           </View>
@@ -164,7 +164,11 @@ Modal.propTypes = {
   onClose: PropTypes.func,
   maxWidth: PropTypes.bool,
   tokens: getTokensPropType('Modal'),
-  variant: variantProp.propType
+  variant: variantProp.propType,
+  /**
+   * Pass a react node to override the default close button or pass `null` to hide the close button.
+   */
+  closeButton: PropTypes.node
 }
 
 export default Modal