@telus-uds/components-base 0.0.2-prerelease.4 → 0.0.2-prerelease.8

package/src/Tabs/ScrollViewEnd.jsx

@@ -0,0 +1,53 @@
+import React, { forwardRef, useCallback, useEffect } from 'react'
+import PropTypes from 'prop-types'
+import { ScrollView } from 'react-native'
+import debounce from 'lodash.debounce'
+
+const DEBOUNCE_MS = 100
+
+/**
+ * A wrapper for ScrollView that supports an `onScrollEnd` function.
+ *
+ * React Native Web hasn't got around to implementing any scroll end handlers yet,
+ * so we need to work around it with debouncing on `onScroll`. See:
+ * https://github.com/necolas/react-native-web/issues/1021
+ */
+const ScrollViewEnd = forwardRef(({ onScrollEnd, onScroll, ...props }, ref) => {
+  // Return debounced function directly from useCallback so it has .cancel method etc.
+  // Linter complains this stops it automatically scanning the deps, but we can check them manually.
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  const debounceScrollEnd = useCallback(
+    debounce((event) => onScrollEnd(event), DEBOUNCE_MS),
+    [onScrollEnd]
+  )
+
+  // Call any onScroll handler immediately, and any onScrollEnd handler after 100ms of no scrolling
+  const handleScroll = (event) => {
+    if (typeof onScroll === 'function') onScroll(event)
+    if (typeof onScrollEnd === 'function') debounceScrollEnd(event)
+  }
+
+  // Cancel any lingering debounce timeouts on dismount
+  useEffect(() => debounceScrollEnd.cancel)
+
+  return (
+    <ScrollView
+      ref={ref}
+      {...props}
+      onScroll={handleScroll}
+      scrollEventThrottle={DEBOUNCE_MS / 2}
+    />
+  )
+})
+ScrollViewEnd.displayName = 'ScrollViewEnd'
+
+ScrollViewEnd.propTypes = {
+  onScrollEnd: PropTypes.func.isRequired,
+  onScroll: PropTypes.func
+}
+
+ScrollViewEnd.defaultProps = {
+  onScroll: null
+}
+
+export default ScrollViewEnd

package/src/Tabs/ScrollViewEnd.native.jsx

@@ -0,0 +1,24 @@
+import React, { forwardRef } from 'react'
+import PropTypes from 'prop-types'
+import { ScrollView } from 'react-native'
+
+/**
+ * A wrapper for ScrollView that supports an `onScrollEnd` function.
+ *
+ * React Native has two scroll end handlers, we want to treat them both the same.
+ */
+const ScrollViewEnd = forwardRef(({ onScrollEnd, ...props }, ref) => (
+  <ScrollView
+    ref={ref}
+    {...props}
+    onScrollEndDrag={onScrollEnd}
+    onMomentumScrollEnd={onScrollEnd}
+  />
+))
+ScrollViewEnd.displayName = 'ScrollViewEnd'
+
+ScrollViewEnd.propTypes = {
+  onScrollEnd: PropTypes.func.isRequired
+}
+
+export default ScrollViewEnd

package/src/Tabs/Tabs.jsx

