@telus-uds/components-base 1.51.0 → 1.52.0

package/lib/utils/index.js

@@ -15,7 +15,8 @@ var _exportNames = {
   useUniqueId: true,
   withLinkRouter: true,
   containUniqueFields: true,
-  BaseView: true
+  BaseView: true,
+  htmlAttrs: true
 };
 Object.defineProperty(exports, "BaseView", {
   enumerable: true,
@@ -29,6 +30,12 @@ Object.defineProperty(exports, "containUniqueFields", {
     return _containUniqueFields.default;
   }
 });
+Object.defineProperty(exports, "htmlAttrs", {
+  enumerable: true,
+  get: function () {
+    return _htmlAttrs.default;
+  }
+});
 Object.defineProperty(exports, "info", {
   enumerable: true,
   get: function () {
@@ -224,6 +231,8 @@ var _containUniqueFields = _interopRequireDefault(require("./containUniqueFields
 
 var _BaseView = _interopRequireDefault(require("./BaseView"));
 
+var _htmlAttrs = _interopRequireDefault(require("./htmlAttrs"));
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib-module/A11yText/index.js

@@ -37,7 +37,15 @@ const A11yText = /*#__PURE__*/forwardRef((_ref, ref) => {
 });
 A11yText.displayName = 'A11yText';
 A11yText.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Text to be read by screen readers
+   */
   text: PropTypes.string.isRequired,
+
+  /**
+   * Whether text should be rendered as a heading
+   */
   heading: PropTypes.bool
 };
 const styles = StyleSheet.create({

package/lib-module/Divider/Divider.js

@@ -110,6 +110,10 @@ const Divider = /*#__PURE__*/forwardRef((_ref, ref) => {
 Divider.displayName = 'Divider';
 Divider.propTypes = { ...selectedSystemPropTypes,
   tokens: getTokensPropType('Divider'),
+
+  /**
+   * A number referring to a position on the space scale to create space on either side of the divider
+   */
   space: spacingProps.types.spacingValue,
   variant: variantProp.propType,
 

package/lib-module/IconButton/IconButton.js

@@ -120,9 +120,25 @@ IconButton.displayName = 'IconButton';
 IconButton.propTypes = { ...selectedSystemPropTypes,
   variant: variantProp.propType,
   tokens: getTokensPropType('IconButton'),
+
+  /**
+   * Defines the icon to be rendered
+   */
   icon: PropTypes.elementType.isRequired,
+
+  /**
+   * URL to navigate to when the `Iconbutton` is pressed
+   */
   href: PropTypes.string,
+
+  /**
+   * URL options to navigate to when the `Iconbutton` is pressed
+   */
   hrefAttrs: PropTypes.shape(hrefAttrsProp.types),
+
+  /**
+   * Function to execute when the `Iconbutton` is pressed
+   */
   onPress: PropTypes.func
 };
 const staticStyles = StyleSheet.create({

package/lib-module/Link/ChevronLink.js

@@ -52,6 +52,10 @@ const ChevronLink = /*#__PURE__*/forwardRef((_ref, ref) => {
 ChevronLink.displayName = 'ChevronLink';
 ChevronLink.propTypes = { ...LinkBase.propTypes,
   tokens: getTokensPropType('ChevronLink', 'Link'),
+
+  /**
+   * Changes direction of chevron icon
+   */
   direction: PropTypes.oneOf(['left', 'right'])
 };
 export default ChevronLink;

package/lib-module/Listbox/ListboxContext.js

@@ -0,0 +1,6 @@
+import React, { useContext } from 'react';
+const ListboxContext = /*#__PURE__*/React.createContext({});
+
+const useListboxContext = () => useContext(ListboxContext);
+
+export { ListboxContext, useListboxContext };

package/lib-module/Listbox/PressableItem.js

@@ -0,0 +1,150 @@
+/* eslint-disable react/require-default-props */
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import Pressable from "react-native-web/dist/exports/Pressable";
+import Text from "react-native-web/dist/exports/Text";
+import { selectSystemProps, resolvePressableTokens, htmlAttrs } from '../utils';
+import { useListboxContext } from './ListboxContext';
+import { jsxs as _jsxs } from "react/jsx-runtime";
+import { jsx as _jsx } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs]);
+
+const getItemStyles = _ref => {
+  let {
+    groupFontName,
+    groupFontWeight,
+    itemFontSize,
+    itemPaddingTop,
+    itemPaddingBottom,
+    itemPaddingLeft,
+    itemBorderLeftWidth,
+    itemPaddingRight,
+    itemBackgroundColor,
+    itemColor,
+    itemDisplay,
+    itemOutline,
+    itemTextDecoration,
+    itemBorderLeftColor,
+    itemBorderRightWidth,
+    itemBorderRightColor,
+    itemBorderTopWidth,
+    itemBorderTopColor,
+    itemBorderBottomWidth,
+    itemBorderBottomColor,
+    itemBorderRadius,
+    itemHeight
+  } = _ref;
+  return {
+    fontFamily: `${groupFontName}${groupFontWeight}normal`,
+    fontSize: itemFontSize,
+    paddingTop: itemPaddingTop - itemBorderTopWidth,
+    paddingBottom: itemPaddingBottom - itemBorderBottomWidth,
+    paddingLeft: itemPaddingLeft - itemBorderLeftWidth,
+    paddingRight: itemPaddingRight - itemBorderRightWidth,
+    width: '100%',
+    backgroundColor: itemBackgroundColor,
+    color: itemColor,
+    display: itemDisplay,
+    outline: itemOutline,
+    textDecoration: itemTextDecoration,
+    borderLeft: `${itemBorderLeftWidth}px solid ${itemBorderLeftColor}`,
+    borderRight: `${itemBorderRightWidth}px solid ${itemBorderRightColor}`,
+    borderTop: `${itemBorderTopWidth}px solid ${itemBorderTopColor}`,
+    borderBottom: `${itemBorderBottomWidth}px solid ${itemBorderBottomColor}`,
+    borderRadius: itemBorderRadius,
+    height: itemHeight,
+    justifyContent: 'center'
+  };
+};
+
+const PressableItem = /*#__PURE__*/forwardRef((_ref2, ref) => {
+  let {
+    children,
+    href,
+    isChild = false,
+    onBlur,
+    onPress,
+    tabIndex = 0,
+    nextItemRef,
+    prevItemRef,
+    tokens,
+    id,
+    ...rest
+  } = _ref2;
+  const {
+    selectedId,
+    setSelectedId
+  } = useListboxContext();
+
+  const selectTextStyles = _ref3 => {
+    let {
+      groupFontName,
+      groupFontWeight,
+      itemFontSize,
+      itemColor,
+      lineHeight
+    } = _ref3;
+    return {
+      fontFamily: `${groupFontName}${groupFontWeight}normal`,
+      fontSize: itemFontSize,
+      color: itemColor,
+      lineHeight: lineHeight * itemFontSize
+    };
+  };
+
+  const resolveButtonTokens = pressableState => {
+    const themeTokens = resolvePressableTokens(tokens, pressableState, {
+      isChild,
+      current: id === selectedId && id !== undefined
+    });
+    return themeTokens;
+  };
+
+  const handleKeyPress = event => {
+    if (['Enter', ' '].includes(event === null || event === void 0 ? void 0 : event.key)) {
+      onPress === null || onPress === void 0 ? void 0 : onPress(event);
+    } else if ((event === null || event === void 0 ? void 0 : event.key) === 'ArrowDown') {
+      nextItemRef.current.focus();
+    } else if ((event === null || event === void 0 ? void 0 : event.key) === 'ArrowUp' && prevItemRef !== null && prevItemRef !== void 0 && prevItemRef.current) {
+      prevItemRef.current.focus();
+    }
+  };
+
+  return /*#__PURE__*/_jsx(Pressable, {
+    isChild: isChild,
+    style: pressableState => getItemStyles(resolveButtonTokens(pressableState)),
+    onBlur: onBlur,
+    onClick: onPress,
+    onKeyPress: handleKeyPress,
+    ref: ref,
+    tabIndex: tabIndex,
+    ...(href && {
+      href
+    }),
+    ...(onPress && {
+      onClick: onPress
+    }),
+    ...selectProps(rest),
+    onPress: () => {
+      setSelectedId(id);
+      onPress();
+    },
+    children: pressableState => {
+      return /*#__PURE__*/_jsxs(Text, {
+        style: selectTextStyles(resolveButtonTokens(pressableState)),
+        children: [children, " "]
+      });
+    }
+  });
+});
+PressableItem.displayName = 'PressableItem';
+PressableItem.propTypes = { ...selectedSystemPropTypes,
+  href: PropTypes.string,
+  isChild: PropTypes.bool,
+  children: PropTypes.node.isRequired,
+  onBlur: PropTypes.func,
+  onPress: PropTypes.func,
+  nextItemRef: PropTypes.object,
+  prevItemRef: PropTypes.object
+};
+export default PressableItem;

package/lib-module/Listbox/index.js

@@ -0,0 +1,2 @@
+export * from './ListboxContext';
+export { default as PressableItem } from './PressableItem';

package/lib-module/Modal/Modal.js

@@ -6,7 +6,7 @@ import NativeModal from "react-native-web/dist/exports/Modal";
 import Platform from "react-native-web/dist/exports/Platform";
 import PropTypes from 'prop-types';
 import { applyShadowToken, useThemeTokens } from '../ThemeProvider';
-import { a11yProps, copyPropTypes, getTokensPropType, selectSystemProps, useCopy, variantProp, viewProps, selectTokens } from '../utils';
+import { a11yProps, copyPropTypes, getTokensPropType, selectSystemProps, useCopy, variantProp, viewProps } from '../utils';
 import { useViewport } from '../ViewportProvider';
 import IconButton from '../IconButton';
 import dictionary from './dictionary';
@@ -157,8 +157,7 @@ const Modal = /*#__PURE__*/forwardRef((_ref5, ref) => {
               onPress: handleClose,
               icon: CloseIconComponent,
               accessibilityRole: "button",
-              accessibilityLabel: closeLabel,
-              tokens: selectTokens('IconButton', themeTokens, 'close')
+              accessibilityLabel: closeLabel
             })
           }), children]
         })
@@ -174,9 +173,25 @@ const Modal = /*#__PURE__*/forwardRef((_ref5, ref) => {
 Modal.displayName = 'Modal';
 Modal.propTypes = { ...selectedSystemPropTypes,
   children: PropTypes.oneOfType([PropTypes.node, PropTypes.arrayOf(PropTypes.node)]),
+
+  /**
+   * To define the locale of the copy
+   */
   copy: copyPropTypes,
+
+  /**
+   * Setting this to `true` will open the `Modal`
+   */
   isOpen: PropTypes.bool,
+
+  /**
+   * This function is triggered when the `Modal` is closed
+   */
   onClose: PropTypes.func,
+
+  /**
+   * `max-width` is applied to the `Modal` container
+   */
   maxWidth: PropTypes.bool,
   tokens: getTokensPropType('Modal'),
   variant: variantProp.propType,

package/lib-module/MultiSelectFilter/MultiSelectFilter.js

@@ -1,5 +1,7 @@
 import React, { useState, useEffect } from 'react';
 import PropTypes from 'prop-types';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
 import { useThemeTokens, useThemeTokensCallback, applyTextStyles } from '../ThemeProvider';
 import { containUniqueFields, getTokensPropType, getPressHandlersWithArgs, selectTokens, useOverlaidPosition, useCopy, useMultipleInputValues, useResponsiveProp, variantProp } from '../utils';
 import dictionary from './dictionary';
@@ -282,11 +284,14 @@ const MultiSelectFilter = _ref3 => {
       isReady: isReady,
       onLayout: onTargetLayout,
       children: [/*#__PURE__*/_jsx(Row, {
-        children: /*#__PURE__*/_jsx(Typography, {
-          tokens: { ...headerStyles,
-            lineHeight: headerLineHeight
-          },
-          children: getCopy('filterByLabel').replace(/%\{filterCategory\}/g, label.toLowerCase())
+        children: /*#__PURE__*/_jsx(View, {
+          style: styles.textContainerStyle,
+          children: /*#__PURE__*/_jsx(Typography, {
+            tokens: { ...headerStyles,
+              lineHeight: headerLineHeight
+            },
+            children: getCopy('filterByLabel').replace(/%\{filterCategory\}/g, label.toLowerCase())
+          })
         })
       }), subtitle && /*#__PURE__*/_jsxs(_Fragment, {
         children: [/*#__PURE__*/_jsx(Spacer, {
@@ -355,6 +360,11 @@ const MultiSelectFilter = _ref3 => {
 };
 
 MultiSelectFilter.displayName = 'MultiSelectFilter';
+const styles = StyleSheet.create({
+  textContainerStyle: {
+    marginRight: 52
+  }
+});
 MultiSelectFilter.propTypes = {
   /**
    * The text displayed to the user in a ButtonDropdown.

package/lib-module/Pagination/PageButton.js

@@ -57,8 +57,20 @@ const PageButton = /*#__PURE__*/forwardRef((_ref, ref) => {
 });
 PageButton.displayName = 'PageButton';
 PageButton.propTypes = { ...linkProps.types,
+
+  /**
+   * To set custom label for the button
+   */
   label: PropTypes.string,
+
+  /**
+   * To set `PageButton` to active state
+   */
   isActive: PropTypes.bool,
+
+  /**
+   * To change the language for labels
+   */
   copy: copyPropTypes,
   variant: variantProp.propType,
   tokens: getTokensPropType('PaginationPageButton')

package/lib-module/Pagination/Pagination.js

@@ -183,10 +183,22 @@ Pagination.PageButton = PageButton;
 Pagination.propTypes = { ...selectedSystemPropTypes,
   ...withLinkRouter.propTypes,
   children: componentPropType('PageButton'),
+
+  /**
+   * To change the language for labels
+   */
   copy: copyPropTypes,
   variant: variantProp.propType,
   tokens: getTokensPropType('Pagination'),
+
+  /**
+   * When passed as `{{ compact: true }}`, `Pagination` does not render labels along side buttons
+   */
   sideButtonVariant: variantProp.propType,
+
+  /**
+   * Custom tokens for `PaginationSideButton`
+   */
   sideButtonTokens: getTokensPropType('PaginationSideButton')
 };
 const staticStyles = StyleSheet.create({

package/lib-module/QuickLinks/QuickLinks.js

@@ -62,8 +62,20 @@ const QuickLinks = /*#__PURE__*/forwardRef((_ref, ref) => {
 QuickLinks.displayName = 'QuickLinks';
 QuickLinks.propTypes = {
   tokens: getTokensPropType('QuickLinks'),
+
+  /**
+   * Custom tokens override for `Card`
+   */
   cardTokens: getTokensPropType('Card'),
+
+  /**
+   * Custom tokens override for `QuickLinksList`
+   */
   listTokens: getTokensPropType('QuickLinksList'),
+
+  /**
+   * The HTML tag to render the list as
+   */
   tag: PropTypes.string,
   variant: variantProp.propType,
   children: PropTypes.node

package/lib-module/Responsive/Responsive.js

@@ -38,7 +38,14 @@ const Responsive = _ref => {
 };
 
 Responsive.propTypes = {
+  /**
+   * To hide children of `Responsive` if the current viewport is smaller than `min`
+   */
   min: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
+
+  /**
+   * To hide children of `Responsive` if the current viewport is larger than `max`
+   */
   max: PropTypes.oneOf(['sm', 'md', 'lg', 'xl']),
   children: PropTypes.node.isRequired
 };

package/lib-module/Select/Group.js

@@ -17,5 +17,9 @@ const Group = _ref => {
 export default Group;
 Group.propTypes = {
   children: componentPropType('Item'),
+
+  /**
+   * The label for the group.
+   */
   label: PropTypes.string.isRequired
 };

package/lib-module/Select/Group.native.js

@@ -11,5 +11,9 @@ const Group = _ref => {
 export default Group;
 Group.propTypes = {
   children: componentPropType('Item'),
+
+  /**
+   * The label for the group.
+   */
   label: PropTypes.string.isRequired
 };

package/lib-module/Select/Item.js

@@ -16,5 +16,9 @@ const Item = _ref => {
 export default Item;
 Item.propTypes = {
   children: PropTypes.string.isRequired,
+
+  /**
+   * The value of the option
+   */
   value: PropTypes.string.isRequired
 };

package/lib-module/SideNav/ItemsGroup.js

@@ -122,6 +122,10 @@ ItemsGroup.propTypes = {
   isActive: PropTypes.bool,
   variant: variantProp.propType,
   tokens: getTokensPropType('SideNavItemsGroup'),
+
+  /**
+   * Custom tokens for `SideNav.Item`
+   */
   itemTokens: getTokensPropType('SideNavItem')
 };
 export default ItemsGroup;

package/lib-module/SideNav/SideNav.js

@@ -128,7 +128,15 @@ SideNav.propTypes = { ...selectedSystemPropTypes,
   accordion: PropTypes.bool,
   variant: variantProp.propType,
   tokens: getTokensPropType('SideNav'),
+
+  /**
+   * Custom tokens for `SideNav.Item`
+   */
   itemTokens: getTokensPropType('SideNavItem'),
+
+  /**
+   * Custom tokens for `SideNavItemsGroup`
+   */
   groupTokens: getTokensPropType('SideNavItemsGroup')
 };
 SideNav.Item = Item;

package/lib-module/StepTracker/StepTracker.js

@@ -168,12 +168,28 @@ const dictionaryContentShape = PropTypes.shape({
   stepTrackerLabel: PropTypes.string.isRequired
 });
 StepTracker.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * The current step, 0-based number
+   */
   current: PropTypes.number,
+
+  /**
+   * The language to use for the labels
+   */
   copy: PropTypes.oneOfType([PropTypes.oneOf(['en', 'fr']), dictionaryContentShape]),
+
+  /**
+   * Custom dictionary containing the labels to use for the steps
+   */
   dictionary: PropTypes.shape({
     en: dictionaryContentShape,
     fr: dictionaryContentShape
   }),
+
+  /**
+   * An array of strings defining the step titles
+   */
   steps: PropTypes.arrayOf(PropTypes.string),
   tokens: getTokensPropType('StepTracker'),
   variant: variantProp.propType

package/lib-module/Tabs/Tabs.js

@@ -132,6 +132,10 @@ const Tabs = /*#__PURE__*/forwardRef((_ref, ref) => {
 Tabs.displayName = 'Tabs';
 Tabs.propTypes = { ...selectedSystemPropTypes,
   ...withLinkRouter.PropTypes,
+
+  /**
+   * Array of `TabsItem`s
+   */
   items: PropTypes.arrayOf(PropTypes.shape({ ...selectedItemPropTypes,
     ...withLinkRouter.PropTypes,
     href: PropTypes.string,
@@ -139,11 +143,27 @@ Tabs.propTypes = { ...selectedSystemPropTypes,
     id: PropTypes.string,
     ref: ABBPropTypes.ref()
   })),
+
+  /**
+   * `id` property of the current tab in the items array
+   */
   value: PropTypes.string,
   initialValue: PropTypes.string,
+
+  /**
+   * Callback for when the selected tab changes
+   */
   onChange: PropTypes.func,
   tokens: getTokensPropType('Tabs'),
+
+  /**
+   * Custom tokens for `TabsItem`
+   */
   itemTokens: getTokensPropType('TabsItem'),
+
+  /**
+   * Custom tokens for `HorizontalScrollButton`
+   */
   scrollButtonTokens: getTokensPropType('HorizontalScrollButton'),
   variant: variantProp.propType
 };

package/lib-module/Timeline/Timeline.js

@@ -26,14 +26,14 @@ const selectDotStyles = _ref => {
 
 const selectConnectorStyles = _ref2 => {
   let {
-    timelineColor,
+    timelineConnectorColor,
     connectorHeight,
     connectorWidth
   } = _ref2;
   return {
     width: connectorWidth,
     height: connectorHeight,
-    backgroundColor: timelineColor
+    backgroundColor: timelineConnectorColor
   };
 };
 

package/lib-module/index.js

@@ -4,6 +4,7 @@ export { default as Box } from './Box';
 export * from './Button';
 export { default as Card, PressableCardBase } from './Card';
 export * from './Carousel';
+export * from './Listbox';
 export { default as Checkbox } from './Checkbox';
 export * from './Checkbox';
 export { default as Divider } from './Divider';

package/lib-module/utils/htmlAttrs.js

@@ -0,0 +1,22 @@
+import PropTypes from 'prop-types';
+const htmlAttrTypes = {
+  dataSet: PropTypes.object,
+  id: PropTypes.string,
+  loading: PropTypes.oneOf(['eager', 'lazy']),
+  // @todo figure out if we need to enum all the possible roles or maybe use
+  // an npm package
+  role: PropTypes.string,
+  src: PropTypes.string,
+  tabIndex: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  testID: PropTypes.string,
+  title: PropTypes.string
+};
+export default {
+  types: htmlAttrTypes,
+  select: props => Object.entries(props).reduce((items, _ref) => {
+    let [key, value] = _ref;
+    return Object.keys(htmlAttrTypes).includes(key) || /^(data|aria)-/.test(key) ? { ...items,
+      [key]: value
+    } : items;
+  }, {})
+};

package/lib-module/utils/index.js

@@ -17,4 +17,5 @@ export { default as useUniqueId } from './useUniqueId';
 export { default as withLinkRouter } from './withLinkRouter';
 export * from './ssr';
 export { default as containUniqueFields } from './containUniqueFields';
-export { default as BaseView } from './BaseView';
+export { default as BaseView } from './BaseView';
+export { default as htmlAttrs } from './htmlAttrs';

package/package.json

@@ -11,7 +11,7 @@
     "@floating-ui/react-native": "^0.8.1",
     "@gorhom/portal": "^1.0.14",
     "@telus-uds/system-constants": "^1.2.1",
-    "@telus-uds/system-theme-tokens": "^2.33.0",
+    "@telus-uds/system-theme-tokens": "^2.35.0",
     "airbnb-prop-types": "^2.16.0",
     "lodash.debounce": "^4.0.8",
     "lodash.merge": "^4.6.2",
@@ -72,5 +72,5 @@
   "standard-engine": {
     "skip": true
   },
-  "version": "1.51.0"
+  "version": "1.52.0"
 }

package/src/A11yText/index.jsx

@@ -31,7 +31,13 @@ A11yText.displayName = 'A11yText'
 
 A11yText.propTypes = {
   ...selectedSystemPropTypes,
+  /**
+   * Text to be read by screen readers
+   */
   text: PropTypes.string.isRequired,
+  /**
+   * Whether text should be rendered as a heading
+   */
   heading: PropTypes.bool
 }
 

package/src/Divider/Divider.jsx

@@ -101,6 +101,9 @@ Divider.displayName = 'Divider'
 Divider.propTypes = {
   ...selectedSystemPropTypes,
   tokens: getTokensPropType('Divider'),
+  /**
+   * A number referring to a position on the space scale to create space on either side of the divider
+   */
   space: spacingProps.types.spacingValue,
   variant: variantProp.propType,
   /**