@telus-uds/components-base 1.10.0 → 1.11.0

package/lib/utils/useScrollBlocking.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("react");
+
+const addScrollBlocking = (preventScrolling, stopPropagation, ref) => {
+  var _ref$current;
+
+  document.body.addEventListener('touchmove', preventScrolling, {
+    passive: false
+  });
+  (_ref$current = ref.current) === null || _ref$current === void 0 ? void 0 : _ref$current.addEventListener('touchmove', stopPropagation);
+  document.body.style.overflow = 'hidden';
+};
+
+const removeScrollBlocking = (preventScrolling, stopPropagation, ref) => {
+  var _ref$current2;
+
+  document.body.removeEventListener('touchmove', preventScrolling);
+  (_ref$current2 = ref.current) === null || _ref$current2 === void 0 ? void 0 : _ref$current2.removeEventListener('touchmove', stopPropagation);
+  document.body.style.overflow = 'inherit';
+};
+/**
+ * Disables scrolling when passed `true` or an array where all items are `true`.
+ *
+ * Returns an optional callback ref. Pass this to an element if it or its children
+ * should allow touch-based scrolling within that element's bounds.
+ *
+ * @param {boolean | boolean[]} conditionProps
+ * @returns
+ */
+
+
+const useScrollBlocking = conditionProps => {
+  // useRef refs are null on first render and don't trigger a re-render when they get their
+  // element. Force re-run when ref mounts to ensure the stopPropagation listener is attached.
+  const ref = (0, _react.useRef)();
+  const [refIsMounted, setRefIsMounted] = (0, _react.useState)(false);
+  const callbackRef = (0, _react.useCallback)(element => {
+    ref.current = element;
+    setRefIsMounted(Boolean(element));
+  }, []);
+  const conditionsMet = Array.isArray(conditionProps) ? conditionProps.every(condition => condition) : Boolean(conditionProps);
+  const preventScrolling = (0, _react.useCallback)(event => event.preventDefault(), []);
+  const stopPropagation = (0, _react.useCallback)(event => event.stopPropagation(), []);
+  (0, _react.useEffect)(() => {
+    const cleanup = () => removeScrollBlocking(preventScrolling, stopPropagation, ref);
+
+    if (conditionsMet) {
+      addScrollBlocking(preventScrolling, stopPropagation, ref);
+    } else {
+      cleanup();
+    }
+
+    return cleanup; // preventScrolling and stopPropagation are stable callbacks with no deps, so this
+    // will re-run when conditionsMet or refIsMounted flip between true and false.
+  }, [preventScrolling, conditionsMet, stopPropagation, refIsMounted]);
+  return callbackRef;
+};
+
+var _default = useScrollBlocking;
+exports.default = _default;

package/lib/utils/useScrollBlocking.native.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+// This is a no-op to emphasize that the original hook is web-only
+var _default = () => {};
+
+exports.default = _default;

package/lib-module/Carousel/Carousel.js

@@ -7,13 +7,14 @@ import Platform from "react-native-web/dist/exports/Platform";
 import PropTypes from 'prop-types';
 import { useThemeTokens } from '../ThemeProvider';
 import { useViewport } from '../ViewportProvider';
-import { getTokensPropType, variantProp, selectSystemProps, a11yProps, viewProps } from '../utils';
+import { getTokensPropType, getA11yPropsFromHtmlTag, layoutTags, variantProp, selectSystemProps, a11yProps, viewProps, useCopy } from '../utils';
 import { useA11yInfo } from '../A11yInfoProvider';
 import { CarouselProvider } from './CarouselContext';
 import CarouselItem from './CarouselItem';
 import StepTracker from '../StepTracker';
 import StackView from '../StackView';
 import IconButton from '../IconButton';
