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

package/src/utils/input.js

@@ -1,4 +1,4 @@
-import { useCallback, useState } from 'react'
+import { useCallback, useRef, useState } from 'react'
 
 const pluralHooks = ['useMultipleInputValues']
 
@@ -44,16 +44,18 @@ Consumers of this hook must be one of:
  * management tools such as Formik and React Hooks Form.
  *
  * @param {object} props
- * @param {any} [props.value] - for a controlled input, the active values as set by a parent
- * @param {any} [props.initialValue] - for an uncontrolled input, the default active values
+ * @param {string|number|null} [props.value] - for a controlled input, the active values as set by a parent
+ * @param {string|number} [props.initialValue] - for an uncontrolled input, the default active values
  * @param {function} [props.onChange] - function called when values change (required for controlled inputs)
  * @param {boolean} [props.readOnly] - if true, stops the input values from changing
  *
  * @param {string} hookName - optional, used for tailoring error messages
  *
+ * @typedef {(oldValue: string|number|null) => string|number|null} UpdaterFunction - `setValue` takes a value or
+ *          a function returning a new value from the old value
  * @returns {{
- *   currentValue: any
- *   setValue: (value: any) => void
+ *   currentValue: string|number|null
+ *   setValue: (newValue: string|number|null|UpdaterFunction) => void
  *   resetValue: () => void
  *   isControlled: bool
  * }}
