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

package/src/StepTracker/StepTracker.jsx

@@ -0,0 +1,163 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+import { StyleSheet, Text, View } from 'react-native'
+
+import StackView from '../StackView'
+import { applyTextStyles, useThemeTokens } from '../ThemeProvider'
+import { getTokensPropType, variantProp } from '../utils'
+import { a11yProps } from '../utils/propTypes'
+import { useViewport } from '../ViewportProvider'
+import useCopy from '../utils/useCopy'
+
+import Step from './Step'
+import defaultDictionary from './dictionary'
+
+const selectContainerStyles = ({
+  containerPaddingBottom,
+  containerPaddingLeft,
+  containerPaddingRight,
+  containerPaddingTop
+}) => ({
+  paddingBottom: containerPaddingBottom,
+  paddingLeft: containerPaddingLeft,
+  paddingRight: containerPaddingRight,
+  paddingTop: containerPaddingTop
+})
+const selectStepTrackerLabelContainerStyles = ({ labelMarginTop }) => ({
+  marginTop: labelMarginTop
+})
+const selectStepTrackerLabelStyles = ({
+  labelColor,
+  labelFontSize,
+  labelFontWeight,
+  labelFontName,
+  labelLineHeight
+}) =>
+  applyTextStyles({
+    color: labelColor,
+    fontSize: labelFontSize,
+    lineHeight: labelLineHeight,
+    fontWeight: labelFontWeight,
+    fontName: labelFontName
+  })
+
+/**
+ * StepTracker component shows the current position in a sequence of steps.
+ *
+ * ## Component API
+ *
+ * - `current` prop allows to control the current step, 0-based number;
+ * - use `copy` and `dictionary` props to internationalize the labels;
+ * - `steps` is and array of strings defining step titles;
+ * - tokens and variant props define the appearance of the `StepTracker`:
+ *
+ * ## Usability and A11y guidelines
+ *
+ * Keep in mind that in its current implementation this is not an interactive
+ * component and can’t be used to navigate between steps. The application
+ * must provide its own navigation mechanism and state control. That is the
+ * main reason the component assumes the `progressbar` role in terms of
+ * accessibility. This also makes it extremely important to make sure you
+ * set a11y on controls used to modify the state of the step tracker.
+ *
+ * You can pass standard a11y props to the `StepTracker` component, including
+ * the ones that are specific to the `progressbar` role. By default the
+ * following props are used:
+ *
+ * - `accessibilityRole` (`role`): `progressbar`,
+ * - `accessibilityLabel` (`aria-label`): `Step I of N: <Current Step Label>`,
+ * - `accessibilityLevel` (`aria-level`): 1,
+ * - `accessibilityValue.min` (`aria-valuemin`): `0`,
+ * - `accessibilityValue.max` (`aria-valuemax`): `steps.length - 1`,
+ * - `accessibilityValue.now` (`aria-valuenow`): `current`,
+ * - `accessibilityValue.text` (`aria-valuetext`): `<Current Step Label>`,
+ *
+ */
+const StepTracker = ({
+  current = 0,
+  copy = 'en',
+  dictionary = defaultDictionary,
+  steps = [],
+  tokens,
+  variant,
+  ...rest
+}) => {
+  const viewport = useViewport()
+  const { showStepTrackerLabel, ...themeTokens } = useThemeTokens('StepTracker', tokens, variant, {
+    viewport
+  })
+  const getCopy = useCopy({ dictionary, copy })
+  const stepTrackerLabel = getCopy('stepTrackerLabel')
+    .replace('%{stepNumber}', current < steps.length ? current + 1 : steps.length)
+    .replace('%{stepCount}', steps.length)
+    .replace('%{stepLabel}', current < steps.length ? steps[current] : steps[steps.length - 1])
+  if (!steps.length) return null
+  const accessibilityProps = {
+    accessibilityLabel: stepTrackerLabel,
+    accessibilityLevel: 1,
+    accessibilityRole: 'progressbar',
+    accessibilityValue: {
+      min: 0,
+      max: steps.length - 1,
+      now: current,
+      text: steps[current]
+    },
+    ...a11yProps.select(rest)
+  }
+
+  return (
+    <View style={selectContainerStyles(themeTokens)} {...accessibilityProps}>
+      <StackView space={0}>
+        <View style={staticStyles.stepsContainer}>
+          {steps.map((label, index) => {
+            return (
+              <Step
+                status={current}
+                key={label}
+                label={label}
+                name={getCopy('stepLabel').replace('%{stepNumber}', index + 1)}
+                stepIndex={index}
+                stepCount={steps.length}
+                tokens={themeTokens}
+              />
+            )
+          })}
+        </View>
+        {showStepTrackerLabel && (
+          <View
+            style={[
+              staticStyles.stepTrackerLabelContainer,
+              selectStepTrackerLabelContainerStyles(themeTokens)
+            ]}
+          >
+            <Text style={selectStepTrackerLabelStyles(themeTokens)}>{stepTrackerLabel}</Text>
+          </View>
+        )}
+      </StackView>
+    </View>
+  )
+}
+
+StepTracker.propTypes = {
+  current: PropTypes.number,
+  copy: PropTypes.oneOf(['en', 'fr']),
+  dictionary: PropTypes.shape({
+    en: PropTypes.shape({ stepLabel: PropTypes.string, stepTrackerLabel: PropTypes.string }),
+    fr: PropTypes.shape({ stepLabel: PropTypes.string, stepTrackerLabel: PropTypes.string })
+  }),
+  steps: PropTypes.arrayOf(PropTypes.string),
+  tokens: getTokensPropType('StepTracker'),
+  variant: variantProp.propType
+}
+
+export default StepTracker
+
+const staticStyles = StyleSheet.create({
+  stepsContainer: {
+    alignItems: 'flex-start',
+    flexDirection: 'row',
+    justifyContent: 'space-evenly',
+    flexGrow: 1
+  },
+  stepTrackerLabelContainer: { textAlign: 'center', flexDirection: 'row', justifyContent: 'center' }
+})

