@telus-uds/components-base 0.0.2-prerelease.6 → 1.0.0

package/src/utils/a11y/semantics.js

@@ -0,0 +1,162 @@
+import { Platform } from 'react-native'
+/**
+ * @typedef {import('react-native').AccessibilityRole} AccessibilityRole
+ */
+
+/**
+ * This is based on the role-to-tag mapping that React Native Web uses to set HTML tags.
+ * It's not exported in any way from RNW, so we need to keep this up-to-date manually.
+ * https://github.com/necolas/react-native-web/blob/master/packages/react-native-web/src/modules/AccessibilityUtil/propsToAccessibilityComponent.js
+ *
+ * Note: every role in this list is a web-only aria-role. There is no overlap between _these_ web tags
+ * or roles and native accessibilityRoles. Only h1, h2, h3 etc map to an RN equivalent ("heading").
+ *
+ * - RN "summary" native role maps to "region" aria-role, but setting `<section>`/"region" does not
+ *   set React Native's "summary" role, which has a much narrower use case.
+ * - `<Header>`/"Banner" also do not map to RN's "heading". Only h1 / h2 etc map to RN "heading".
+ *
+ * Therefore, all of these tags / roles default to no accessibilityRole in native apps. This is not wrong:
+ * in general, RN accessibilityRoles tend to be more about interaction and less about semantics than web roles.
+ *
+ * RNW's one-way mapping of React Native accessibilityRoles to web aria-roles:
+ * https://github.com/necolas/react-native-web/blob/master/packages/react-native-web/src/modules/AccessibilityUtil/propsToAriaRole.js
+ */
+// Adding `/** @type {const} */ ({...})` denotes object content as `readonly` in many IDEs
+// eslint-disable-next-line prettier/prettier
+const rolesToTags = /** @type {const} */ ({
+  article: 'article',
+  banner: 'header',
+  blockquote: 'blockquote',
+  code: 'code',
+  complementary: 'aside',
+  contentinfo: 'footer',
+  deletion: 'del',
+  emphasis: 'em',
+  figure: 'figure',
+  insertion: 'ins',
+  form: 'form',
+  list: 'ul',
+  listitem: 'li',
+  main: 'main',
+  navigation: 'nav',
+  region: 'section',
+  strong: 'strong',
+
+  // Add special cases that are in RNW's function logic but not in its mapping object
+  label: 'label'
+  // eslint-disable-next-line prettier/prettier
+})
+
+// Invert React Native Web's mapping, so a tag gets the role that gets that tag
+export const tagsToRoles = Object.fromEntries(
+  Object.entries(rolesToTags).map(([key, value]) => [value, key])
+)
+
+/**
+ * Heading HTML tags map to the "heading" accessibilityRole in native apps, which is similar
+ * to headings on web but without the expectation of a hierarchy of headings within one screen.
+ */
+// eslint-disable-next-line prettier/prettier
+export const headingTags = /** @type {const} */ (['h1', 'h2', 'h3', 'h4', 'h5', 'h6'])
+/**
+ * @typedef {typeof headingTags[number]} HeadingTag
+ */
+
+/**
+ * All HTML tags that may be set via RNW accesibility props alone and therefore may be set using
+ * the getA11yPropsFromHtmlTag function without changing other behaviour.
+ *
+ * Of these, only headers (h1, h2, ...h5, h6) set a corresponding accessibilityRole in native apps ("heading").
+ */
+export const supportedTags = [...Object.keys(tagsToRoles), ...headingTags]
+/**
+ * Uses readonly mapping keys/values to generate static types for IDEs that support TS in JSDoc.
+ * @typedef {keyof rolesToTags} RoleWithTag
+ * @typedef {typeof rolesToTags[RoleWithTag] | typeof headingTags[number]} SupportedTag
+ */
+
+/**
+ * Subset of supported HTML tags that may be used with layout containers like Box.
+ *
+ * Of these, only headers (h1, h2, ...h5, h6) set a corresponding accessibilityRole in native apps ("heading").
+ */
+// eslint-disable-next-line prettier/prettier
+export const layoutTags = /** @type {const} */ ([
+  ...headingTags,
+  'article',
+  'aside',
+  'blockquote',
+  'footer',
+  'figure',
+  'form',
+  'header',
+  'ul',
+  'li',
+  'main',
+  'nav',
+  'section',
+  'label'
+  // eslint-disable-next-line prettier/prettier
+])
+/**
+ * @typedef {typeof layoutTags[number]} LayoutTag
+ */
+
+/**
+ * Subset of supported HTML tags that may be used with text elements like Typography.
+ *
+ * Of these, only headers (h1, h2, ...h5, h6) set a corresponding accessibilityRole in native apps ("heading").
+ */
+// eslint-disable-next-line prettier/prettier
+export const textTags = /** @type {const} */ ([
+  ...headingTags,
+  'blockquote',
+  'code',
+  'del',
+  'em',
+  'ins',
+  'li',
+  'strong',
+  'label'
+  // eslint-disable-next-line prettier/prettier
+])
+/**
+ * @typedef {typeof layoutTags[number]} TextTag
+ */
+
+/**
+ * If passed a heading tag string like 'h1', 'h2' etc, returns the heading number as a number
+ * ready for use in `accessibilityLevel` props and similar.
+ *
+ * @param {string} [tag] - HTML tag string; returns undefined if not a {@link HeadingTag}
+ * @returns {'1' | '2' | '3' | '4' | '5' | '6' | undefined}
+ */
+export const getHeadingLevel = (tag) => (headingTags.includes(tag) ? Number(tag[1]) : undefined)
+
+/**
+ * Takes a supported HTML tag, and returns the accessibility props that, on web, make React Native Web
+ * render that tag.
+ *
+ * For cross-platform apps, a second argument may be passed with an [accessibilityRole](https://reactnative.dev/docs/accessibility#accessibilityrole)
+ * to use in native apps. Heading tags (h1, h2, ...h5, h6) map to "heading" role by default;
+ * no other supported semantic HTML tags have an equivalent native accessibilityRole.
+ *
+ * @param {SupportedTag} tag - HTML tag to use on web
+ * @param {AccessibilityRole | null} [nativeRole] - optional accessibilityRole for native apps
+ * @returns {{ accessibilityRole: string, accessibilityLevel?: string } | undefined}
+ */
+export const getA11yPropsFromHtmlTag = (tag, nativeRole) => {
+  // Allow cross-platform apps to set accessibilityRoles alongside a web tag without conflict
+  if (nativeRole !== undefined && Platform.OS !== 'web') return { accessibilityRole: nativeRole }
+
+  if (tag) {
+    const accessibilityRole = tagsToRoles[tag]
+    if (accessibilityRole) return { accessibilityRole }
+
+    const accessibilityLevel = getHeadingLevel(tag)
+    if (accessibilityLevel) return { accessibilityRole: 'header', accessibilityLevel }
+  }
+  // If nothing matches or no tag supplied, return undefined and let component decide how to fall back.
+  // Note that return value may always be spread in objects (it is safe to spread undefined like { ...undefined })
+  return undefined
+}