@@ -70,17 +72,21 @@ export const useInputValue = (props = {}, hookName = 'useInputValue') => {
 
   // Store the first valid value, for resetting input to default. If behaviour like Formik's `enableReinitialize`
   // is needed, add useEffect calling a set fn if !deepEqual(initializedValues, initialValues)
-  const [initializedValue] = useState(currentValue)
+  const valueRef = useRef({ initial: currentValue, value: currentValue })
+  // Make current value accessible inside useCallback without rememoizing every time the value changes
+  valueRef.current.value = currentValue
 
   const setValue = useCallback(
-    (newValue) => {
+    (arg) => {
       if (readOnly) return
-      if (onChange) onChange(newValue)
+      const newValue = typeof arg === 'function' ? arg(valueRef.current.value) : arg
+      // Only call onChange if the value actually changed
+      if (onChange && valueRef.current.value !== newValue) onChange(newValue)
       if (!isControlled) setOwnValue(newValue)
     },
     [isControlled, onChange, readOnly]
   )
-  const resetValue = useCallback(() => setValue(initializedValue), [initializedValue, setValue])
+  const resetValue = useCallback(() => setValue(valueRef.current.initial), [setValue])
 
   return { currentValue, setValue, resetValue, isControlled }
 }
@@ -94,18 +100,20 @@ export const useInputValue = (props = {}, hookName = 'useInputValue') => {
  * management tools such as Formik and React Hooks Form.
  *
  * @param {object} props
- * @param {any[]} [props.values] - for a controlled input, the active values as set by a parent
- * @param {any[]} [props.initialValues] - for an uncontrolled input, the default active values
+ * @param {string[]|number[]} [props.values] - for a controlled input, the active values as set by a parent
+ * @param {string[]|number[]} [props.initialValues] - for an uncontrolled input, the default active values
  * @param {number?} [props.maxValues] - maximum number of values that may be selected at once (no limit if null)
  * @param {function} [props.onChange] - function called when values change (required for controlled inputs)
  * @param {boolean} [props.readOnly] - if true, stops the input values from changing
  *
  * @param {string} componentName - optional, used in error messages
  *
+ * @typedef {(oldValues: string[]|number[]) => string[]|number[]} UpdaterFunction - `setValues` takes values or
+ *          a function returning new values from old values
  * @returns {{
  *   currentValues: any
  *   resetValues: () => void
- *   setValues: (newValues: any[]) => void
+ *   setValues: (newValues: string[]|number[]|UpdaterFunction) => void
  *   toggleOneValue: (value: string|number) => void
  *   unsetValues: () => void
  * }}

package/src/utils/pressability.js

@@ -0,0 +1,96 @@
+import { Platform, StyleSheet } from 'react-native'
+import { pressProps } from './propTypes'
+
+/**
+ * @typedef {import('react').ReactNode} ReactNode
+ */
+
+// These roles should result in cursor: pointer but don't in current RNW releases
+const shouldUseCursor = ['checkbox', 'radio', 'switch']
+
+/**
+ * React Native Web has some built-in logic for applying cursor styles based on accessibility roles;
+ * however, it misses certain cases. This fills in known cases where widely used versions of RNW
+ * fail to apply an expected cursor style.
+ *
+ * @param {object} props
+ * @param {boolean} [props.inactive]
+ * @param {boolean} [props.disabled]
+ * @param {string} [props.accessibilityRole]
+ * @returns
+ */
+export const getCursorStyle = ({ inactive, disabled, accessibilityRole }) => {
+  if (Platform.OS !== 'web') return undefined
+
+  if (inactive || disabled) return staticStyles.notAllowed
+  if (shouldUseCursor.includes(accessibilityRole)) return staticStyles.pointer
+
+  return undefined // allows React Native Web's built-in logic to apply
+}
+
+/**
+ * @typedef {{ pressed: boolean, focused: boolean, hovered?: boolean }} PressableState
+ */
+
+/**
+ * Maps the state object given by the React Native `Pressable` component to the set of
+ * equivalent appearance names used in UDS.
+ *
+ * @param {PressableState} pressableState - state object passed by React Native's `<Pressable>` into
+ *   render functions passed to its `style` or `children` props.
+ * @param {object} [additionalState] - properties specific to the current component,
+ *   such as `inactive`, `selected`, etc.
+ * @returns {object}
+ */
+export const resolvePressableState = (
+  { pressed = false, focused = false, hovered = false } = {},
+  additionalState
+) => ({
+  ...additionalState,
+  focus: focused,
+  hover: hovered,
+  pressed
+})
+
+/**
+ * Takes a UDS `tokens` prop and, if it is a function, resolves it based on a state
+ * object passed from the React Native `Pressable` component and optional extra properties.
+ *
+ * @param {object|function} tokens - UDS system tokens prop
+ * @param {PressableState} pressableState - state object passed by React Native's `<Pressable>`
+ * @param {object} [additionalState] - properties specific to the current component
+ * @returns {object} - resolved tokens object
+ */
+export const resolvePressableTokens = (tokens, pressableState, additionalState) => {
+  if (typeof tokens !== 'function') return tokens
+  const udsPressableState = resolvePressableState(pressableState, additionalState)
+  return tokens(udsPressableState)
+}
+
+const staticStyles = StyleSheet.create(
+  Platform.select({
+    web: {
+      notAllowed: { cursor: 'not-allowed' },
+      pointer: { cursor: 'pointer' }
+    },
+    default: {}
+  })
+)
+
+/**
+ * From an object of props, extracts any platform-appropriate press handler functions and wraps
+ * them in a function that passes in some provided args. Allows components containing a Pressable
+ * to pass in press handlers that are then called with state or values that is otherwise internal.
+ */
+export const getPressHandlersWithArgs = (pressableProps = {}, args = []) => {
+  // Allow handlers to be passed down for blur, hover, focus, pressIn, etc
+  const pressHandlers = Object.fromEntries(
+    Object.entries(pressProps.selectHandlers(pressableProps)).map(([key, handler]) => ({
+      [key]: (...defaultArgs) => {
+        // Pass each handler data on this button and current selection
+        handler(...args, ...defaultArgs)
+      }
+    }))
+  )
+  return pressHandlers
+}

package/src/utils/propTypes.js

@@ -1,6 +1,24 @@
 import PropTypes from 'prop-types'
 import { Linking, Platform } from 'react-native'
-import { tokenKeys } from '@telus-uds/tools-theme'
+import { components as tokenKeys } from '@telus-uds/system-themes/schema'
+
+export const paddingProp = {
+  propType: PropTypes.shape({
+    paddingBottom: PropTypes.number,
+    paddingLeft: PropTypes.number,
+    paddingRight: PropTypes.number,
+    paddingTop: PropTypes.number
+  })
+}
+
+export const rectProp = {
+  propType: PropTypes.shape({
+    bottom: PropTypes.number,
+    left: PropTypes.number,
+    right: PropTypes.number,
+    top: PropTypes.number
+  })
+}
 
 /**
  * @typedef {{[key: string]: string|number|boolean}} AppearanceSet
@@ -21,29 +39,61 @@ export const variantProp = {
   )
 }
 
-// Tokens can be primitive values (e.g. `'rgba(0,0,0,0'`, `12`), or objects of such values
-// such as tokens that describe shadow (e.g. shadow: { inset: true, color: 'rgba(...)' ... })
-const tokenValue = PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool])
+// Tokens can be primitive values (e.g. `'rgba(0,0,0,0'`, `12`), or objects of such values,
+// such as tokens that describe shadow (e.g. shadow: { inset: true, color: 'rgba(...)' ... }),
+// or components (e.g. Icon tokens)
+const tokenValue = PropTypes.oneOfType([
+  PropTypes.string,
+  PropTypes.number,
+  PropTypes.bool,
+  PropTypes.elementType
+])
 const tokenValueType = PropTypes.oneOfType([tokenValue, PropTypes.objectOf(tokenValue)])
 
-const getTokenNames = (componentName) => {
+export const getTokenNames = (componentName) => {
   const componentTokenNames = tokenKeys[componentName]
   if (!componentTokenNames) {
-    throw new Error(`No "${componentName}" tokenKeys in @telus-uds/tools-theme`)
+    throw new Error(`No "${componentName}" tokenKeys in @telus-uds/system-themes/schema`)
   }
   return componentTokenNames
 }
 
 /**
  * Returns the subset of a set of tokens that may be accepted by the `tokens` prop of a named component
+ * or by a provided array of tokens. A prefix may be provided, for example:
+ *
+ * @example
+ * ```jsx
+ * // returns tokens from `themeTokens` that exist in the theme schema for `Button`.
+ * selectTokens('Button', themeTokens)
+ * ```
+ *
+ * @example
+ * ```jsx
+ * // returns `{ backgroundColor, width }` where the values of those keys come from
+ * // the source object's `{ containerBackgroundColor, containerWidth }` properties.
+ * selectTokens(['backgroundColor', 'width'], themeTokens, 'container')
+ * ```
+ *
+ * @example
+ * ```jsx
+ * // returns tokens that are defined in the `Button` theme schema, from tokens with
+ * // a prefix `'button'` e.g. a token `buttonBorderWidth` outputs as `borderWidth`.
+ * selectTokens('Button', themeTokens, 'button')
+ * ```
+ *
+ * @param {string[]|string} specifier - a name of a component in the theme schema, or an array of token names
+ * @param {object} tokens - a source object of theme tokens
+ * @param {string} [prefix] - if provided, matches keys in the source object with this as the first camelCase item
+ * @returns {object} - subset of theme tokens
  */
-export const selectTokens = (componentName, tokens) => {
-  const tokenNames = getTokenNames(componentName)
-  const filteredTokens = Object.entries(tokens).reduce(
-    (validTokens, [key, value]) =>
-      tokenNames.includes(key) ? { ...validTokens, [key]: value } : validTokens,
-    {}
-  )
+export const selectTokens = (specifier, tokens, prefix) => {
+  const tokenNames = typeof specifier === 'string' ? getTokenNames(specifier) : specifier
+  const filteredTokens = tokenNames.reduce((validTokens, key) => {
+    const prefixedKey = prefix ? `${prefix}${key[0].toUpperCase()}${key.slice(1)}` : key
+    const token = tokens[prefixedKey]
+    return token !== undefined ? { ...validTokens, [key]: token } : validTokens
+  }, {})
   return filteredTokens
 }
 
@@ -59,14 +109,83 @@ export const selectTokens = (componentName, tokens) => {
  *
  * This prop is intended to be used as an 'escape hatch' for difficult or exceptional cases
  * where the main theming system doesn't apply. It is intentionally permissive about values.
+ *
+ * @param {...string} componentsNames - one or more ComponentName, which tokens keys are accepted
+ * @return {function} - a custom PropTypes validator
+ *
+ * @example
+ * Component.propTypes = {
+ *   // accepts all tokens keys defined in Component schema
+ *   tokens: getTokensPropType('Component')
+ * }
+ *
+ * Component.propTypes = {
+ *   // accepts all tokens keys defined in schemas for Component1 and Component2
+ *   tokens: getTokensPropType('Component1', 'Component2')
+ * }
+ */
+export const getTokensPropType = (...componentsNames) => (props, propName, componentName) => {
+  PropTypes.checkPropTypes(
+    {
+      [propName]: PropTypes.oneOfType([PropTypes.object, PropTypes.func])
+    },
+    props,
+    propName,
+    componentName
+  )
+
+  if (typeof props[propName] !== 'function') {
+    PropTypes.checkPropTypes(
+      {
+        [propName]: PropTypes.exact(
+          Object.fromEntries(
+            componentsNames.flatMap((component) =>
+              getTokenNames(component).map((key) => [key, tokenValueType])
+            )
+          )
+        )
+      },
+      props,
+      propName,
+      componentName
+    )
+  }
+}
+
+/**
+ * Get a proptypes validator for a set of tokens that is not based on a component in the theme schema.
+ *
+ * For example, for a set of tokens used in a common style, or for a set of tokens required by
+ * a themeless component whose tokens are set by a parent but requires tokens of a certain shape.
+ *
+ * By default, requires an object with a complete set of tokens (allowing `null`, but not `undefined`).
+ *
+ * @param {string[]} componentTokenKeys - array of strings of token names
+ * @param {object} [options]
+ * @param {boolean} [options.partial] - if true, allows tokens to be undefined
+ * @param {boolean} [options.allowFunction] - if true, allows functions as well as tokens objects
+ * @returns
  */
-export const getTokensPropType = (componentName) =>
-  PropTypes.oneOfType([
-    PropTypes.shape(
-      Object.fromEntries(getTokenNames(componentName).map((key) => [key, tokenValueType]))
-    ),
-    PropTypes.func // function that takes current appearances and returns above shape
-  ])
+export const getTokensSetPropType = (
+  componentTokenKeys,
+  { partial = false, allowFunction = false } = {}
+) => {
+  const tokensObjectValidator = PropTypes.exact(
+    Object.fromEntries(
+      componentTokenKeys.map((key) => [
+        key,
+        partial
+          ? tokenValueType
+          : // Some theme tokens can validly resolve to `null`, but .isRequired treats null as undefined
+            (props, propName, ...args) =>
+              props[propName] !== null && tokenValueType.isRequired(props, propName, ...args)
+      ])
+    )
+  )
+  return allowFunction
+    ? PropTypes.oneOfType([tokensObjectValidator, PropTypes.func])
+    : tokensObjectValidator
+}
 
 function getPropSelector(propTypes, regexp) {
   const keys = Object.keys(propTypes)
@@ -86,7 +205,6 @@ function getPropSelector(propTypes, regexp) {
 // React Native exports a11y prop definitions as TypeScript Interfaces, but no longer exports PropTypes
 // so we have to define them ourselves.
 const a11yPropTypes = {
-  // react-native-web >= 0.15.0 ignores `accessible` and looks for `focusable`
   accessible: PropTypes.bool,
   focusable: PropTypes.bool,
 
@@ -139,10 +257,9 @@ export const a11yProps = {
    * Use this to disable focus for elements which are visually hidden but still rendered.
    */
   nonFocusableProps: {
-    focusable: false, // for android, and for keyboard nav in web (RNW >= 0.15.x)
+    focusable: false, // for android, and for keyboard nav in web
     ...Platform.select({
       web: {
-        accessible: false, // workaround for web keyboard nav in RNW < 0.15.x
         accessibilityHidden: true // web screenreaders
       },
       android: {
@@ -152,7 +269,27 @@ export const a11yProps = {
         accessibilityElementsHidden: true
       }
     })
-  }
+  },
+  /**
+   * Generates an object of platform-appropriate a11y props describing an item that has an
+   * ordered position in a set. Examples of usage by accessibility tools includes screenreaders
+   * saying "Item X of Y" when this item is select.
+   *
+   * @param {number} itemsCount - the number of items in the set
+   * @param {number} index - the current item's index in the set
+   * @returns {object} - platform-applicable a11y props describing this position (if available)
+   */
+  getPositionInSet: (itemsCount, index) =>
+    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': itemsCount,
+        'aria-posinset': index + 1
+      },
+      // No equivalents exist on the native side
+      default: {}
+    })
 }
 
 // Props related to HTML <a> anchor link attributes.
@@ -176,30 +313,10 @@ export const hrefAttrsProp = {
       target
     },
     rest
-  }),
-  /**
-   * Takes a hrefAttrs object and returns an object that can be spread into Pressable props
-   * in a way that handles compatibility before and after React Native Web 0.15.0
-   */
-  spread: (hrefAttrs) => ({
-    /**
-     * React Native Web >= 0.15.0 supports hrefAttrs prop but requires React 17
-     * so is incompatible with Expo until July 2021
-     */
-    hrefAttrs,
-    /**
-     * React Native Web < 0.15.0 uses `target` and `rel` props.
-     * React Native Web >= 0.15.0 ignores these and reads hrefAttrs only.
-     */
-    rel: hrefAttrs?.rel,
-    target: hrefAttrs?.target
-    /**
-     * Don't spread hrefAttrs.download, RNW <0.15.0 doesn't support it.
-     */
   })
 }
 
-const pressPropTypes = {
+const pressHandlerPropTypes = {
   onPress: PropTypes.func,
   onPressIn: PropTypes.func,
   onPressOut: PropTypes.func,
@@ -210,7 +327,18 @@ const pressPropTypes = {
       onFocus: PropTypes.func,
       onBlur: PropTypes.func
     },
-    default: {}
+    default: {
+      onLongPress: PropTypes.func
+    }
+  })
+}
+
+const pressPropTypes = {
+  ...pressHandlerPropTypes,
+  disabled: PropTypes.bool,
+  ...Platform.select({
+    hitSlop: PropTypes.number,
+    pressRetentionOffset: PropTypes.oneOfType([PropTypes.number, rectProp.propType])
   })
 }
 