+import dictionary from './dictionary';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 const staticStyles = StyleSheet.create({
@@ -77,14 +78,6 @@ const selectPreviousNextNavigationButtonStyles = (previousNextNavigationButtonWi
   return styles;
 };
 
-const defaultPanelNavigationDictionary = {
-  en: {
-    stepTrackerLabel: 'Showing %{stepNumber} of %{stepCount}'
-  },
-  fr: {
-    stepTrackerLabel: 'Étape %{stepNumber} sur %{stepCount}: %{stepLabel}'
-  }
-};
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
 /**
  * Carousel is a general-purpose content slider that can be used to render content in terms of slides.
@@ -146,6 +139,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     tokens,
     variant,
     children,
+    itemLabel = 'item',
     previousNextNavigationPosition = 'inside',
     previousNextIconSize = 'default',
     minDistanceToCapture = 5,
@@ -155,9 +149,10 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     onIndexChanged,
     springConfig = undefined,
     onRenderPanelNavigation,
-    panelNavigationTextDictionary = defaultPanelNavigationDictionary,
+    tag = 'ul',
     accessibilityRole = 'adjustable',
     accessibilityLabel = 'carousel',
+    copy,
     ...rest
   } = _ref;
   const viewport = useViewport();
@@ -172,6 +167,19 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     viewport
   });
   const [activeIndex, setActiveIndex] = React.useState(0);
+  const [isAnimating, setIsAnimating] = React.useState(false);
+  const handleAnimationStart = React.useCallback(function () {
+    if (typeof onAnimationStart === 'function') onAnimationStart(...arguments);
+    setIsAnimating(true);
+  }, [onAnimationStart]);
+  const handleAnimationEnd = React.useCallback(function () {
+    if (typeof onAnimationEnd === 'function') onAnimationEnd(...arguments);
+    setIsAnimating(false);
+  }, [onAnimationEnd]);
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
   const childrenArray = React.Children.toArray(children);
   const systemProps = selectProps({ ...rest,
     accessibilityRole,
@@ -240,20 +248,28 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
       y: 0
     });
   }, [activeIndex, containerLayout.width, pan, animatedX]);
-  const animate = React.useCallback(toValue => {
+  const animate = React.useCallback((toValue, toIndex) => {
+    const handleAnimationEndToIndex = function () {
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
+
+      return handleAnimationEnd(toIndex, ...args);
+    };
+
     if (reduceMotionEnabled) {
       Animated.timing(pan, {
         toValue,
         duration: 1,
         useNativeDriver: false
-      }).start();
+      }).start(handleAnimationEndToIndex);
     } else {
       Animated.spring(pan, { ...springConfig,
         toValue,
         useNativeDriver: false
-      }).start();
+      }).start(handleAnimationEndToIndex);
     }
-  }, [pan, springConfig, reduceMotionEnabled]);
+  }, [pan, springConfig, reduceMotionEnabled, handleAnimationEnd]);
   const updateIndex = React.useCallback(function () {
     let delta = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
     const toValue = {
@@ -271,24 +287,24 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
       calcDelta = -1 * activeIndex + delta - 1;
     }
 
+    const index = activeIndex + calcDelta;
+
     if (skipChanges) {
-      animate(toValue);
+      animate(toValue, index);
       return calcDelta;
     }
 
-    const index = activeIndex + calcDelta;
     setActiveIndex(index);
     toValue.x = containerLayout.width * -1 * calcDelta;
-    animate(toValue);
+    animate(toValue, index);
     if (onIndexChanged) onIndexChanged(calcDelta);
-    if (onAnimationEnd) onAnimationEnd(index);
     return calcDelta;
-  }, [containerLayout.width, activeIndex, animate, children.length, onIndexChanged, onAnimationEnd]);
+  }, [containerLayout.width, activeIndex, animate, children.length, onIndexChanged]);
   const fixOffsetAndGo = React.useCallback(delta => {
     updateOffset();
-    if (onAnimationStart) onAnimationStart(activeIndex);
+    handleAnimationStart(activeIndex);
     updateIndex(delta);
-  }, [updateIndex, updateOffset, activeIndex, onAnimationStart]);
+  }, [updateIndex, updateOffset, activeIndex, handleAnimationStart]);
   const goToNeighboring = React.useCallback(function () {
     let toPrev = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     fixOffsetAndGo(toPrev ? -1 : 1);
@@ -308,7 +324,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
         return false;
       }
 
-      if (onAnimationStart) onAnimationStart(activeIndex);
+      handleAnimationStart(activeIndex);
       return Math.abs(gestureState.dx) > minDistanceToCapture;
     },
     onPanResponderGrant: () => updateOffset(),
@@ -324,13 +340,13 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
         animate({
           x: 0,
           y: 0
-        });
+        }, 0);
       } else {
         const delta = correction > 0 ? -1 : 1;
         updateIndex(delta);
       }
     }
-  }), [containerLayout.width, updateIndex, updateOffset, animate, isSwipeAllowed, activeIndex, minDistanceForAction, onAnimationStart, minDistanceToCapture, pan.x]);
+  }), [containerLayout.width, updateIndex, updateOffset, animate, isSwipeAllowed, activeIndex, minDistanceForAction, handleAnimationStart, minDistanceToCapture, pan.x]);
   React.useEffect(() => {
     pan.x.addListener(_ref4 => {
       let {
@@ -370,6 +386,13 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     size: previousNextIconSize,
     raised: true
   };
+
+  const getCopyWithPlaceholders = copyKey => {
+    const copyText = getCopy(copyKey).replace(/%\{itemLabel\}/g, itemLabel).replace(/%\{stepNumber\}/g, activeIndex + 1).replace(/%\{stepCount\}/g, childrenArray.length); // First word might be a lowercase placeholder: capitalize the first letter
+
+    return "".concat(copyText[0].toUpperCase()).concat(copyText.slice(1));
+  };
+
   return /*#__PURE__*/_jsxs(CarouselProvider, {
     activeIndex: activeIndex,
     totalItems: childrenArray.length,
@@ -388,7 +411,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
           icon: previousIcon,
           onPress: goToPrev,
           variant: previousNextIconButtonVariants,
-          accessibilityLabel: "previous-button"
+          accessibilityLabel: getCopyWithPlaceholders('iconButtonLabel').replace('%{targetStep}', activeIndex)
         })
       }), /*#__PURE__*/_jsx(View, {
         style: selectContainerStyles(containerLayout.width),
@@ -401,9 +424,12 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
             }]
           }]),
           ...panResponder.panHandlers,
