@telus-uds/components-base 0.0.2-prerelease.7 → 1.0.1

package/src/Progress/ProgressBar.jsx

@@ -0,0 +1,123 @@
+import React, { forwardRef } from 'react'
+import PropTypes from 'prop-types'
+import { Platform, StyleSheet, View } from 'react-native'
+
+import ProgressBarBackground from './ProgressBarBackground'
+import { a11yProps } from '../utils/propTypes'
+import { useThemeTokens } from '../ThemeProvider'
+import { getTokensPropType, variantProp } from '../utils'
+
+const selectBarStyles = (
+  { backgroundColor, borderRadius, outlineWidth, outlineColor },
+  percentage
+) => ({
+  backgroundColor,
+  borderRadius,
+  outlineWidth,
+  outlineColor,
+  width: `${percentage}%`
+})
+
+/**
+ * The `ProgressBar` is a visual representation of linear progression.
+ * It provides simple but important information at a quick glance.
+ *
+ * ## Props
+ *
+ * - Use `percentage` prop to indicate completion
+ *
+ * ## Tokens
+ *
+ * - Use the following tokens to customize the appearance:
+ *   - `backgroundColor` for the background color of the progress bar,
+ *   - `borderRadius` for the rounded corners,
+ *   - `outlineColor` to control the color of the border (outline),
+ *   - `outlineWidth` to change the outline width.
+ *
+ * ## Variants
+ *
+ * - Use the following variants to render specific types of progress bars:
+ *   - `negative`: set to `true` if you wish to use the negative theming for progress bar filling,
+ *   - `inactive`: set to `true` if you wish to style the progress bar as inactive.
+ *
+ * ## Usability and A11y guidelines
+ *
+ * `ProgressBar` component accepts all the standard accessibility properties including the ones that
+ * are specific to the `progressbar` role. By default the following props are used:
+ *
+ * - `accessibilityRole` (`role`): `progressbar`,
+ * - `accessibilityValue.min` (`aria-valuemin`): `0`,
+ * - `accessibilityValue.max` (`aria-valuemax`): `100`,
+ * - `accessibilityValue.now` (`aria-valuenow`): `percentage`,
+ * - `accessibilityValue.text` (`aria-valuetext`): `%{percentage}%`,
+ *
+ */
+const ProgressBar = forwardRef(
+  ({ children = null, percentage = 0, tokens, variant, ...rest }, ref) => {
+    const themeTokens = useThemeTokens('ProgressBar', tokens, variant)
+    if (percentage < 0) {
+      throw new Error('ProgressBar: `percentage` must be a positive number')
+    } else if (percentage > 100) {
+      throw new Error('ProgressBar: `percentage` cannot exceed 100')
+    }
+    const accessibilityProps = {
+      accessibilityRole: 'progressbar',
+      accessibilityValue: {
+        min: 0,
+        max: 100,
+        now: percentage,
+        text: `${percentage}%`
+      },
+      ...a11yProps.select(rest)
+    }
+
+    return percentage > 0 ? (
+      <View
+        ref={ref}
+        style={[staticStyles.bar, selectBarStyles(themeTokens, percentage)]}
+        {...accessibilityProps}
+      >
+        {children ?? <ProgressBarBackground variant={variant} />}
+      </View>
+    ) : null
+  }
+)
+ProgressBar.displayName = 'ProgressBar'
+
+ProgressBar.propTypes = {
+  /**
+   * Optional children that can be used to customize the progress bar filling.
+   */
+  children: PropTypes.node,
+  /**
+   * Accessibility label for the progress bar.
+   */
+  accessibilityLabel: PropTypes.string.isRequired,
+  /**
+   * Percentage of completion.
+   */
+  percentage: PropTypes.number,
+  /**
+   * Progress bar tokens.
+   */
+  tokens: getTokensPropType('ProgressBar'),
+  /**
+   * Progress bar variant.
+   */
+  variant: variantProp.propType
+}
+
+export default ProgressBar
+
+const staticStyles = StyleSheet.create({
+  bar: {
+    height: '100%',
+    overflow: 'hidden',
+    position: 'absolute',
+    ...Platform.select({
+      web: {
+        outlineStyle: 'solid'
+      }
+    })
+  }
+})