@@ -0,0 +1,89 @@
+import React, { useCallback } from 'react'
+import PropTypes from 'prop-types'
+
+import { useThemeTokens } from '../ThemeProvider'
+import StackView from '../StackView'
+import { getTokensPropType, variantProp, useHash, useInputValue } from '../utils'
+import HorizontalScroll, { selectHorizontalScrollTokens } from './HorizontalScroll'
+import TabsItem from './TabsItem'
+import TabsScrollButton from './TabsScrollButton'
+import { useItemPositions } from './itemPositions'
+
+/**
+ * Tabs renders a horizontally-scrolling menu of selectable buttons which may link
+ * to a page or control what content is displayed on this page.
+ */
+const Tabs = ({
+  tokens,
+  itemTokens,
+  scrollButtonTokens,
+  variant,
+  value,
+  initialValue,
+  onChange,
+  items = []
+}) => {
+  const { space, ...themeTokens } = useThemeTokens('Tabs', tokens, variant)
+  const { currentValue, setValue } = useInputValue({ value, initialValue, onChange })
+
+  const [itemPositions, isPositioningReady] = useItemPositions()
+
+  useHash(
+    useCallback(
+      (hash) => {
+        const hashItem = hash && items.find(({ href }) => hash === href)
+        const hashId = hashItem && (hashItem.id || hashItem.label)
+        if (hashId) setTimeout(setValue(hashId), 500)
+      },
+      [items, setValue]
+    ),
+    isPositioningReady
+  )
+
+  return (
+    <HorizontalScroll
+      ScrollButton={TabsScrollButton}
+      itemPositions={itemPositions}
+      tokens={selectHorizontalScrollTokens(themeTokens)}
+      scrollButtonTokens={scrollButtonTokens}
+      accessibilityRole="tablist"
+    >
+      <StackView space={space} direction="row">
+        {items.map(({ href, label, id }, index) => {
+          const itemId = id ?? label
+          const isSelected = Boolean(currentValue && currentValue === itemId)
+          const handlePress = () => setValue(itemId)
+          return (
+            <TabsItem
+              key={itemId}
+              href={href}
+              variant={variant}
+              tokens={itemTokens}
+              onPress={handlePress}
+              selected={isSelected}
+              itemPositions={itemPositions}
+              index={index}
+            >
+              {label}
+            </TabsItem>
+          )
+        })}
+      </StackView>
+    </HorizontalScroll>
+  )
+}
+
+Tabs.propTypes = {
+  items: PropTypes.arrayOf(
+    PropTypes.shape({ href: PropTypes.string, label: PropTypes.string, id: PropTypes.string })
+  ),
+  value: PropTypes.string,
+  initialValue: PropTypes.string,
+  onChange: PropTypes.func,
+  tokens: getTokensPropType('Tabs'),
+  itemTokens: getTokensPropType('TabsItem'),
+  scrollButtonTokens: getTokensPropType('TabsScrollButton'),
+  variant: variantProp.propType
+}
+
+export default Tabs

package/src/Tabs/TabsItem.jsx