+          ...getA11yPropsFromHtmlTag(tag),
           children: childrenArray.map((element, index) => {
+            const hidden = !isAnimating && index !== activeIndex;
             const clonedElement = /*#__PURE__*/React.cloneElement(element, {
-              elementIndex: index
+              elementIndex: index,
+              hidden
             });
             return /*#__PURE__*/_jsx(React.Fragment, {
               children: clonedElement
@@ -418,7 +444,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
           icon: nextIcon,
           onPress: goToNext,
           variant: previousNextIconButtonVariants,
-          accessibilityLabel: "next-button"
+          accessibilityLabel: getCopyWithPlaceholders('iconButtonLabel').replace('%{targetStep}', activeIndex + 2)
         })
       })]
     }), showPanelNavigation ? /*#__PURE__*/_jsx(StackView, {
@@ -430,7 +456,11 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref, ref) => {
       }) : /*#__PURE__*/_jsx(StepTracker, {
         current: activeIndex,
         steps: childrenArray.map((_, index) => String(index)),
-        dictionary: panelNavigationTextDictionary,
+        copy: {
+          // Give StepTracker copy from Carousel's language and dictionary
+          stepLabel: getCopyWithPlaceholders('stepLabel'),
+          stepTrackerLabel: getCopyWithPlaceholders('stepTrackerLabel')
+        },
         tokens: panelNavigationTokens
       })
     }) : null]
@@ -445,6 +475,14 @@ Carousel.propTypes = { ...selectedSystemPropTypes,
    */
   children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
 
+  /**
+   * Lowercase language-appropriate user-facing description of what each Carousel slide represents.
+   * This is used when generating item labels. For example, if a carousel contains offers,
+   * pass itemLabel="summer offer" (or copy="fr" and an appropriate French translation) to genereate
+   * accessible labels such as "Summer offer 1 of 3" and "Show summer offer 2 of 3".
+   */
+  itemLabel: PropTypes.string,
+
   /**
    * `inside` renders the previous and next buttons inside the slide
    * `outside` renders the previous and next buttons outside the slide
@@ -563,7 +601,16 @@ Carousel.propTypes = { ...selectedSystemPropTypes,
   /**
    * Provide custom accessibilityLabel for Carousel container
    */
-  accessibilityLabel: PropTypes.string
+  accessibilityLabel: PropTypes.string,
+
+  /**
+   * HTML tag to use for the Carousel item's immediate parent. Defaults to `'ul'` so that
+   * assistive technology tools know to intepret the carousel as a list.
+   *
+   * Note that if the immediate Carousel children do not all render as `'li'` elements,
+   * this should be changed (e.g. pass tag="div") because only 'li' is a valid child of 'ul'.
+   */
+  tag: PropTypes.oneOf(layoutTags)
 };
 Carousel.Item = CarouselItem;
 Carousel.displayName = 'Carousel';

package/lib-module/Carousel/CarouselItem/CarouselItem.js