package/src/utils/a11y/textSize.js

@@ -0,0 +1,30 @@
+import { PixelRatio, Platform } from 'react-native'
+
+/**
+ * When a user increases text size using device accessibility settings, some elements
+ * should also scale, such as icons alongside text and space between paragraphs.
+ *
+ * @param {number} [value] - the value to multiply; defaults to system default font size
+ * @param {number} [maxScale] - the maximum multiplier to apply; defaults to no maximum
+ */
+export const scaleWithText = (value, maxScale = Infinity) => {
+  if (!value) return value
+  const scale = Math.min(PixelRatio.getFontScale(), maxScale) || 1
+  return value * scale
+}
+
+/**
+ * Native only, returns `undefined` on Web.
+ *
+ * Enforces `fontScaleCap` theme tokens as the maximum font size text can become
+ * after iOS or Android font scaling, to give consistent accessible maximum sizes
+ * that don't make the content unusable.
+ *
+ * The return value of this function can be used as a React Native `Text` element's
+ * `maxFontSizeMultiplier` prop value.
+ */
+export const getMaxFontMultiplier = ({ fontSize, fontScaleCap }) => {
+  if (Platform.OS === 'web' || !fontScaleCap || !fontSize) return undefined
+  if (fontScaleCap <= fontSize) return 1
+  return fontScaleCap / fontSize
+}

package/src/utils/children.jsx

