@telus-uds/components-base 3.12.2 → 3.14.0

package/lib/cjs/Tabs/TabsDropdown.js

@@ -0,0 +1,252 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _Pressable = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Pressable"));
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+var _Text = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Text"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _ViewportProvider = require("../ViewportProvider");
+var _Icon = _interopRequireDefault(require("../Icon"));
+var _Listbox = _interopRequireDefault(require("../Listbox"));
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.viewProps]);
+const selectButtonContentStyles = _ref => {
+  let {
+    backgroundColor,
+    borderColor,
+    borderWidth,
+    borderRadius,
+    paddingHorizontal,
+    paddingVertical,
+    marginHorizontal,
+    marginVertical
+  } = _ref;
+  return {
+    backgroundColor,
+    borderColor,
+    borderWidth,
+    borderRadius,
+    paddingHorizontal,
+    paddingVertical,
+    marginLeft: marginHorizontal,
+    marginRight: marginHorizontal,
+    marginTop: marginVertical,
+    marginBottom: marginVertical
+  };
+};
+
+/**
+ * TabsDropdown renders a dropdown version of tabs for mobile/tablet viewports.
+ * It shows the currently selected tab as a button that opens a dropdown menu
+ * containing all available tabs.
+ *
+ * This is rendered automatically by `Tabs` on mobile viewports and when variant
+ * is dropdown and isn't intended to be used directly.
+ */
+const TabsDropdown = /*#__PURE__*/_react.default.forwardRef((_ref2, ref) => {
+  let {
+    itemTokens,
+    variant,
+    value,
+    onChange,
+    items = [],
+    LinkRouter,
+    linkRouterProps,
+    accessibilityRole = 'button',
+    copy = 'en',
+    dictionary: customDictionary = _dictionary.default,
+    ...rest
+  } = _ref2;
+  const {
+    themeOptions
+  } = (0, _ThemeProvider.useTheme)();
+  const viewport = (0, _ViewportProvider.useViewport)();
+  const [isOpen, setIsOpen] = _react.default.useState(false);
+  const getTokens = (0, _ThemeProvider.useThemeTokensCallback)('TabsItem', itemTokens, {
+    viewport,
+    ...variant
+  });
+  const selectedItem = items.find(item => {
+    const itemId = item.id ?? item.label;
+    return value === itemId;
+  }) || items[0];
+  const {
+    overlaidPosition,
+    sourceRef,
+    targetRef,
+    onTargetLayout,
+    isReady
+  } = (0, _utils.useOverlaidPosition)({
+    isShown: isOpen,
+    offsets: {
+      vertical: 4
+    },
+    align: {
+      top: 'bottom',
+      left: 'left'
+    }
+  });
+  const handleToggle = () => setIsOpen(prev => !prev);
+  const handleClose = () => setIsOpen(false);
+  const handleItemSelect = (item, event) => {
+    const itemId = item.id ?? item.label;
+    setIsOpen(false);
+    if (onChange) onChange(itemId, event);
+    if (item.onPress) item.onPress(event);
+  };
+  const listboxItems = items.map(item => ({
+    ...item,
+    onPress: event => handleItemSelect(item, event)
+  }));
+  const isSelected = Boolean(selectedItem && value);
+  const getCopy = (0, _utils.useCopy)({
+    dictionary: customDictionary,
+    copy
+  });
+  const selectedProps = selectProps({
+    accessibilityRole,
+    ...rest
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+    ref: ref,
+    style: styles.container,
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Pressable.default, {
+      ref: sourceRef,
+      onPress: handleToggle,
+      ...selectedProps,
+      style: styles.pressable,
+      children: pressableState => {
+        // Use resolvePressableTokens like TabBarItem does for proper state handling
+        const resolvedTokens = (0, _utils.resolvePressableTokens)(getTokens, pressableState, {
+          viewport,
+          expanded: isOpen,
+          selected: isSelected
+        });
+        const textStyles = (0, _ThemeProvider.applyTextStyles)({
+          ...(0, _utils.selectTokens)('Typography', resolvedTokens),
+          themeOptions
+        });
+
+        // Get dropdown icons from resolved tokens
+        const dropdownIcon = isOpen ? resolvedTokens.dropdownIconExpanded : resolvedTokens.dropdownIcon;
+        return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+          style: [styles.buttonContent, selectButtonContentStyles(resolvedTokens)],
+          children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+            style: textStyles,
+            children: selectedItem?.label || getCopy('selectTab')
+          }), dropdownIcon && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Icon.default, {
+            icon: dropdownIcon,
+            variant: {
+              size: 'micro'
+            },
+            tokens: {
+              color: textStyles.color
+            }
+          })]
+        });
+      }
+    }), isOpen && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Listbox.default.Overlay, {
+      overlaidPosition: overlaidPosition,
+      maxWidth: 400,
+      minWidth: 200,
+      isReady: isReady,
+      onLayout: onTargetLayout,
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Listbox.default, {
+        items: listboxItems,
+        firstItemRef: targetRef,
+        parentRef: sourceRef,
+        selectedId: value,
+        onClose: handleClose,
+        LinkRouter: LinkRouter,
+        linkRouterProps: linkRouterProps
+      })
+    })]
+  });
+});
+TabsDropdown.displayName = 'TabsDropdown';
+const dictionaryContentShape = _propTypes.default.shape({
+  selectTab: _propTypes.default.string.isRequired
+});
+TabsDropdown.propTypes = {
+  ...selectedSystemPropTypes,
+  ..._utils.withLinkRouter.propTypes,
+  /**
+   * Array of tab items
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.shape({
+    ..._utils.withLinkRouter.propTypes,
+    /** URL to navigate to when the tab is pressed */
+    href: _propTypes.default.string,
+    /** Display text for the tab */
+    label: _propTypes.default.string,
+    /** Unique identifier for the tab */
+    id: _propTypes.default.string,
+    /** Reference to the tab element */
+    ref: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
+    /** Custom render function for the tab content */
+    render: _propTypes.default.func
+  })),
+  /**
+   * Current selected tab id
+   */
+  value: _propTypes.default.string,
+  /**
+   * Callback for when the selected tab changes
+   */
+  onChange: _propTypes.default.func,
+  /**
+   * Custom tokens for the main Tabs container
+   */
+  tokens: (0, _utils.getTokensPropType)('Tabs'),
+  /**
+   * Custom tokens for `TabsItem`
+   */
+  itemTokens: (0, _utils.getTokensPropType)('TabsItem'),
+  /**
+   * Visual and behavioral variants for the tabs dropdown
+   */
+  variant: _utils.variantProp.propType,
+  /**
+   * Select English or French copy for the accessible labels.
+   * You may also pass in a custom dictionary object.
+   */
+  copy: _propTypes.default.oneOfType([_propTypes.default.oneOf(['en', 'fr']), dictionaryContentShape]),
+  /**
+   * Override the default dictionary, by passing the complete dictionary object for `en` and `fr`
+   */
+  dictionary: _propTypes.default.shape({
+    en: dictionaryContentShape,
+    fr: dictionaryContentShape
+  })
+};
+const styles = _StyleSheet.default.create({
+  container: {
+    position: 'relative',
+    width: '100%'
+  },
+  pressable: {
+    outlineWidth: 0,
+    outlineStyle: 'none',
+    outlineColor: 'transparent'
+  },
+  buttonContent: {
+    display: 'flex',
+    flexDirection: 'row',
+    alignItems: 'center',
+    justifyContent: 'space-between',
+    width: '100%',
+    minHeight: 44,
+    outline: 'none',
+    boxSizing: 'border-box'
+  }
+});
+var _default = exports.default = TabsDropdown;