@@ -0,0 +1,204 @@
+import React, { useEffect } from 'react'
+import PropTypes from 'prop-types'
+import { Platform, Pressable, StyleSheet, Text, View } from 'react-native'
+import system from '@telus-uds/system-themes/src/tokens/rn'
+
+import { applyTextStyles, useThemeTokensCallback } from '../ThemeProvider'
+import {
+  resolvePressableTokens,
+  selectTokens,
+  variantProp,
+  getTokensPropType,
+  linkProps,
+  a11yProps
+} from '../utils'
+import Spacer from '../Spacer'
+import { itemPositionsPropType, getItemPositionLayoutHandler } from './itemPositions'
+
+const selectHighlightBarStyles = ({
+  highlightColor,
+  highlightBarBorderRadius = 0,
+  highlightBarBorderWidth = 0,
+  highlightBarHeight = 0
+}) => ({
+  backgroundColor: highlightColor,
+  borderColor: highlightColor,
+  height: highlightBarHeight + highlightBarBorderWidth * 2,
+  borderRadius: highlightBarBorderRadius,
+  borderWidth: highlightBarBorderWidth,
+  bottom: -1 * (highlightBarHeight + highlightBarBorderWidth),
+  left: -1 * highlightBarBorderWidth,
+  right: -1 * highlightBarBorderWidth,
+  zIndex: 1 + highlightBarBorderWidth
+})
+
+const selectHighlightTriangleStyles = ({ highlightColor, highlightTriangleSize }) => ({
+  container: {
+    bottom: 0 - highlightTriangleSize * 2
+  },
+  triangle: {
+    height: 0,
+    width: 0,
+    borderWidth: highlightTriangleSize,
+    borderTopColor: highlightColor,
+    borderBottomColor: system.color.transparent,
+    borderLeftColor: system.color.transparent,
+    borderRightColor: system.color.transparent
+  }
+})
+
+const selectContainerStyles = ({
+  backgroundColor,
+  borderColor,
+  borderWidth = 0,
+  borderRadius,
+  paddingHorizontal = 0,
+  paddingVertical = 0
+}) => ({
+  backgroundColor,
+  borderColor,
+  borderWidth,
+  borderRadius,
+  paddingHorizontal: paddingHorizontal - borderWidth,
+  paddingVertical: paddingVertical - borderWidth
+})
+
+/**
+ * Item within a Tabs component representing one tab of content. May be rendered as a link
+ * or as a "menuitem" button depending on whether 'href' is passed.
+ *
+ * This is rendered automatically by `Tabs` and isn't intended be used directly.
+ */
+const TabsItem = ({
+  onPress,
+  href,
+  variant,
+  tokens,
+  selected,
+  itemPositions,
+  index,
+  children,
+  accessibilityRole = href ? 'link' : 'tab',
+  accessibilityState = Platform.OS === 'web' && accessibilityRole === 'link'
+    ? // Web links can't be aria-selected but can be aria-current
+      { current: selected ? 'page' : false }
+    : { selected },
+  ...rest
+}) => {
+  const getTokens = useThemeTokensCallback('TabsItem', tokens, variant)
+  const resolveTokens = (pressableState) =>
+    resolvePressableTokens(getTokens, pressableState, { selected })
+
+  const getPressableStyle = (pressableState) => {
+    const { maxWidth } = resolveTokens(pressableState)
+    return [{ maxWidth }, Platform.OS === 'web' && { outline: 'none' }]
+  }
+
+  const handleLayout = getItemPositionLayoutHandler(itemPositions.positions, index)
+
+  // On press, update the selection, call any press handler, and open any href in platform-appropriate way
+  const openHref = href && linkProps.handleHref({ href })
+  const handlePress =
+    onPress || openHref
+      ? () => {
+          if (onPress) onPress()
+          if (openHref) openHref()
+        }
+      : undefined
+
+  const a11y = {
+    accessibilityRole,
+    accessibilityState,
+    ...a11yProps.select(rest)
+  }
+
+  useEffect(() => {
+    // If this is selected while off-screen, scroll it into view
+    if (selected) {
+      const position = itemPositions.positions[index]
+      const scrollEnd = itemPositions.scrollOffset + itemPositions.containerWidth
+      if (
+        // is off the right edge, or
+        (scrollEnd && position?.end > scrollEnd) ||
+        // is off the left edge
+        (typeof position?.start === 'number' && position.start < itemPositions.scrollOffset)
+      ) {
+        itemPositions.scrollTo(position.start)
+      }
+    }
+    // itemPositions is a ref object so this should only re-run when `selected` (or `index`) change
+  }, [selected, index, itemPositions])
+
+  return (
+    <Pressable
+      onPress={handlePress}
+      href={href}
+      style={getPressableStyle}
+      onLayout={handleLayout}
+      {...a11y}
+    >
+      {(pressableState) => {
+        const { space, textAlign, ...themeTokens } = resolveTokens(pressableState)
+
+        const hasHighlightBar = Boolean(themeTokens.highlightBarHeight)
+        const highlightBarStyle = hasHighlightBar && selectHighlightBarStyles(themeTokens)
+
+        const hasHighlightTriangle = Boolean(themeTokens.highlightTriangleSize)
+        const highlightTriangleStyle =
+          hasHighlightTriangle && selectHighlightTriangleStyles(themeTokens)
+
+        const containerStyles = selectContainerStyles(themeTokens)
+        const textStyles = applyTextStyles({
+          ...selectTokens('Typography', themeTokens),
+          textAlign
+        })
+
+        return (
+          <View style={staticStyles.container}>
+            <View style={containerStyles}>
+              <Text style={textStyles}>{children}</Text>
+            </View>
+            <Spacer space={space} />
+            {hasHighlightBar && <View style={[staticStyles.absolute, highlightBarStyle]} />}
+            {hasHighlightTriangle && (
+              <View style={[staticStyles.absolute, highlightTriangleStyle.container]}>
+                <View style={highlightTriangleStyle.triangle} />
+              </View>
+            )}
+          </View>
+        )
+      }}
+    </Pressable>
+  )
+}
+
+TabsItem.propTypes = {
+  ...a11yProps.propTypes,
+  tokens: getTokensPropType('TabsItem'),
+  variant: variantProp.propType,
+  onPress: PropTypes.func,
+  href: PropTypes.string,
+  index: PropTypes.number,
+  selected: PropTypes.bool,
+  itemPositions: itemPositionsPropType,
+  children: PropTypes.string
+}
+
+const staticStyles = StyleSheet.create({
+  center: {
+    alignItems: 'center'
+  },
+  absolute: {
+    position: 'absolute',
+    alignItems: 'center',
+    left: 0,
+    right: 0
+  },
+  container: {
+    flexGrow: 1,
+    alignItems: 'center',
+    justifyContent: 'center'
+  }
+})
+
+export default TabsItem