@@ -0,0 +1,119 @@
+import React, { Children, Fragment } from 'react'
+import { Text } from 'react-native'
+import A11yText from '../A11yText'
+
+/**
+ * Unpacks top-level fragments, so that common compositional patterns such as the following examples
+ * can be iterated as flat siblings (as if they were `<Child1 /><Child2 /><Child3 />`):
+ *
+ * - Setting `children` as a property wrapped in a fragment:
+ *
+ * ```jsx
+ * args.children = <><Child1 /><Child2 /><Child3 /></>
+ * ```
+ *
+ * - Defining `children` as a variable wrapped in a fragment:
+ *
+ * ```jsx
+ * const content = <><Child1 /><Child2 /><Child3 /></>
+ * if (someCondition) return <SomeWrapper>{content}</SomeWrapper>
+ * ```
+ *
+ * - Using fragments at the top level of a JSX block for conditional rendering:
+ *
+ * ```jsx
+ * <Child1 />
+ * {someCondition && (
+ *   <>
+ *     <Child2 />
+ *     <Child3 />
+ *   </>
+ * )}
+ * ```
+ *
+ * @param {ReactChildren} child
+ * @returns {ReactChildren}
+ */
+export const unpackFragment = (child) => {
+  // If this level is a set of top-level siblings rather than one child, check each in turn
+  if (Children.count(child) > 1) return Children.map(child, unpackFragment)
+
+  // When a fragment is found, unpack its children to the top level and check them
+  if (child?.type === Fragment) return unpackFragment(child.props?.children)
+
+  // Stop unpacking as soon as any non-fragment child is found
+  return child
+}
+
+const isStringOrNumber = (child) => typeof child === 'string' || typeof child === 'number'
+// Wrap an A11yText with neighouring text strings so it doesn't split them into multiple <Text>s
+const isWrapable = (child) => isStringOrNumber(child) || child.type === A11yText
+const combineKeys = (childrenArray) =>
+  childrenArray.reduce((newKey, child) => `${newKey}${child.key || ''}`, '')
+
+// Group wrappable children for one `<Text>` parent, merging adjacent text nodes
+const wrapChild = (child, wrappedText) => {
+  const lastIndex = wrappedText.length - 1
+  // If possible, simplify content by combining text nodes into one string.
+  // jest-native's `.toHaveTextContent` is buggy about array of text nodes in <Text> elements.
+  if (lastIndex >= 0 && isStringOrNumber(child) && isStringOrNumber(wrappedText[lastIndex])) {
+    /* eslint-disable-next-line no-param-reassign */
+    wrappedText[lastIndex] = `${wrappedText[lastIndex]}${child}`
+  } else {
+    wrappedText.push(child)
+  }
+}
+
+/**
+ * React Native on Native crashes if text content is rendered outside `<Text>`, and on web,
+ * text style inheritance behaves differently with text compared to regular HTML.
+ *
+ * Call this function on children that may contain text (strings or numbers) at the top level,
+ * and any that are found will be wrapped in a React Native `<Text>` element with supplied props.
+ *
+ * Note that this does not wrap strings that are nested children of rendered top level children:
+ * `wrapStringsInText(<View>Some text</View>)` will not wrap the inner text and will still crash,
+ * but `wrapStringsInText(<>{someString}{anotherString}</>)` wraps the strings inside the fragment.
+ *
+ * @param {ReactChildren} children
+ * @param {TextProps} props
+ * @returns {ReactChildren}
+ */
+export const wrapStringsInText = (children, textProps = {}) => {
+  const childrenArray = unpackFragment(Children.toArray(children))
+
+  // Group adjacent wrapable children together in one Text element to create as few Text elements
+  // as possible, e.g. give <X>Text {someString}</X> one Text, same as <X>{`Text ${someString}`}</X>
+  const wrapables = [[]]
+  let wrapablesIndex = 0
+  childrenArray.forEach((child) => {
+    if (isWrapable(child)) {
+      // Make this child a child of the current `Text`
+      wrapChild(child, wrapables[wrapablesIndex])
+    } else {
+      // Close current `Text` and start a new one after this child
+      wrapables.push(child, [])
+      wrapablesIndex += 2
+    }
+  })
+
+  const items = wrapables.reduce((flatChildren, group, index) => {
+    // Skip nullish children and empty arrays
+    if (!group || (Array.isArray(group) && !group.length)) return flatChildren
+
+    return [
+      ...flatChildren,
+      Array.isArray(group) && group.some((child) => isStringOrNumber(child)) ? (
+        // Wrap text nodes and their wrappable neighbours in Text with as stable a key as possible.
+        // Avoid one-item arrays because jest-native's `.toHaveTextContent` is buggy
+        // and sometimes fails to match text content in arrays.
+        <Text key={combineKeys(group) || index} {...textProps}>
+          {group.length === 1 ? group[0] : group}
+        </Text>
+      ) : (
+        group
+      )
+    ]
+  }, [])
+  return items.length === 1 ? items[0] : items
+}