@@ -2,7 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import View from "react-native-web/dist/exports/View";
 import Platform from "react-native-web/dist/exports/Platform";
-import { selectSystemProps, a11yProps, viewProps } from '../../utils';
+import { layoutTags, getA11yPropsFromHtmlTag, selectSystemProps, a11yProps, viewProps } from '../../utils';
 import { useCarousel } from '../CarouselContext';
 import { jsx as _jsx } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
@@ -15,23 +15,29 @@ const CarouselItem = _ref => {
   let {
     children,
     elementIndex,
+    tag = 'li',
+    hidden,
     ...rest
   } = _ref;
   const {
     width,
-    activeIndex,
-    totalItems
+    activeIndex
   } = useCarousel();
   const selectedProps = selectProps({ ...rest,
-    // `group` role crashes the app on Android so setting it to `none` for Android
-    accessibilityRole: Platform.OS === 'android' ? 'none' : 'group',
-    accessibilityLabel: "Showing ".concat(elementIndex + 1, " of ").concat(totalItems)
+    ...getA11yPropsFromHtmlTag(tag, rest.accessibilityRole)
   });
   const focusabilityProps = activeIndex === elementIndex ? {} : a11yProps.nonFocusableProps;
+  const style = {
+    width
+  };
+
+  if (hidden && Platform.OS === 'web') {
+    // On web, visibility: hidden makes all children non-focusable. It doesn't exist on native.
+    style.visibility = 'hidden';
+  }
+
   return /*#__PURE__*/_jsx(View, {
-    style: {
-      width
-    },
+    style: style,
     ...selectedProps,
     ...focusabilityProps,
     children: children
@@ -54,7 +60,16 @@ CarouselItem.propTypes = { ...selectedSystemPropTypes,
   /**
    * Content of the slide
    */
-  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired
+  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
+
+  /**
+   * Sets the HTML tag of the outer container. By default `'li'` so that assistive technology sees
+   * the Carousel as a list of items.
+   *
+   * Carousel's innermost container defaults to `'ul'` which can be overridden. If the tag of either
+   * `Carousel` or `Carousel.Item` is overriden, the other should be too, to avoid producing invalid HTML.
+   */
+  tag: PropTypes.oneOf(layoutTags)
 };
 CarouselItem.displayName = 'Carousel.Item';
 export default CarouselItem;

package/lib-module/Carousel/dictionary.js

@@ -0,0 +1,16 @@
+// 'stepLabel' and 'stepTrackerLabel' are passed down to StepTracker
+export default {
+  en: {
+    carouselLabel: '%{stepCount} items',
+    iconButtonLabel: 'Show %{itemLabel} %{targetStep} of %{stepCount}',
+    stepLabel: '%{itemLabel} %{stepNumber}',
+    stepTrackerLabel: '%{itemLabel} %{stepNumber} of %{stepCount}'
+  },
+  fr: {
+    // TODO: French translations here
+    carouselLabel: '(fr) %{stepCount} items',
+    iconButtonLabel: '(fr) Show %{itemLabel} %{targetStep} of %{stepCount}',
+    stepLabel: '(fr) %{itemLabel} %{stepNumber}',
+    stepTrackerLabel: '(fr) %{itemLabel} %{stepNumber} of %{stepCount}'
+  }
+};

package/lib-module/InputSupports/InputSupports.js

@@ -16,7 +16,8 @@ const InputSupports = /*#__PURE__*/forwardRef((_ref, ref) => {
     hintPosition = 'inline',
     feedback,
     tooltip,
-    validation
+    validation,
+    nativeID
   } = _ref;
   const {
     space
@@ -30,7 +31,8 @@ const InputSupports = /*#__PURE__*/forwardRef((_ref, ref) => {
     feedback,
     hint,
     label,
-    validation
+    validation,
+    nativeID
   });
   return /*#__PURE__*/_jsxs(StackView, {
     space: space,
@@ -91,6 +93,11 @@ InputSupports.propTypes = {
   /**
    * Use to visually mark an input as valid or invalid.
    */
-  validation: PropTypes.oneOf(['error', 'success'])
+  validation: PropTypes.oneOf(['error', 'success']),
+
+  /**
+   * ID for DOM element on web
+   */
+  nativeID: PropTypes.string
 };
 export default InputSupports;

package/lib-module/InputSupports/useInputSupports.js

@@ -7,7 +7,8 @@ const useInputSupports = _ref => {
     label,
     feedback,
     validation,
-    hint
+    hint,
+    nativeID
   } = _ref;
   const hasValidationError = validation === 'error';
   const inputId = useUniqueId('input');
@@ -22,7 +23,7 @@ const useInputSupports = _ref => {
     accessibilityInvalid: hasValidationError
   };
   return {
-    inputId,
+    inputId: nativeID || inputId,
     hintId,
     feedbackId,
     a11yProps

package/lib-module/Modal/Modal.js

@@ -10,6 +10,7 @@ import { a11yProps, copyPropTypes, getTokensPropType, selectSystemProps, useCopy
 import { useViewport } from '../ViewportProvider';
 import IconButton from '../IconButton';
 import dictionary from './dictionary';
+import useScrollBlocking from '../utils/useScrollBlocking';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
@@ -110,6 +111,7 @@ const Modal = /*#__PURE__*/forwardRef((_ref5, ref) => {
     viewport,
     maxWidth
   });
+  const modalRef = useScrollBlocking(isOpen);
   const {
     closeIcon: CloseIconComponent
   } = themeTokens;
@@ -140,6 +142,7 @@ const Modal = /*#__PURE__*/forwardRef((_ref5, ref) => {
     ...selectProps(rest),
     children: /*#__PURE__*/_jsxs(View, {
       style: [staticStyles.positioningContainer],
+      ref: modalRef,
       children: [/*#__PURE__*/_jsx(View, {
         style: [staticStyles.sizingContainer, selectContainerStyles(themeTokens)],
         pointerEvents: "box-none" // don't capture backdrop press events

package/lib-module/Skeleton/Skeleton.js

@@ -19,6 +19,7 @@ const selectSkeletonStyles = _ref => {
   return {
     backgroundColor: color,
     borderRadius: radius,
+    maxWidth: '100%',
     ...fadeAnimation
   };
 };

package/lib-module/StepTracker/StepTracker.js

@@ -154,19 +154,18 @@ const StepTracker = /*#__PURE__*/forwardRef((_ref4, ref) => {
     })
   });
 });
-StepTracker.displayName = 'StepTracker';
+StepTracker.displayName = 'StepTracker'; // If a language dictionary entry is provided, it must contain every key
+
+const dictionaryContentShape = PropTypes.shape({
+  stepLabel: PropTypes.string.isRequired,
+  stepTrackerLabel: PropTypes.string.isRequired
+});
 StepTracker.propTypes = { ...selectedSystemPropTypes,
   current: PropTypes.number,
-  copy: PropTypes.oneOf(['en', 'fr']),
+  copy: PropTypes.oneOfType([PropTypes.oneOf(['en', 'fr']), dictionaryContentShape]),
   dictionary: PropTypes.shape({
-    en: PropTypes.shape({
-      stepLabel: PropTypes.string,
-      stepTrackerLabel: PropTypes.string
-    }),
-    fr: PropTypes.shape({
-      stepLabel: PropTypes.string,
-      stepTrackerLabel: PropTypes.string
-    })
+    en: dictionaryContentShape,
+    fr: dictionaryContentShape
   }),
   steps: PropTypes.arrayOf(PropTypes.string),
   tokens: getTokensPropType('StepTracker'),

package/lib-module/TextInput/TextInput.js

@@ -40,7 +40,9 @@ const TextInput = /*#__PURE__*/forwardRef((_ref, ref) => {
       validation: supportsProps.validation
     }
   };
-  return /*#__PURE__*/_jsx(InputSupports, { ...supportsProps,
+  return /*#__PURE__*/_jsx(InputSupports, {
+    nativeID: selectedProps.nativeID,
+    ...supportsProps,
     children: _ref2 => {
       let {
         inputId,

package/lib-module/index.js

@@ -17,6 +17,7 @@ export { default as Icon } from './Icon';
 export * from './Icon';
 export { default as IconButton } from './IconButton';
 export { default as InputLabel } from './InputLabel';
+export { default as InputSupports } from './InputSupports';
 export * from './Link';
 export { default as List, ListItem, ListBase } from './List';
 export { default as Modal } from './Modal';

package/lib-module/utils/props/clickProps.js

@@ -1,8 +1,8 @@
 import PropTypes from 'prop-types';
 const clickHandlerMapping = {
   onClick: 'onPress',
-  mouseDown: 'onPressIn',
-  mouseUp: 'onPressOut'
+  onMouseDown: 'onPressIn',
+  onMouseUp: 'onPressOut'
 };
 export default {
   /**