package/lib/cjs/Tabs/TabsItem.js

@@ -79,8 +79,10 @@ const selectContainerStyles = _ref3 => {
     borderRadius,
     paddingHorizontal: paddingHorizontal - borderWidth,
     paddingVertical: paddingVertical - borderWidth,
-    marginHorizontal,
-    marginVertical
+    marginLeft: marginHorizontal,
+    marginRight: marginHorizontal,
+    marginTop: marginVertical,
+    marginBottom: marginVertical
   };
 };
 

package/lib/cjs/Tabs/dictionary.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  en: {
+    selectTab: 'Select tab'
+  },
+  fr: {
+    selectTab: 'Sélectionner un onglet'
+  }
+};

package/lib/cjs/ViewportProvider/ViewportProvider.js

@@ -13,13 +13,18 @@ var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
  * Provides an up-to-date viewport value from system-constants, available via the `useViewport` hook
+ *
+ * @param {React.ReactNode} children - Child components that will have access to viewport context
+ * @param {string} [defaultViewport] - Default viewport to use during server-side rendering.
+ *   Must be one of the viewport keys from system-constants. If not provided, defaults to the smallest viewport.
  */const ViewportProvider = _ref => {
   let {
-    children
+    children,
+    defaultViewport
   } = _ref;
   // Default to the smallest viewport for mobile-first SSR. On client side, this is updated
   // by useViewportListener in a layout effect before anything is shown to the user.
-  const [viewport, setViewport] = _react.default.useState(_systemConstants.viewports.keys[0]);
+  const [viewport, setViewport] = _react.default.useState(defaultViewport || _systemConstants.viewports.keys[0]);
   (0, _useViewportListener.default)(setViewport);
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_useViewport.ViewportContext.Provider, {
     value: viewport,
@@ -27,6 +32,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
   });
 };
 ViewportProvider.propTypes = {
-  children: _propTypes.default.node.isRequired
+  children: _propTypes.default.node.isRequired,
+  defaultViewport: _propTypes.default.oneOf(_systemConstants.viewports.keys)
 };
 var _default = exports.default = ViewportProvider;