package/src/StepTracker/dictionary.js

@@ -0,0 +1,10 @@
+export default {
+  en: {
+    stepLabel: 'Step %{stepNumber}',
+    stepTrackerLabel: 'Step %{stepNumber} of %{stepCount}: %{stepLabel}'
+  },
+  fr: {
+    stepLabel: 'Étape %{stepNumber}',
+    stepTrackerLabel: 'Étape %{stepNumber} sur %{stepCount}: %{stepLabel}'
+  }
+}

package/src/StepTracker/index.js

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

package/src/Tabs/HorizontalScroll.jsx

@@ -0,0 +1,165 @@
+import React, { useEffect, useRef, useState } from 'react'
+import PropTypes from 'prop-types'
+import { Platform, StyleSheet, View } from 'react-native'
+
+import { validateThemeTokens, resolveThemeTokens } from '../ThemeProvider'
+import { getTokensSetPropType, selectTokens, a11yProps } from '../utils'
+import ScrollViewEnd from './ScrollViewEnd'
+import { getItemPositionScrollTarget, itemPositionsPropType } from './itemPositions'
+
+const tokenKeys = [
+  'nextIcon',
+  'previousIcon',
+  'gutter',
+  'borderBottomWidth',
+  'borderBottomColor',
+  'buttonClearance'
+]
+export const selectHorizontalScrollTokens = (themeTokens, prefix) =>
+  selectTokens(tokenKeys, themeTokens, prefix)
+
+/**
+ * Base component that scrolls horizontally and displays left and right buttons if
+ * there is content to the left and the right which can be scrolled to.
+ *
+ * @TODO revist `ScrollButton` after IconButton is stable.
+ */
+const HorizontalScroll = ({ ScrollButton, tokens, itemPositions, children, ...rest }) => {
+  const {
+    nextIcon,
+    previousIcon,
+    gutter,
+    borderBottomWidth,
+    borderBottomColor,
+    buttonClearance = 0
+  } = validateThemeTokens(
+    resolveThemeTokens(tokens),
+    // Allow missing icons
+    getTokensSetPropType(tokenKeys, { partial: true }),
+    'HorizontalScroll'
+  )
+
+  const [containerWidth, setContainerWidth] = useState(0)
+  const [contentWidth, setContentWidth] = useState(0)
+  const handleContentWidth = (width) => setContentWidth(width)
+  const handleContainerLayout = ({
+    nativeEvent: {
+      layout: { width }
+    }
+  }) => setContainerWidth(width)
+
+  // Update the scroll position only when scrolling actions ends to minimally rerender
+  // and update which buttons are conditionally rendered.
+  const [scrollOffset, setScrollOffset] = useState(0)
+  const handleScrollEnd = ({
+    nativeEvent: {
+      contentOffset: { x }
+    }
+  }) => {
+    setScrollOffset(x)
+  }
+
+  const scrollMax = Math.max(0, contentWidth - containerWidth)
+  const showNextButton = scrollOffset < scrollMax
+  const showPreviousButton = scrollOffset > 0
+
+  const scrollRef = useRef(null)
+  const scrollTo = (targetX) => {
+    if (typeof scrollRef.current?.scrollTo === 'function') {
+      const x = getItemPositionScrollTarget(
+        targetX,
+        scrollMax,
+        itemPositions.positions,
+        buttonClearance
+      )
+      scrollRef.current.scrollTo({ x, animated: true })
+
+      if (Platform.OS === 'android') {
+        // React Native calls onScrollMomentumEnd after scrollTo for iOS, but not Android.
+        // See https://github.com/facebook/react-native/issues/26661
+        // There's also no callback for when scrollTo finishes.
+        setTimeout(() => setScrollOffset(x), 300)
+      }
+    }
+  }
+  // Make scrollTo and relevant co-ordinates available to any component with an interest in itemPositions.
+  // ItemPositions is a mutable ref object intended to have its properties mutated without any rerenders.
+  /* eslint-disable-next-line no-param-reassign */
+  itemPositions.scrollTo = scrollTo
+  /* eslint-disable-next-line no-param-reassign */
+  itemPositions.containerWidth = containerWidth
+  /* eslint-disable-next-line no-param-reassign */
+  itemPositions.contentWidth = contentWidth
+  /* eslint-disable-next-line no-param-reassign */
+  itemPositions.scrollOffset = scrollOffset
+
+  const hasWidths = itemPositions.contentWidth > 0 && itemPositions.contentWidth > 0
+  useEffect(() => {
+    if (hasWidths) itemPositions.setIsReady(true)
+    // itemPositions is a ref object so this should occur only when elements' widths are set in state
+  }, [hasWidths, itemPositions])
+
+  // When scrolling, allow clearance around scroll buttons, so e.g. this...
+  // (<-) Item 5   Item 6   Item 7   Item 8   It(->)
+  // ...doesn't scroll like this with Item 9 never being properly visible:
+  // (<-)em 9   Item 10  Item 11  Item 12  Item (->)
+  const scrollDistance = containerWidth - buttonClearance * 2
+  const scrollNext = () => scrollTo(scrollOffset + scrollDistance)
+  const scrollPrevious = () => scrollTo(scrollOffset - scrollDistance)
+
+  const a11y = a11yProps.select(rest)
+
+  // On Web, being scrollable in one direction prevents overflow: visible in the other direction.
+  // Apply a fixed margin gutter that tab highlight effects can overhang without getting trimmed.
+  return (
+    <View style={staticStyles.container}>
+      <ScrollViewEnd
+        onScrollEnd={handleScrollEnd}
+        ref={scrollRef}
+        horizontal
+        onContentSizeChange={handleContentWidth}
+        onLayout={handleContainerLayout}
+        showsHorizontalScrollIndicator={false}
+        contentContainerStyle={[
+          staticStyles.scrollContainer,
+          { marginBottom: gutter, borderBottomWidth, borderBottomColor }
+        ]}
+        {...a11y}
+      >
+        {children}
+      </ScrollViewEnd>
+      {showPreviousButton && (
+        <ScrollButton
+          icon={previousIcon}
+          onPress={scrollPrevious}
+          offset={gutter}
+          direction="previous"
+        />
+      )}
+      {showNextButton && (
+        <ScrollButton icon={nextIcon} onPress={scrollNext} offset={gutter} direction="next" />
+      )}
+    </View>
+  )
+}
+
+const staticStyles = StyleSheet.create({
+  scrollContainer: {
+    // Gives inner container width from content, allowing it to exceed its container's width
+    alignSelf: 'flex-start',
+    flexGrow: 1
+  },
+  container: {
+    // Vertically center the ScrollButtons buttons
+    justifyContent: 'center'
+  }
+})
+
+HorizontalScroll.propTypes = {
+  itemPositions: itemPositionsPropType,
+  ScrollButton: PropTypes.elementType,
+  tokens: getTokensSetPropType(tokenKeys, { allowFunction: true }),
+  children: PropTypes.node
+}
+
+export default HorizontalScroll

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