package/src/Tabs/TabsScrollButton.jsx

@@ -0,0 +1,100 @@
+import React 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 dictionary from './dictionary'
+
+const selectButtonStyles = (
+  { borderRadius, backgroundColor, borderColor, borderWidth, padding },
+  direction
+) => [
+  staticStyles.absolute,
+  staticStyles[direction],
+  {
+    borderRadius,
+    backgroundColor,
+    borderColor,
+    borderWidth,
+    padding
+  }
+]
+
+/**
+ * Button within a Tabs component showing users that content is available to the left or
+ * right, scrolling a screen's worth of content left or right when pressed.
+ *
+ * This is rendered automatically by `Tabs` and isn't intended be used directly.
+ *
+ * @TODO when IconButton is complete and stable revisit this and update interaction state styles.
+ */
+const TabsScrollButton = ({ direction = 'next', icon, onPress, offset, variant, tokens, copy }) => {
+  const getTokens = useThemeTokensCallback('TabsScrollButton', tokens, variant)
+  const resolveButtonTokens = (pressableState) => resolvePressableTokens(getTokens, pressableState)
+  const getPressableStyle = (pressableState) => [
+    selectButtonStyles(resolveButtonTokens(pressableState), direction),
+    { marginTop: -1 * (offset || 0) }
+  ]
+
+  const getCopy = useCopy({ dictionary, copy })
+  const label = direction === 'previous' ? getCopy('previousText') : getCopy('nextText')
+
+  return (
+    <Pressable
+      style={getPressableStyle}
+      onPress={onPress}
+      accessibilityLabel={label}
+      accessibilityRole="button"
+      // For keyboard-tab or screenreader-swipe navigation, users can just go through all items
+      {...a11yProps.nonFocusableProps}
+    >
+      {(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>
+  )
+}
+
+const staticStyles = StyleSheet.create({
+  absolute: {
+    position: 'absolute'
+  },
+  previous: {
+    left: 0
+  },
+  next: {
+    right: 0
+  }
+})
+
+TabsScrollButton.propTypes = {
+  tokens: getTokensPropType('TabsScrollButton'),
+  variant: variantProp.propType,
+  copy: copyPropTypes,
+  direction: PropTypes.oneOf(['previous', 'next']),
+  offset: PropTypes.number,
+  icon: PropTypes.elementType,
+  onPress: PropTypes.func.isRequired
+}
+
+export default TabsScrollButton

package/src/Tabs/dictionary.js

@@ -0,0 +1,11 @@
+export default {
+  en: {
+    // English text from TDS Community `Tabs`
+    previousLabel: 'Move menu to the left',
+    nextLabel: 'Move menu to the right'
+  },
+  fr: {
+    previousLabel: 'Déplacer le menu vers la gauche',
+    nextLabel: 'Déplacer le menu vers la droite'
+  }
+}

package/src/Tabs/index.js

@@ -0,0 +1,3 @@
+import Tabs from './Tabs'
+
+export default Tabs

package/src/Tabs/itemPositions.js

@@ -0,0 +1,101 @@
+import { useRef, useState } from 'react'
+import PropTypes from 'prop-types'
+
+// Utilities to assist scrolling a parent so that it snaps neatly to an appropriate child.
+
+/**
+ * @typedef ItemPositionPosition
+ * @property {number} [ItemPositionItem.start] - optional theme scale variants e.g. compact, wide
+ * @property {number} [ItemPositionItem.end] - optional override to force a particular pixel size
+ *
+ * @typedef {Object.<number, ItemPositionItem>} ItemPositionPositions - ref object of start/end coordinates
+ *
+ * @typedef ItemPositions
+ * @property {number} ItemPositions.contentWidth - current width of potentially-overflowing content inside scrollable
+ * @property {number} ItemPositions.containerWidth - current width of non-overflowing outer scroll container
+ * @property {number} ItemPositions.scrollOffset - current x position of the left edge of the visible section of the scrollable content
+ * @property {ItemPositionPositions} ItemPositions.positions - `{ start, end }` coordinates of each scrollable content item, by index
+ * @property {(targetX: number) => void)} ItemPositions.scrollTo - function to scroll to a co-ordinate, applying scrolling logic
+ * @property {() => void)} ItemPositions.setIsReady - function to call when layout has been calculated and itemPositions data is ready
+ */
+
+/**
+ * Takes a desired scroll target coordinate and returns a valid coordinate
+ * that, when not scrolling to one end or another, snaps to the start of an item,
+ * making sure any "scroll back" button doesn't overlap the first item.
+ *
+ * @param {number} x - the intended coordinate to scroll to
+ * @param {number} scrollMax - the highest posible coordinate to scroll to
+ * @param {ItemPositionPositions} positions - positions list from `useItemPositions` ref
+ * @param {number} [buttonClearance] - offset to allow space for a button
+ * @returns {number}
+ */
+export const getItemPositionScrollTarget = (x, scrollMax, positions, buttonClearance = 0) => {
+  if (x <= 0) return 0
+  if (x >= scrollMax) return scrollMax
+
+  // If not scrolling all the way to the start or end, stop
+  // where the first item is not coverred by the scroll previous button
+  const targetItem = Object.values(positions).find(({ start, end }) => start <= x && end > x)
+
+  // If there's no target item we're landing at a gap between items
+  const targetX = targetItem ? targetItem.start : x
+  return Math.max(0, targetX - buttonClearance)
+}
+
+/**
+ * Returns a handler for React Native's `onLayout` which updates the values of
+ * the ref object returned from `useItemPositions`.
+ *
+ * @param {ItemPositionPositions} positions
+ * @param {number} index
+ * @returns {function}
+ */
+export const getItemPositionLayoutHandler = (positions, index) => {
+  const handleLayout = ({
+    nativeEvent: {
+      layout: { width, x }
+    }
+  }) => {
+    /* eslint-disable-next-line no-param-reassign */
+    positions[index] = { start: x, end: x + width }
+  }
+  return handleLayout
+}
+
+/**
+ * Wrapper for `useRef` which gives a mutable object in which item start/end coordinates,
+ * scrollTo method and content/container widths may be set and updated without causing a re-render.
+ *
+ * @returns {[ItemPositions, isReady: bool]} tuple array of:
+ *  - current ref object `{ positions, contentWidth, containerWidth, scrollOffset, scrollTo, setIsReady }`
+ *  - boolean that updates to `true` (causing a re-render) after the first time `setIsReady` is called
+ */
+export const useItemPositions = () => {
+  const [isReady, setIsReady] = useState(false)
+  return [
+    useRef({
+      positions: {},
+      scrollTo: () => {},
+      contentWidth: 0,
+      containerWidth: 0,
+      scrollOffset: 0,
+      setIsReady
+    }).current,
+    isReady
+  ]
+}
+
+/**
+ * PropType for the ref object returned by `useItemPositions`
+ */
+export const itemPositionsPropType = PropTypes.exact({
+  positions: PropTypes.objectOf(
+    PropTypes.shape({ start: PropTypes.number, end: PropTypes.number })
+  ),
+  scrollTo: PropTypes.func,
+  contentWidth: PropTypes.number,
+  containerWidth: PropTypes.number,
+  scrollOffset: PropTypes.number,
+  setIsReady: PropTypes.func
+})