package/src/utils/index.js

@@ -1,7 +1,13 @@
+export * from './a11y'
 export * from './animation'
+export * from './children'
 export * from './input'
+export * from './pressability'
 export * from './propTypes'
 
+export { default as info } from './info'
+export { default as useCopy } from './useCopy'
+export { default as useHash } from './useHash'
 export { default as useSpacingScale } from './useSpacingScale'
 export { default as useResponsiveProp } from './useResponsiveProp'
 export * from './useResponsiveProp'

package/src/utils/info/index.js

@@ -0,0 +1,8 @@
+import platform from './platform'
+import versions from './versions'
+
+// export an object accessed like info.platform.OS, info.version.uds, etc
+export default {
+  platform,
+  versions
+}

package/src/utils/info/platform/index.js

@@ -0,0 +1,11 @@
+import { Platform } from 'react-native'
+import fileSuffix from './platform'
+
+// Allows consuming libraries that might not have a direct dependency on
+// React Native to check what the current platform is.
+
+// Particularly useful for validating Jest config: it is possible for Jest to
+// get configured such that Platform.OS returns a different mocked value to the
+// OS being used to select files by platform suffix (e.g. .web, .native).
+
+export default { OS: Platform.OS, fileSuffix }

package/src/utils/info/platform/platform.android.js

@@ -0,0 +1 @@
+export default '.android'

package/src/utils/info/platform/platform.ios.js

@@ -0,0 +1 @@
+export default '.ios'

package/src/utils/info/platform/platform.js

@@ -0,0 +1 @@
+export default '.web (default)'

package/src/utils/info/platform/platform.native.js

@@ -0,0 +1,4 @@
+// This shouldn't ever be chosen, as the more specific '.ios' and '.android' are available.
+// If this gets picked, either an unsupported React Native platform is being used somehow
+// (e.g. a native Windows app), or there's a serious config problem somewhere.
+export default '.native'

package/src/utils/info/versions.js

@@ -0,0 +1,6 @@
+import pkgJson from '../../../package.json'
+
+// Add more versions if they are useful e.g. theme schema version
+export default {
+  uds: pkgJson.version
+}

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, event) => {
       if (readOnly) return
-      if (onChange) onChange(newValue)
+      const newValue = typeof arg === 'function' ? arg(valueRef.current.value) : arg
       if (!isControlled) setOwnValue(newValue)
+      // Call onChange handler if there's something for it to handle (event or a changed value)
+      if (onChange && (event || valueRef.current.value !== newValue)) onChange(newValue, event)
     },
     [isControlled, onChange, readOnly]
   )
-  const resetValue = useCallback(() => setValue(initializedValue), [initializedValue, setValue])
+  const resetValue = useCallback((event) => setValue(valueRef.current.initial, event), [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
  * }}
@@ -138,23 +146,26 @@ export const useMultipleInputValues = ({
   )
   const currentValues = enforceMaxValues(currentValue)
 
-  const setValues = useCallback((newValues) => setValue(enforceMaxValues(newValues)), [
-    setValue,
-    enforceMaxValues
-  ])
+  const setValues = useCallback(
+    (newValues, event) => {
+      const validNewValues = enforceMaxValues(newValues)
+      setValue(validNewValues, event)
+    },
+    [setValue, enforceMaxValues]
+  )
 
   const resetValues = resetValue
-  const unsetValues = useCallback(() => setValues([]), [setValues])
+  const unsetValues = useCallback((event) => setValues([], event), [setValues])
   const toggleOneValue = useCallback(
-    (newValue) => {
+    (newValue, event) => {
       if (readOnly) return
-      setValues(
-        // This will only work with primitive values (e.g. strings, numbers), swap for .some() and
-        // a deepEqual() function if there's any use case for toggling stored objects or arrays.
-        currentValues.includes(newValue)
-          ? currentValues.filter((oldValue) => oldValue !== newValue)
-          : [...currentValues, newValue]
-      )
+      // This will only work with primitive values (e.g. strings, numbers), swap for .some() and
+      // a deepEqual() function if there's any use case for toggling stored objects or arrays.
+      const newValues = currentValues.includes(newValue)
+        ? currentValues.filter((oldValue) => oldValue !== newValue)
+        : [...currentValues, newValue]
+
+      setValues(newValues, event)
     },
     [currentValues, readOnly, setValues]
   )

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
+}