package/src/Progress/ProgressBarBackground.jsx

@@ -0,0 +1,36 @@
+import React, { forwardRef } from 'react'
+import { ImageBackground, StyleSheet } from 'react-native'
+
+import { variantProp } from '../utils'
+
+const inactiveBackground = `%3Csvg xmlns='http://www.w3.org/2000/svg' width='100%25' height='24'%3E%3Cdefs%3E%3Cpattern id='DisabledProgress7' patternUnits='userSpaceOnUse' width='8' height='8'%3E%3Crect width='8' height='8' fill='%23B2B9BF'%3E%3C/rect%3E%3Ccircle cx='4' cy='4' r='2' fill='%23676E73' stroke='%23676E73' stroke-width='0'%3E%3C/circle%3E%3Ccircle cx='0' cy='0' r='2' fill='%23676E73' stroke='%23676E73' stroke-width='0'%3E%3C/circle%3E%3Ccircle cx='0' cy='8' r='2' fill='%23676E73' stroke='%23676E73' stroke-width='0'%3E%3C/circle%3E%3Ccircle cx='8' cy='0' r='2' fill='%23676E73' stroke='%23676E73' stroke-width='0'%3E%3C/circle%3E%3Ccircle cx='8' cy='8' r='2' fill='%23676E73' stroke='%23676E73' stroke-width='0'%3E%3C/circle%3E%3C/pattern%3E%3C/defs%3E%3Cpath d='M 0 0 L 0 140 L 2000 2000 L 2000 0 Z' style='fill: url("%23DisabledProgress7");'%3E%3C/path%3E%3C/svg%3E`
+const negativeBackground = `%3Csvg xmlns='http://www.w3.org/2000/svg' width='100%25' height='24'%3E%3Cdefs%3E%3Cpattern id='NegativeProgress6' patternUnits='userSpaceOnUse' width='8' height='8'%3E%3Crect width='8' height='8' fill='%23C12335'%3E%3C/rect%3E%3Cpath d='M 0,8 l 8,-8 M -2,2 l 4,-4 M 6,10 l 4,-4' stroke-width='2' shape-rendering='auto' stroke='%23e7adb4' stroke-linecap='square'%3E%3C/path%3E%3C/pattern%3E%3C/defs%3E%3Cpath d='M 0 0 L 0 140 L 2000 2000 L 2000 0 Z' style='fill: url("%23NegativeProgress6");'%3E%3C/path%3E%3C/svg%3E`
+const ProgressBarBackground = forwardRef(({ variant }, ref) => {
+  let source = null
+  if (variant?.inactive) {
+    source = inactiveBackground
+  } else if (variant?.negative) {
+    source = negativeBackground
+  } else {
+    return null
+  }
+  return (
+    <ImageBackground
+      ref={ref}
+      source={{ uri: `data:image/svg+xml,${source}` }}
+      style={staticStyles.imageBackground}
+    />
+  )
+})
+ProgressBarBackground.displayName = 'ProgressBarBackground'
+
+ProgressBarBackground.propTypes = {
+  /**
+   * Progress bar variant.
+   */
+  variant: variantProp.propType
+}
+
+export default ProgressBarBackground
+
+const staticStyles = StyleSheet.create({ imageBackground: { height: '100%' } })

package/src/Progress/index.js

@@ -0,0 +1,6 @@
+import Progress from './Progress'
+import ProgressBar from './ProgressBar'
+
+Progress.Bar = ProgressBar
+
+export default Progress

package/src/Radio/Radio.jsx

@@ -1,26 +1,19 @@
-import React from 'react'
+import React, { forwardRef } from 'react'
 import PropTypes from 'prop-types'
 import { Pressable, StyleSheet, Text, View } from 'react-native'
 
-import RadioInput from './RadioInput'
 // @todo move `LabelContent` outside of the `InputLabel` and fix
 // the issue with the cursor not being pointer on Web
 import RadioLabel from '../InputLabel/LabelContent'