package/lib/cjs/utils/props/inputSupportsProps.js

@@ -44,7 +44,7 @@ var _default = exports.default = {
      * 1. `tooltip` as a string - The content of the tooltip.
      * 2. `tooltip` as an object - Tooltip component props to be passed.
      */
-    tooltip: _propTypes.default.oneOfType([_shared.default, _propTypes.default.string]),
+    tooltip: _propTypes.default.oneOfType([_propTypes.default.shape(_shared.default), _propTypes.default.string]),
     /**
      * Use to visually mark an input as valid or invalid.
      */

package/lib/esm/BaseProvider/index.js

@@ -1,6 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { PortalProvider } from '@gorhom/portal';
+import { viewports } from '@telus-uds/system-constants';
 import A11yInfoProvider from '../A11yInfoProvider';
 import ViewportProvider from '../ViewportProvider';
 import ThemeProvider from '../ThemeProvider';
@@ -17,6 +18,7 @@ const BaseProvider = /*#__PURE__*/React.forwardRef((_ref, _) => {
   return /*#__PURE__*/_jsx(HydrationProvider, {
     children: /*#__PURE__*/_jsx(A11yInfoProvider, {
       children: /*#__PURE__*/_jsx(ViewportProvider, {
+        defaultViewport: themeOptions?.defaultViewport,
         children: /*#__PURE__*/_jsx(ThemeProvider, {
           defaultTheme: defaultTheme,
           themeOptions: themeOptions,
@@ -34,7 +36,8 @@ BaseProvider.propTypes = {
   defaultTheme: ThemeProvider.propTypes?.defaultTheme,
   themeOptions: PropTypes.shape({
     forceAbsoluteFontSizing: PropTypes.bool,
-    forceZIndex: PropTypes.bool
+    forceZIndex: PropTypes.bool,
+    defaultViewport: PropTypes.oneOf(viewports.keys)
   })
 };
 export default BaseProvider;

package/lib/esm/Button/ButtonDropdown.js

@@ -1,16 +1,17 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import Platform from "react-native-web/dist/exports/Platform";
+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 buttonPropTypes, { textAndA11yText } from './propTypes';
 import ButtonBase from './ButtonBase';
-import { useThemeTokensCallback } from '../ThemeProvider';
+import { applyTextStyles, useThemeTokensCallback } from '../ThemeProvider';
 import { a11yProps, getTokensPropType, focusHandlerProps, resolvePressableState, selectTokens, useInputValue } from '../utils';
 import Icon from '../Icon';
-import { getStackedContent } from '../StackView';
 import { getPressHandlersWithArgs } from '../utils/pressability';
-import { jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const FULL_WIDTH_STYLE = 'full';
 const selectIconTokens = _ref => {
   let {
     icon,
@@ -49,6 +50,44 @@ const selectIconTokens = _ref => {
     }
   };
 };
+const selectDescriptionTextStyles = tokens => ({
+  ...applyTextStyles({
+    fontName: tokens?.descriptionFontName,
+    fontSize: tokens?.descriptionFontSize,
+    fontWeight: tokens?.descriptionFontWeight,
+    fontColor: tokens?.color
+  }),
+  paddingBottom: tokens?.descriptionTextPaddingBottom
+});
+const selectLeadIconTokens = tokens => ({
+  color: tokens?.leadIconColor,
+  backgroundColor: tokens?.leadIconBackgroundColor,
+  size: tokens?.leadIconSize,
+  borderRadius: tokens?.leadIconBorderRadius,
+  padding: tokens?.leadIconPadding
+});
+const selectLeadIconContainerStyles = tokens => ({
+  paddingTop: tokens?.leadIconContainerPaddingTop,
+  paddingBottom: tokens?.leadIconContainerPaddingBottom,
+  paddingLeft: tokens?.leadIconContainerPaddingLeft,
+  paddingRight: tokens?.leadIconContainerPaddingRight
+});
+const selectTextContainerStyles = tokens => ({
+  paddingLeft: tokens?.textPaddingLeft,
+  paddingRight: tokens?.textPaddingRight
+});
+const selectStackedContentStyles = (tokens, iconPosition, isFullWidth) => ({
+  ...staticStyles.stackedContent,
+  gap: tokens?.iconSpace,
+  flexDirection: iconPosition === 'left' ? 'row' : 'row-reverse',
+  ...(Platform.OS === 'web' && {
+    flex: 1
+  }),
+  ...(isFullWidth && {
+    justifyContent: 'space-between',
+    flex: 1
+  })
+});
 const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
   let {
     value,
@@ -61,8 +100,11 @@ const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     readOnly = false,
     children = null,
     accessibilityRole = 'radio',
+    description,
+    singleOption,
     ...props
   } = _ref2;
+  const isFullWidth = variant?.width === FULL_WIDTH_STYLE;
   const {
     currentValue: isOpen,
     setValue: setIsOpen
@@ -78,7 +120,13 @@ const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     ...variant
   };
   const getTokens = useThemeTokensCallback('ButtonDropdown', tokens, extraState);
-  const getButtonTokens = buttonState => selectTokens('Button', getTokens(buttonState));
+  const getButtonTokens = buttonState => ({
+    ...selectTokens('Button', getTokens(buttonState)),
+    iconSpace: props?.icon ? getTokens(buttonState)?.iconSpace : 0,
+    ...(isFullWidth && {
+      width: 'full'
+    })
+  });
 
   // Pass an object of relevant component state as first argument for any passed-in press handlers
   const pressHandlers = getPressHandlersWithArgs(props, [{
@@ -96,7 +144,7 @@ const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     ...pressHandlers,
     onPress: handlePress,
     tokens: getButtonTokens,
-    inactive: inactive,
+    inactive: singleOption || inactive,
     icon: () => null,
     accessibilityRole: accessibilityRole,
     ...props,
@@ -112,14 +160,14 @@ const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       // - Token sets: https://github.com/telus/universal-design-system/issues/782
 
       const itemTokens = getTokens(buttonState);
+      const leadIcon = itemTokens?.leadIcon;
       const {
         iconTokens,
         iconPosition,
-        iconSpace,
         iconWrapperStyle,
         icon: IconComponent
       } = selectIconTokens(itemTokens);
-      const iconContent = IconComponent ? /*#__PURE__*/_jsx(View, {
+      const iconContent = IconComponent && !singleOption ? /*#__PURE__*/_jsx(View, {
         style: iconWrapperStyle,
         children: /*#__PURE__*/_jsx(Icon, {
           icon: IconComponent,
@@ -130,13 +178,28 @@ const ButtonDropdown = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
         ...resolvePressableState(buttonState, extraState),
         textStyles
       }) : children;
-      const content = children ? childrenContent() : /*#__PURE__*/_jsx(Text, {
-        style: textStyles,
-        children: label
+      const content = children ? childrenContent() : /*#__PURE__*/_jsxs(View, {
+        style: staticStyles.contentContainer,
+        children: [leadIcon && /*#__PURE__*/_jsx(View, {
+          style: selectLeadIconContainerStyles(itemTokens),
+          children: /*#__PURE__*/_jsx(Icon, {
+            icon: leadIcon,
+            tokens: selectLeadIconTokens(itemTokens)
+          })
+        }), /*#__PURE__*/_jsxs(View, {
+          style: [staticStyles.textContainer, selectTextContainerStyles(itemTokens)],
+          children: [/*#__PURE__*/_jsx(Text, {
+            style: textStyles,
+            children: label
+          }), description && /*#__PURE__*/_jsx(Text, {
+            style: selectDescriptionTextStyles(itemTokens),
+            children: description
+          })]
+        })]
       });
-      return getStackedContent(iconPosition === 'left' ? [iconContent, content] : [content, iconContent], {
-        space: iconSpace,
-        direction: 'row'
+      return /*#__PURE__*/_jsxs(View, {
+        style: selectStackedContentStyles(itemTokens, iconPosition, isFullWidth),
+        children: [iconContent, content]
       });
     }
   });
@@ -168,6 +231,36 @@ ButtonDropdown.propTypes = {
   /**
    * By default, `ButtonDropdown` is treated by accessibility tools as a radio button.
    */
-  accessibilityRole: PropTypes.string
+  accessibilityRole: PropTypes.string,
+  /**
+   * The description of ButtonDropdown.
+   */
+  description: PropTypes.string,
+  /**
+   * Use this prop to render the ButtonDropdown as display only without any interaction when there is only one option.
+   */
+  singleOption: PropTypes.bool
 };
+const staticStyles = StyleSheet.create({
+  textContainer: {
+    alignItems: 'flex-start',
+    flexShrink: 1,
+    ...(Platform.OS === 'web' && {
+      flex: 1
+    })
+  },
+  contentContainer: {
+    flexDirection: 'row',
+    alignContent: 'center',
+    alignItems: 'center',
+    ...(Platform.OS === 'web' && {
+      flex: 1
+    }),
+    flexShrink: 1
+  },
+  stackedContent: {
+    flexDirection: 'row',
+    alignItems: 'center'
+  }
+});
 export default ButtonDropdown;

package/lib/esm/Card/Card.js

@@ -5,7 +5,7 @@ import { useThemeTokens, useThemeTokensCallback, useResponsiveThemeTokens, useTh
 import { getTokensPropType, variantProp, StyleSheet, createMediaQueryStyles } from '../utils';
 import { useViewport } from '../ViewportProvider';
 import { a11yProps, linkProps, selectSystemProps, viewProps, responsiveProps, hrefAttrsProp } from '../utils/props';
-import CardBase from './CardBase';
+import CardBase, { selectStyles } from './CardBase';
 import PressableCardBase from './PressableCardBase';
 import CheckboxButton from '../Checkbox/CheckboxButton';
 import RadioButton from '../Radio/RadioButton';
@@ -182,12 +182,27 @@ const Card = /*#__PURE__*/React.forwardRef((_ref3, ref) => {
   let cardStyles;
   let mediaIds;
   if (enableMediaQueryStyleSheet) {
-    const mediaQueryStyleSheet = createMediaQueryStyles(themeTokens);
+    const transformedThemeTokens = Object.entries(themeTokens).reduce((acc, _ref4) => {
+      let [vp, viewportTokens] = _ref4;
+      const tokensToTransform = selectionType ? selectStyles({
+        ...viewportTokens,
+        paddingTop: 0,
+        paddingBottom: 0,
+        paddingLeft: 0,
+        paddingRight: 0
+      }) : selectStyles(viewportTokens);
+      acc[vp] = tokensToTransform;
+      return acc;
+    }, {});
+    const mediaQueryStyleSheet = createMediaQueryStyles(transformedThemeTokens);
     const {
       ids,
       styles
     } = StyleSheet.create({
-      card: mediaQueryStyleSheet
+      card: {
+        ...themeTokens[viewport],
+        ...mediaQueryStyleSheet
+      }
     });
     cardStyles = styles.card;
     mediaIds = ids.card;
@@ -321,7 +336,9 @@ Card.propTypes = {
     // src is an object when used responsively to provide different image sources for different screen sizes
     src: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.object]).isRequired,
     alt: PropTypes.string,
-    resizeMode: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['cover', 'contain', 'stretch', 'repeat', 'center']))
+    resizeMode: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['cover', 'contain', 'stretch', 'repeat', 'center'])),
+    position: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['bottom', 'left', 'right', 'top'])),
+    align: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['start', 'end', 'center', 'stretch']))
   }),
   /**
    * Data set for the card.