@telus-uds/components-base 1.3.0 → 1.5.0

package/lib-module/StepTracker/StepTracker.js

@@ -0,0 +1,175 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Text from "react-native-web/dist/exports/Text";
+import View from "react-native-web/dist/exports/View";
+import StackView from '../StackView';
+import { applyTextStyles, useThemeTokens } from '../ThemeProvider';
+import { a11yProps, getTokensPropType, selectSystemProps, variantProp, viewProps } from '../utils';
+import { useViewport } from '../ViewportProvider';
+import useCopy from '../utils/useCopy';
+import Step from './Step';
+import defaultDictionary from './dictionary';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+
+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 = /*#__PURE__*/forwardRef(({
+  current = 0,
+  copy = 'en',
+  dictionary = defaultDictionary,
+  steps = [],
+  tokens,
+  variant,
+  ...rest
+}, ref) => {
+  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 selectedProps = selectProps({
+    accessibilityLabel: stepTrackerLabel,
+    accessibilityLevel: 1,
+    accessibilityRole: 'progressbar',
+    accessibilityValue: {
+      min: 0,
+      max: steps.length - 1,
+      now: current,
+      text: steps[current]
+    },
+    ...rest
+  });
+  return /*#__PURE__*/_jsx(View, {
+    ref: ref,
+    style: selectContainerStyles(themeTokens),
+    ...selectedProps,
+    children: /*#__PURE__*/_jsxs(StackView, {
+      space: 0,
+      children: [/*#__PURE__*/_jsx(View, {
+        style: staticStyles.stepsContainer,
+        children: steps.map((label, index) => {
+          return /*#__PURE__*/_jsx(Step, {
+            status: current,
+            label: label,
+            name: getCopy('stepLabel').replace('%{stepNumber}', index + 1),
+            stepIndex: index,
+            stepCount: steps.length,
+            tokens: themeTokens
+          }, label);
+        })
+      }), showStepTrackerLabel && /*#__PURE__*/_jsx(View, {
+        style: [staticStyles.stepTrackerLabelContainer, selectStepTrackerLabelContainerStyles(themeTokens)],
+        children: /*#__PURE__*/_jsx(Text, {
+          style: selectStepTrackerLabelStyles(themeTokens),
+          children: stepTrackerLabel
+        })
+      })]
+    })
+  });
+});
+StepTracker.displayName = 'StepTracker';
+StepTracker.propTypes = { ...selectedSystemPropTypes,
+  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/lib-module/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/lib-module/StepTracker/index.js

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

package/lib-module/Tabs/Tabs.js

@@ -0,0 +1,113 @@
+import React, { forwardRef, useCallback } from 'react';
+import PropTypes from 'prop-types';
+import ABBPropTypes from 'airbnb-prop-types';
+import { useThemeTokens } from '../ThemeProvider';
+import StackView from '../StackView';
+import { a11yProps, getTokensPropType, selectSystemProps, useHash, useInputValue, variantProp, viewProps, withLinkRouter } from '../utils';
+import HorizontalScroll, { horizontalScrollUtils, HorizontalScrollButton } from '../HorizontalScroll';
+import TabsItem from './TabsItem';
+import { jsx as _jsx } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+const {
+  selectHorizontalScrollTokens,
+  useItemPositions
+} = horizontalScrollUtils;
+/**
+ * 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 = /*#__PURE__*/forwardRef(({
+  tokens,
+  itemTokens,
+  scrollButtonTokens,
+  variant,
+  value,
+  initialValue,
+  onChange,
+  items = [],
+  LinkRouter,
+  linkRouterProps,
+  ...rest
+}, ref) => {
+  const {
+    space,
+    ...themeTokens
+  } = useThemeTokens('Tabs', tokens, variant);
+  const {
+    currentValue,
+    setValue
+  } = useInputValue({
+    value,
+    initialValue,
+    onChange
+  });
+  const [itemPositions, isPositioningReady] = useItemPositions();
+  useHash(useCallback((hash, event) => {
+    const hashItem = hash && items.find(({
+      href
+    }) => hash === href);
+    const hashId = hashItem && (hashItem.id || hashItem.label);
+    if (hashId) setTimeout(setValue(hashId, event), 500);
+  }, [items, setValue]), isPositioningReady);
+  return /*#__PURE__*/_jsx(HorizontalScroll, {
+    ref: ref,
+    ScrollButton: HorizontalScrollButton,
+    itemPositions: itemPositions,
+    tokens: selectHorizontalScrollTokens(themeTokens),
+    scrollButtonTokens: scrollButtonTokens,
+    accessibilityRole: "tablist",
+    ...selectProps(rest),
+    children: /*#__PURE__*/_jsx(StackView, {
+      space: space,
+      direction: "row",
+      children: items.map(({
+        href,
+        label,
+        id,
+        ref: itemRef,
+        LinkRouter: ItemLinkRouter = LinkRouter,
+        linkRouterProps: itemLinkRouterProps
+      }, index) => {
+        const itemId = id ?? label;
+        const isSelected = Boolean(currentValue && currentValue === itemId);
+
+        const handlePress = event => setValue(itemId, event);
+
+        return /*#__PURE__*/_jsx(TabsItem, {
+          ref: itemRef,
+          href: href,
+          variant: variant,
+          tokens: itemTokens,
+          onPress: handlePress,
+          selected: isSelected,
+          itemPositions: itemPositions,
+          index: index,
+          LinkRouter: ItemLinkRouter,
+          linkRouterProps: { ...linkRouterProps,
+            ...itemLinkRouterProps
+          },
+          children: label
+        }, itemId);
+      })
+    })
+  });
+});
+Tabs.displayName = 'Tabs';
+Tabs.propTypes = { ...selectedSystemPropTypes,
+  ...withLinkRouter.PropTypes,
+  items: PropTypes.arrayOf(PropTypes.shape({ ...withLinkRouter.PropTypes,
+    href: PropTypes.string,
+    label: PropTypes.string,
+    id: PropTypes.string,
+    ref: ABBPropTypes.ref()
+  })),
+  value: PropTypes.string,
+  initialValue: PropTypes.string,
+  onChange: PropTypes.func,
+  tokens: getTokensPropType('Tabs'),
+  itemTokens: getTokensPropType('TabsItem'),
+  scrollButtonTokens: getTokensPropType('HorizontalScrollButton'),
+  variant: variantProp.propType
+};
+export default Tabs;

package/lib-module/Tabs/TabsItem.js

@@ -0,0 +1,215 @@
+import React, { forwardRef, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import Platform from "react-native-web/dist/exports/Platform";
+import Pressable from "react-native-web/dist/exports/Pressable";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Text from "react-native-web/dist/exports/Text";
+import View from "react-native-web/dist/exports/View";
+import { applyTextStyles, useThemeTokensCallback } from '../ThemeProvider';
+import { a11yProps, clickProps, getTokensPropType, linkProps, resolvePressableTokens, selectSystemProps, selectTokens, variantProp, viewProps, withLinkRouter } from '../utils';
+import Spacer from '../Spacer';
+import { horizontalScrollUtils } from '../HorizontalScroll';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+const {
+  itemPositionsPropType,
+  getItemPositionLayoutHandler
+} = horizontalScrollUtils;
+
+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: 'transparent',
+    borderLeftColor: 'transparent',
+    borderRightColor: '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 = /*#__PURE__*/forwardRef(({
+  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
+  },
+  ...rawRest
+}, ref) => {
+  // Convert onClick etc to onPress etc if used in an integration
+  const {
+    onPress,
+    ...rest
+  } = clickProps.toPressProps(rawRest);
+  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 ? (...args) => {
+    if (onPress) onPress(...args);
+    if (openHref) openHref(...args);
+  } : undefined;
+  const selectedProps = selectProps({
+    accessibilityRole,
+    accessibilityState,
+    ...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 === null || position === void 0 ? void 0 : position.end) > scrollEnd || // is off the left edge
+      typeof (position === null || position === void 0 ? void 0 : 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 /*#__PURE__*/_jsx(Pressable, {
+    ref: ref,
+    onPress: handlePress,
+    href: href,
+    style: getPressableStyle,
+    onLayout: handleLayout,
+    ...selectedProps,
+    children: 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 /*#__PURE__*/_jsxs(View, {
+        style: staticStyles.container,
+        children: [/*#__PURE__*/_jsx(View, {
+          style: containerStyles,
+          children: /*#__PURE__*/_jsx(Text, {
+            style: textStyles,
+            children: children
+          })
+        }), /*#__PURE__*/_jsx(Spacer, {
+          space: space
+        }), hasHighlightBar && /*#__PURE__*/_jsx(View, {
+          style: [staticStyles.absolute, highlightBarStyle]
+        }), hasHighlightTriangle && /*#__PURE__*/_jsx(View, {
+          style: [staticStyles.absolute, highlightTriangleStyle.container],
+          children: /*#__PURE__*/_jsx(View, {
+            style: highlightTriangleStyle.triangle
+          })
+        })]
+      });
+    }
+  });
+});
+TabsItem.displayName = 'TabsItem';
+TabsItem.propTypes = { ...selectedSystemPropTypes,
+  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 withLinkRouter(TabsItem);

package/lib-module/Tabs/index.js

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