+import RadioButton, { selectRadioButtonTokens } from './RadioButton'
 import { applyShadowToken, applyTextStyles, useThemeTokensCallback } from '../ThemeProvider'
 import { getTokensPropType, useInputValue, useUniqueId, variantProp } from '../utils'
 import { a11yProps } from '../utils/propTypes'
 import StackView from '../StackView'
 
-const selectCheckedStyles = ({ checkedBackgroundColor, checkedSize }) => ({
-  backgroundColor: checkedBackgroundColor,
-  borderRadius: checkedSize / 2,
-  height: checkedSize,
-  width: checkedSize
-})
 const selectContainerStyles = ({
   containerBackgroundColor,
   containerBorderRadius,
-  containerMarginBottom,
   containerOpacity,
   containerPaddingBottom,
   containerPaddingLeft,
@@ -30,7 +23,6 @@ const selectContainerStyles = ({
 }) => ({
   backgroundColor: containerBackgroundColor,
   borderRadius: containerBorderRadius,
-  marginBottom: containerMarginBottom,
   opacity: containerOpacity,
   paddingBottom: containerPaddingBottom,
   paddingLeft: containerPaddingLeft,
@@ -49,24 +41,6 @@ const selectDescriptionStyles = ({
   marginLeft: descriptionMarginLeft ?? containerPaddingLeft + inputSize + labelMarginLeft,
   ...applyTextStyles({ fontSize: descriptionFontSize, lineHeight: descriptionLineHeight })
 })
-const selectInputStyles = ({
-  inputBackgroundColor,
-  inputBorderColor,
-  inputBorderWidth,
-  inputOutlineColor,
-  inputOutlineWidth,
-  inputSize
-}) => ({
-  borderColor: inputBorderColor,
-  borderRadius: inputSize / 2,
-  borderWidth: inputBorderWidth,
-  backgroundColor: inputBackgroundColor,
-  height: inputSize,
-  outlineStyle: 'solid',
-  outlineColor: inputOutlineColor,
-  outlineWidth: inputOutlineWidth,
-  width: inputSize
-})
 const selectLabelStyles = ({
   labelColor,
   labelFontName,
@@ -116,99 +90,96 @@ const selectLabelStyles = ({
  * or the internal state in case of uncontrolled radio button.
  *
  */
-const Radio = ({
-  checked,
-  defaultChecked,
-  description,
-  error = false,
-  id,
-  inactive,
-  label,
-  name,
-  onChange,
-  tokens,
-  value,
-  variant,
-  ...rest
-}) => {
-  const { currentValue: isChecked, setValue: setIsChecked, isControlled } = useInputValue(
+const Radio = forwardRef(
+  (
     {
-      value: checked,
-      initialValue: defaultChecked,
-      onChange
+      checked,
+      defaultChecked,
+      description,
+      error = false,
+      id,
+      inactive,
+      label,
+      name: inputName,
+      onChange,
+      tokens,
+      value,
+      variant,
+      ...rest
     },
-    'useRadioValue'
-  )
-  const getTokens = useThemeTokensCallback('Radio', tokens, {
-    checked: isChecked,
-    inactive,
-    error,
-    ...variant
-  })
-  const handleChange = () => {
-    if (!inactive && !isChecked) {
-      setIsChecked(true)
+    ref
+  ) => {
+    const { currentValue: isChecked, setValue: setIsChecked, isControlled } = useInputValue(
+      {
+        value: checked,
+        initialValue: defaultChecked,
+        onChange
+      },
+      'useRadioValue'
+    )
+    const getTokens = useThemeTokensCallback('Radio', tokens, {
+      checked: isChecked,
+      inactive,
+      error,
+      ...variant
+    })
+    const handleChange = (event) => {
+      if (!inactive && !isChecked) {
+        setIsChecked(true, event)
+      }
     }
-  }
-  const accessibilityProps = a11yProps.select(rest)
-  const uniqueId = useUniqueId('radio')
-  const inputId = id ?? uniqueId
+    const handleKeyDown = (event) => {
+      // The expected keyboard shortcut for activating a radio is the Space key
+      if (event?.key === ' ') handleChange(event)
+    }
+    const accessibilityProps = a11yProps.select(rest)
+    const uniqueId = useUniqueId('radio')
+    const inputId = id ?? uniqueId
 
-  // @todo our current version of React Native Web doesn't include
-  // keyboard support on `Pressable` (which starts with 0.15.3), so
-  // the complete accessibility of the `Radio` component on Web
-  // (namely, change on key pressed) is pending RNW upgrade
-  // (see https://github.com/necolas/react-native-web/issues/1950)
-  return (
-    <Pressable
-      disabled={inactive}
-      onPress={handleChange}
-      accessibilityRole="radio"
-      accessibilityState={{ checked: isChecked, disabled: inactive }}
-      {...accessibilityProps}
-    >
-      {({ focused: focus, hovered: hover, pressed }) => {
-        const stateTokens = getTokens({ focus, hover, pressed })
+    return (
+      <Pressable
+        ref={ref}
+        disabled={inactive}
+        onKeyDown={handleKeyDown}
+        onPress={handleChange}
+        accessibilityRole="radio"
+        accessibilityState={{ checked: isChecked, disabled: inactive }}
+        {...accessibilityProps}
+      >
+        {({ focused: focus, hovered: hover, pressed }) => {
+          const stateTokens = getTokens({ focus, hover, pressed })
 
-        return (
-          <StackView space={0}>
-            <View style={[staticStyles.container, selectContainerStyles(stateTokens)]}>
-              <View
-                style={StyleSheet.flatten([
-                  staticStyles.defaultInputStyles,
-                  selectInputStyles(stateTokens, isChecked)
-                ])}
-                testID="Radio-Input"
-              >
-                {/* Add a real input on Web, skip on native platforms */}
-                <RadioInput
-                  checked={isChecked}
-                  defaultChecked={defaultChecked}
-                  disabled={inactive}
-                  id={inputId}
+          return (
+            <StackView space={0}>
+              <View style={[staticStyles.container, selectContainerStyles(stateTokens)]}>
+                <RadioButton
+                  tokens={selectRadioButtonTokens(stateTokens)}
                   isControlled={isControlled}
-                  name={name}
+                  isChecked={isChecked}
+                  inactive={inactive}
+                  defaultChecked={defaultChecked}
+                  inputId={inputId}
+                  handleChange={handleChange}
+                  name={inputName}
                   value={value}
                 />
-                {isChecked && (
-                  <View style={selectCheckedStyles(stateTokens)} testID="Radio-Checked" />
+                {Boolean(label) && (
+                  <Text style={selectLabelStyles(stateTokens)}>
+                    <RadioLabel forId={inputId}>{label}</RadioLabel>
+                  </Text>
                 )}
               </View>
-              {Boolean(label) && (
-                <Text style={selectLabelStyles(stateTokens)}>
-                  <RadioLabel forId={inputId}>{label}</RadioLabel>
-                </Text>
+              {Boolean(description) && (
+                <Text style={selectDescriptionStyles(getTokens())}>{description}</Text>
               )}
-            </View>
-            {Boolean(description) && (
-              <Text style={selectDescriptionStyles(getTokens())}>{description}</Text>
-            )}
-          </StackView>
-        )
-      }}
-    </Pressable>
-  )
-}
+            </StackView>
+          )
+        }}
+      </Pressable>
+    )
+  }
+)
+Radio.displayName = 'Radio'
 
 Radio.propTypes = {
   ...a11yProps.propTypes,
@@ -265,6 +236,5 @@ Radio.propTypes = {
 export default Radio
 
 const staticStyles = StyleSheet.create({
-  container: { flexDirection: 'row', alignItems: 'center' },
-  defaultInputStyles: { alignItems: 'center', justifyContent: 'center' }
+  container: { flexDirection: 'row', alignItems: 'center' }
 })

package/src/Radio/RadioButton.jsx

@@ -0,0 +1,142 @@
+import React, { forwardRef } from 'react'
+import PropTypes from 'prop-types'
+import { Platform, StyleSheet, View } from 'react-native'
+
+import RadioInput from './RadioInput'
+import { applyOuterBorder, resolveThemeTokens, validateThemeTokens } from '../ThemeProvider'
+import { getTokensSetPropType, selectTokens } from '../utils'
+
+// TODO: roll out a standard approach to token sets
+// https://github.com/telus/universal-design-system/issues/782
+const tokenKeys = [
+  'checkedBackgroundColor',
+  'checkedSize',
+  'inputBackgroundColor',
+  'inputBorderColor',
+  'inputBorderWidth',
+  'inputOutlineColor',
+  'inputOutlineWidth',
+  'inputSize',
+  'outerBorderColor',
+  'outerBorderWidth',
+  'outerBorderGap',
+  'inputSize'
+]
+
+export const selectRadioButtonTokens = (themeTokens, prefix) =>
+  selectTokens(tokenKeys, themeTokens, prefix)
+
+const getBorderRadius = (inputSize) => inputSize / 2
+
+const selectCheckedStyles = ({ checkedBackgroundColor, checkedSize }) => ({
+  backgroundColor: checkedBackgroundColor,
+  borderRadius: checkedSize / 2,
+  height: checkedSize,
+  width: checkedSize
+})
+
+const selectInputStyles = ({
+  inputBackgroundColor,
+  inputBorderColor,
+  inputBorderWidth,
+  inputOutlineColor,
+  inputOutlineWidth,
+  inputSize
+}) => ({
+  borderColor: inputBorderColor,
+  borderRadius: getBorderRadius(inputSize),
+  borderWidth: inputBorderWidth,
+  backgroundColor: inputBackgroundColor,
+  height: inputSize,
+  width: inputSize,
+  ...Platform.select({
+    web: {
+      outlineStyle: 'solid',
+      outlineColor: inputOutlineColor,
+      outlineWidth: inputOutlineWidth
+    }
+  })
+})
+
+const selectOuterBorderStyles = ({
+  outerBorderColor,
+  outerBorderWidth,
+  outerBorderGap,
+  inputSize
+}) => ({
+  ...applyOuterBorder({
+    outerBorderColor,
+    outerBorderWidth,
+    outerBorderGap,
+    borderRadius: getBorderRadius(inputSize)
+  })
+})
+
+/**
+ * The visual toggle of a radio input. Is not interactive on its own, should be used inside
+ * an interactive parent that passes down props when interacted with.
+ */
+const RadioButton = forwardRef(
+  (
+    {
+      isChecked,
+      tokens,
+      inactive,
+      defaultChecked,
+      inputId,
+      isControlled,
+      handleChange,
+      name: inputName,
+      value
+    },
+    ref
+  ) => {
+    const themeTokens = validateThemeTokens(
+      resolveThemeTokens(tokens, { checked: isChecked }),
+      getTokensSetPropType(tokenKeys),
+      'RadioButton'
+    )
+
+    return (
+      <View style={selectOuterBorderStyles(themeTokens)}>
+        <View
+          style={[staticStyles.defaultInputStyles, selectInputStyles(themeTokens, isChecked)]}
+          testID="Radio-Input"
+        >
+          {/* Add a real input on Web, skip on native platforms */}
+          <RadioInput
+            ref={ref}
+            checked={isChecked}
+            defaultChecked={defaultChecked}
+            disabled={inactive}
+            id={inputId}
+            isControlled={isControlled}
+            onChange={handleChange}
+            name={inputName}
+            value={value}
+          />
+          {isChecked && <View style={selectCheckedStyles(themeTokens)} testID="Radio-Checked" />}
+        </View>
+      </View>
+    )
+  }
+)
+RadioButton.displayName = 'RadioButton'
+
+RadioButton.propTypes = {
+  isChecked: PropTypes.bool,
+  tokens: getTokensSetPropType(tokenKeys, { allowFunction: true }),
+  inactive: PropTypes.bool,
+  defaultChecked: PropTypes.bool,
+  inputId: PropTypes.string,
+  isControlled: PropTypes.bool,
+  handleChange: PropTypes.func,
+  name: PropTypes.string,
+  value: PropTypes.bool
+}
+
+const staticStyles = StyleSheet.create({
+  defaultInputStyles: { alignItems: 'center', justifyContent: 'center' }
+})
+
+export default RadioButton