@@ -222,7 +350,8 @@ export const pressProps = {
   /**
    * Filters a props object, returning only the platform-relevant press props defined above
    */
-  select: getPropSelector(pressPropTypes)
+  select: getPropSelector(pressPropTypes),
+  selectHandlers: getPropSelector(pressHandlerPropTypes)
 }
 
 const linkPropTypes = {
@@ -261,6 +390,25 @@ export const linkProps = {
   }
 }
 
+const viewPropTypes = {
+  pointerEvents: PropTypes.oneOf(['all', 'none', 'box-only', 'box-none']),
+  onLayout: PropTypes.func,
+  nativeID: PropTypes.string
+}
+
+export const viewProps = {
+  /**
+   * Subset of `View` proptypes that could conceivably be needed on any component
+   * that renders a single View.
+   */
+  types: viewPropTypes,
+  /**
+   * Filters a props object, returning only cross-platform View props that are potentially
+   * relevant to any basic layout component that renders one View.
+   */
+  select: getPropSelector(viewPropTypes)
+}
+
 const getByViewport = (propType) => ({
   xs: propType,
   sm: propType,
@@ -427,12 +575,3 @@ export const componentPropType = (passedName, checkDisplayName = false) => {
 }
 
 export const copyPropTypes = PropTypes.oneOf(['en', 'fr'])
-
-export const paddingProp = {
-  propType: PropTypes.shape({
-    paddingBottom: PropTypes.number,
-    paddingLeft: PropTypes.number,
-    paddingRight: PropTypes.number,
-    paddingTop: PropTypes.number
-  })
-}

package/src/utils/useCopy.js

@@ -0,0 +1,39 @@
+export const DEFAULT_COPY = 'en'
+
+/**
+ * Extract translations from a keyed dictionary for a given language.
+ * Returns a getter.
+ *
+ * @example
+ * const getCopy = useCopy({
+ *   copy: 'en',
+ *   dictionary: {
+ *     en: { label: 'english label' },
+ *     fr: { label: 'french label' }
+ *   }
+ * })
+ *
+ * getCopy('label') => 'english label'
+ *
+ * @description The entire dictionary may be overridden by simply passing a single language object as `copy`:
+ * @example
+ * const getCopy = useCopy({
+ *   copy: { label: 'custom label' }
+ * })
+ *
+ * getCopy('label') => 'custom label'
+ *
+ * @param {object} [dictionary]
+ * @param {'en'|'fr'|object} copy - language
+ * @return {function(string): string}
+ */
+function useCopy({ dictionary, copy = DEFAULT_COPY }) {
+  if (typeof copy === 'string') {
+    return (key) => dictionary[copy][key]
+  }
+
+  // support overriding the entire copy dictionary with an object for a single language
+  return (key) => copy[key]
+}
+
+export default useCopy

package/src/utils/useHash.js

@@ -0,0 +1,34 @@
+import { useEffect, useState } from 'react'
+
+const doAction = (action) => typeof action === 'function' && action(window?.location?.hash)
+
+/**
+ * Calls a function (passing it the current hash) based on the current hash state on mount,
+ * and binds it to call it again any time the hash changes.
+ *
+ * Consider using `useCallback` on the function to minimise adding and removing of event listeners.
+ *
+ * On Native, this is replaced with a harmless no-op function as there is no direct equivalent.
+ *
+ * @param {(hash: string) => void} action - a function to act on the current hash on load and when it changes
+ * @returns
+ */
+const useHash = (action, isReady = true) => {
+  const [isDone, setIsDone] = useState(false)
+  // Do the action just once when ready after component mount, from hash on page load
+  const isToDo = isReady && !isDone
+  useEffect(() => {
+    if (isToDo) {
+      setIsDone(true)
+      doAction(action)
+    }
+  }, [isToDo, action])
+
+  // Bind the action for each hash change; do re-bind if the function changes.
+  useEffect(() => {
+    const handleChange = () => doAction(action)
+    window.addEventListener('hashchange', handleChange)
+    return () => window.removeEventListener('hashchange', handleChange)
+  }, [action])
+}
+export default useHash

package/src/utils/useHash.native.js

@@ -0,0 +1,6 @@
+/**
+ * No URL hashes on Native, so do a no-op. Remembering scenes for reloads
+ * is handled at OS level and deep links have completely different usage.
+ */
+const useHash = () => {}
+export default useHash

package/src/utils/useResponsiveProp.js

@@ -0,0 +1,50 @@
+import { viewports } from '@telus-uds/system-constants'
+import { useViewport } from '../ViewportProvider'
+
+const hasOwn = (objectProp, key) => Object.prototype.hasOwnProperty.call(objectProp, key)
+const hasResponsiveProperties = (objectProp) =>
+  viewports.keys.some((key) => hasOwn(objectProp, key))
+
+/**
+ * Resolves a prop which may be a responsive object with keys for viewports.
+ *
+ * Used internally in useResponsiveProp - see that for more details.
+ *
+ * @param {*} prop
+ * @param {"xs"|"sm"|"md"|"lg"|"xl"} viewport
+ * @param {*} [defaultValue]
+ * @returns {*}
+ */
+export const resolveResponsiveProp = (prop, viewport, defaultValue) => {
+  if (prop === undefined) return defaultValue
+  if (!prop || typeof prop !== 'object' || !hasResponsiveProperties(prop)) return prop
+
+  const value = viewports.keys.includes(viewport)
+    ? // If there's a current viewport, return the closest match at or below it
+      viewports.inherit(prop)[viewport]
+    : // If no current viewport is available, default to smallest viewport
+      prop[viewports.keys.find((key) => hasOwn(prop, key))]
+
+  return value === undefined ? defaultValue : value
+}
+
+/**
+ * Takes any value and, if that value is a responsive prop (an object with one or more
+ * keys matching system viewport names), returns the value corresponding to the largest
+ * viewport key smaller than the current screen's viewport.
+ *
+ * For example, if passed `{ sm: 4, lg: 8 }`, it will return 8 on `xl` and `lg` viewports,
+ * 4 on `md` and `sm` viewports, and `undefined` (or a provided `defaultValue`) on `xs` viewports.
+ *
+ * To generate propTypes for responsive props, see `responsiveProps` in `./utils/propTypes.js`.
+ *
+ * @param {*} prop - any value which may be an object with viewport keys
+ * @param {*} [defaultValue] - default value to provide if no matches found for the current viewport
+ * @returns {*}
+ */
+const useResponsiveProp = (prop, defaultValue) => {
+  const viewport = useViewport()
+  return resolveResponsiveProp(prop, viewport, defaultValue)
+}
+
+export default useResponsiveProp