@telus-uds/components-base 1.16.0 → 1.17.0

package/lib-module/Button/ButtonBase.js

@@ -171,11 +171,12 @@ const selectWebOnlyStyles = (inactive, themeTokens, _ref7) => {
 const selectItemIconTokens = _ref8 => {
   let {
     color,
+    iconColor,
     iconSize
   } = _ref8;
   return {
     size: iconSize,
-    color
+    color: iconColor || color
   };
 };
 

package/lib-module/List/List.js

@@ -2,15 +2,23 @@ import React, { cloneElement, forwardRef, Children } from 'react';
 import View from "react-native-web/dist/exports/View";
 import Platform from "react-native-web/dist/exports/Platform";
 import PropTypes from 'prop-types';
-import { a11yProps, componentPropType, getTokensPropType, selectSystemProps, variantProp, viewProps } from '../utils';
-import ListItem from './ListItem';
+import { a11yProps, getTokensPropType, selectSystemProps, variantProp, viewProps } from '../utils';
 import { jsx as _jsx } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+
+const isListItem = element => {
+  var _element$type, _element$type2;
+
+  const elementName = (element === null || element === void 0 ? void 0 : (_element$type = element.type) === null || _element$type === void 0 ? void 0 : _element$type.displayName) || (element === null || element === void 0 ? void 0 : (_element$type2 = element.type) === null || _element$type2 === void 0 ? void 0 : _element$type2.name); // Match our own ListItem, and also, custom list items
+
+  return Boolean(elementName.match(/Item/));
+};
 /**
  * An unordered List component has a child a ListItem that
  * allows icon, dividers and customized typography
  */
 
+
 const List = /*#__PURE__*/forwardRef((_ref, ref) => {
   let {
     children,
@@ -24,12 +32,8 @@ const List = /*#__PURE__*/forwardRef((_ref, ref) => {
     ...rest
   } = _ref;
   const items = Children.map(children, (child, index) => {
-    var _child$type, _child$type2;
-
     // Pass ListItem-specific props to children (by name so teams can add their own ListItems)
-    const isListItem = componentName => Boolean(componentName === ListItem.displayName);
-
-    if (isListItem(child === null || child === void 0 ? void 0 : (_child$type = child.type) === null || _child$type === void 0 ? void 0 : _child$type.displayName) || isListItem(child === null || child === void 0 ? void 0 : (_child$type2 = child.type) === null || _child$type2 === void 0 ? void 0 : _child$type2.name)) {
+    if (isListItem(child)) {
       return /*#__PURE__*/cloneElement(child, {
         showDivider,
         isLastItem: index + 1 === Children.count(children),
@@ -52,7 +56,7 @@ List.displayName = 'List';
 List.propTypes = { ...selectedSystemPropTypes,
   tokens: getTokensPropType('List'),
   variant: variantProp.propType,
-  children: componentPropType('ListItem'),
+  children: PropTypes.node,
 
   /**
    * In case it is not the last item allow display divider

package/lib-module/List/PressableListItemBase.js

@@ -4,10 +4,10 @@ import ABBPropTypes from 'airbnb-prop-types';
 import Pressable from "react-native-web/dist/exports/Pressable";
 import StyleSheet from "react-native-web/dist/exports/StyleSheet";
 import Platform from "react-native-web/dist/exports/Platform";
-import { resolvePressableTokens, clickProps, linkProps, hrefAttrsProp, withLinkRouter } from '../utils';
+import { resolvePressableTokens, clickProps, linkProps, hrefAttrsProp, selectTokens, withLinkRouter } from '../utils';
 import ListItemBase from './ListItemBase';
-import ListItemContent, { tokenTypes as contentTokenTypes } from './ListItemContent';
-import ListItemMark, { tokenTypes as markTokenTypes } from './ListItemMark';
+import ListItemContent from './ListItemContent';
+import ListItemMark from './ListItemMark';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Fragment as _Fragment } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
@@ -57,9 +57,10 @@ const PressableListItemBase = /*#__PURE__*/forwardRef((_ref2, ref) => {
     href,
     onPress
   });
+  const listItemTokens = selectTokens('List', typeof tokens === 'function' ? tokens() : tokens);
   return /*#__PURE__*/_jsx(ListItemBase, {
     ref: listItemRef,
-    tokens: tokens(),
+    tokens: listItemTokens,
     ...listItemProps,
     children: _ref3 => {
       let {
@@ -99,16 +100,11 @@ const staticStyles = StyleSheet.create({
   itemContainer: {
     flexDirection: 'row',
     flex: 1
-  },
-  tokens: { ...contentTokenTypes,
-    ...markTokenTypes
   }
 });
-PressableListItemBase.propTypes = {
+PressableListItemBase.propTypes = { ...withLinkRouter.propTypes,
   href: PropTypes.string,
   onPress: PropTypes.func,
-  // TODO - type this better, maybe import the subcomponent token types and run it through util
-  // eslint-disable-next-line react/forbid-prop-types
   tokens: PropTypes.any,
   icon: PropTypes.elementType,
   children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),

package/lib-module/QuickLinks/QuickLinks.js

@@ -0,0 +1,71 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import { useThemeTokens } from '../ThemeProvider';
+import { useViewport } from '../ViewportProvider';
+import { getTokensPropType, variantProp } from '../utils';
+import List from '../List';
+import StackWrap from '../StackView/StackWrap';
+import QuickLinksCard from './QuickLinksCard';
+/**
+ * QuickLinks renders a list of interactive items. How it renders these items depends on theme options:
+ *  - If the theme returns `list` token as true, it renders an ordered list based on List
+ *  - If the theme returns `button` token as true and `list` as false, it renders a wrapping horizontal bar of buttons
+ *  - If the theme returns `card` token as true, it wraps the above with a `Card`.
+ */
+
+import { jsx as _jsx } from "react/jsx-runtime";
+const QuickLinks = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    tokens,
+    variant,
+    listTokens,
+    cardTokens,
+    children,
+    tag = 'ul',
+    ...rest
+  } = _ref;
+  const viewport = useViewport();
+  const {
+    dividers,
+    list,
+    card,
+    stackSpace,
+    stackGap,
+    stackJustify
+  } = useThemeTokens('QuickLinks', tokens, variant, {
+    viewport
+  });
+
+  const content = list && /*#__PURE__*/_jsx(List, {
+    ref: ref,
+    tokens: listTokens,
+    showDivider: dividers,
+    tag: tag,
+    ...rest,
+    children: children
+  }) || /*#__PURE__*/_jsx(StackWrap, {
+    space: stackSpace,
+    gap: stackGap,
+    tokens: {
+      justifyContent: stackJustify
+    },
+    tag: tag,
+    ...rest,
+    children: children
+  });
+
+  return card ? /*#__PURE__*/_jsx(QuickLinksCard, {
+    tokens: cardTokens,
+    children: content
+  }) : content;
+});
+QuickLinks.displayName = 'QuickLinks';
+QuickLinks.propTypes = {
+  tokens: getTokensPropType('QuickLinks'),
+  cardTokens: getTokensPropType('Card'),
+  listTokens: getTokensPropType('QuickLinksList'),
+  tag: PropTypes.string,
+  variant: variantProp.propType,
+  children: PropTypes.node
+};
+export default QuickLinks;

package/lib-module/QuickLinks/QuickLinksCard.js

@@ -0,0 +1,33 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { useThemeTokens } from '../ThemeProvider';
+import { getTokensPropType, variantProp } from '../utils';
+import CardBase from '../Card/CardBase';
+/**
+ * Private subcomponent for use within QuickLinks.
+ *
+ * Restyled Card with identical behaviour to Card, but themed according to the
+ * QuickLinksCard theme rather than the Card theme.
+ */
+
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const QuickLinksList = _ref => {
+  let {
+    tokens,
+    variant,
+    children
+  } = _ref;
+  const themeTokens = useThemeTokens('QuickLinksCard', tokens, variant);
+  return /*#__PURE__*/_jsx(CardBase, {
+    tokens: themeTokens,
+    children: children
+  });
+};
+
+QuickLinksList.propTypes = {
+  tokens: getTokensPropType('QuickLinksCard'),
+  variant: variantProp.propType,
+  children: PropTypes.node
+};
+export default QuickLinksList;

package/lib-module/QuickLinks/QuickLinksItem.js

@@ -0,0 +1,50 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import { getTokensPropType, variantProp, withLinkRouter } from '../utils';
+import { useViewport } from '../ViewportProvider';
+import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider';
+import PressableListItemBase from '../List/PressableListItemBase';
+import ButtonBase from '../Button/ButtonBase';
+/**
+ * Public component exported as QuickLinks.Item, for use as children of QuickLinks.
+ *
+ * Receives props injected by QuickLinks and renders the appropriate child component.
+ */
+
+import { jsx as _jsx } from "react/jsx-runtime";
+const QuickLinksItem = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    tokens,
+    variant,
+    children,
+    ...rest
+  } = _ref;
+  const viewport = useViewport();
+  const {
+    list
+  } = useThemeTokens('QuickLinks', tokens, variant, {
+    viewport
+  });
+  const themeName = list ? 'QuickLinksList' : 'QuickLinksButton';
+  const getTokens = useThemeTokensCallback(themeName, tokens, variant);
+  return list ? /*#__PURE__*/_jsx(PressableListItemBase, {
+    ref: ref,
+    tokens: getTokens,
+    ...rest,
+    children: children
+  }) : /*#__PURE__*/_jsx(ButtonBase, {
+    ref: ref,
+    tokens: getTokens,
+    ...rest,
+    children: children
+  });
+});
+QuickLinksItem.displayName = 'QuickLinksItem';
+QuickLinksItem.propTypes = { ...withLinkRouter.propTypes,
+  ...PressableListItemBase.propTypes,
+  ...ButtonBase.propTypes,
+  tokens: getTokensPropType('QuickLinksList', 'QuickLinksButton'),
+  variant: variantProp.propType,
+  children: PropTypes.node
+};
+export default withLinkRouter(QuickLinksItem);

package/lib-module/QuickLinks/index.js

@@ -0,0 +1,4 @@
+import QuickLinks from './QuickLinks';
+import QuickLinksItem from './QuickLinksItem';
+QuickLinks.Item = QuickLinksItem;
+export default QuickLinks;

package/lib-module/Timeline/Timeline.js

@@ -0,0 +1,174 @@
+import PropTypes from 'prop-types';
+import React, { forwardRef } from 'react';
+import View from "react-native-web/dist/exports/View";
+import { useThemeTokens } from '../ThemeProvider';
+import { getTokensPropType, variantProp, a11yProps, viewProps, selectSystemProps, getA11yPropsFromHtmlTag, layoutTags } from '../utils';
+import { useViewport } from '../ViewportProvider';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+
+const selectDotStyles = _ref => {
+  let {
+    dotWidth,
+    timelineColor,
+    dotBorderWidth,
+    dotColor
+  } = _ref;
+  return {
+    width: dotWidth,
+    height: dotWidth,
+    borderRadius: dotWidth / 2,
+    backgroundColor: dotColor,
+    borderWidth: dotBorderWidth,
+    borderColor: timelineColor
+  };
+};
+
+const selectConnectorStyles = _ref2 => {
+  let {
+    timelineColor,
+    connectorHeight,
+    connectorWidth
+  } = _ref2;
+  return {
+    width: connectorWidth,
+    height: connectorHeight,
+    backgroundColor: timelineColor
+  };
+};
+
+const selectTimelineContainerStyle = _ref3 => {
+  let {
+    timelineContainerDirection
+  } = _ref3;
+  return {
+    flexDirection: timelineContainerDirection
+  };
+};
+
+const selectLineItemStyles = _ref4 => {
+  let {
+    lineItemAlign,
+    lineItemDirection,
+    lineItemMarginBottom,
+    lineItemMarginRight
+  } = _ref4;
+  return {
+    alignItems: lineItemAlign,
+    flexDirection: lineItemDirection,
+    marginBottom: lineItemMarginBottom,
+    marginRight: lineItemMarginRight,
+    overflow: 'hidden'
+  };
+};
+
+const selectLineItemContainer = _ref5 => {
+  let {
+    lineItemContainerDirection,
+    lineContainerFlexSize
+  } = _ref5;
+  return {
+    flexDirection: lineItemContainerDirection,
+    flex: lineContainerFlexSize
+  };
+};
+
+const selectItemContentStyles = (_ref6, isLastChild) => {
+  let {
+    itemContentFlexSize,
+    itemContentMarginBottom,
+    itemContentMarginRight
+  } = _ref6;
+  return {
+    flex: itemContentFlexSize,
+    marginBottom: !isLastChild && itemContentMarginBottom,
+    marginRight: !isLastChild && itemContentMarginRight
+  };
+};
+
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+/**
+ * Timeline is a component that displays either a horizontal or vertical list of the
+ * children components passed by props
+ *
+ * ## Component API
+ *
+ * - `horizontal` In order to display the Component list horizontally
+ *
+ *
+ * ## A11y guidelines
+ * Timeline link supports all the common a11y props.
+ */
+
+const Timeline = /*#__PURE__*/forwardRef((_ref7, ref) => {
+  let {
+    tokens,
+    variant = {},
+    children,
+    accessibilityLabel,
+    tag = 'ul',
+    childrenTag = 'li',
+    ...rest
+  } = _ref7;
+  const viewport = useViewport();
+  const themeTokens = useThemeTokens('Timeline', tokens, variant, {
+    viewport
+  });
+  const containerProps = { ...selectProps(rest),
+    ...getA11yPropsFromHtmlTag(tag, rest.accessibilityRole || 'list'),
+    accessibilityLabel
+  };
+  return /*#__PURE__*/_jsx(View, { ...containerProps,
+    ref: ref,
+    style: selectTimelineContainerStyle(themeTokens),
+    children: children.map((child, index) => {
+      var _child$props;
+
+      const childrenProps = { ...getA11yPropsFromHtmlTag(childrenTag, (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || 'listitem')
+      };
+      return /*#__PURE__*/_jsxs(View, {
+        style: selectLineItemContainer(themeTokens) // eslint-disable-next-line react/no-array-index-key
+        ,
+        ...childrenProps,
+        children: [/*#__PURE__*/_jsxs(View, {
+          style: selectLineItemStyles(themeTokens),
+          children: [/*#__PURE__*/_jsx(View, {
+            style: selectDotStyles(themeTokens)
+          }), /*#__PURE__*/_jsx(View, {
+            style: selectConnectorStyles(themeTokens)
+          })]
+        }), /*#__PURE__*/_jsx(View, {
+          style: selectItemContentStyles(themeTokens, index + 1 === children.length),
+          children: child
+        })]
+      }, "timeline-".concat(index, "-").concat(child.displayName));
+    })
+  });
+});
+Timeline.displayName = 'Timeline';
+Timeline.propTypes = { ...selectedSystemPropTypes,
+  tokens: getTokensPropType('Timeline'),
+  variant: variantProp.propType,
+
+  /**
+   * A list of components that will be rendered either horizontally or vertically
+   */
+  children: PropTypes.arrayOf(PropTypes.node).isRequired,
+
+  /**
+   * A required accessibility label that needs to be passed to be used on List
+   * which is applied as normal for a React Native accessibilityLabel prop.
+   */
+  accessibilityLabel: PropTypes.string.isRequired,
+
+  /**
+   * Sets the HTML tag of the outer container and the children. By default `'li'` for the children
+   * and `'ul'` for the container
+   *
+   * If either `tag` or `childrenTag` is overridden, the other should be too, to avoid producing invalid HTML.
+   *
+   */
+  tag: PropTypes.oneOf(layoutTags),
+  childrenTag: PropTypes.oneOf(layoutTags)
+};
+export default Timeline;

package/lib-module/Timeline/index.js

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

package/lib-module/index.js

@@ -24,6 +24,7 @@ export { default as Modal } from './Modal';
 export { default as Notification } from './Notification';
 export { default as Pagination } from './Pagination';
 export { default as Progress } from './Progress';
+export { default as QuickLinks } from './QuickLinks';
 export { default as Radio } from './Radio';
 export * from './Radio';
 export { default as RadioCard } from './RadioCard';
@@ -40,6 +41,7 @@ export { default as StepTracker } from './StepTracker';
 export { default as Tabs } from './Tabs';
 export { default as Tags } from './Tags';
 export * from './TextInput';
+export { default as Timeline } from './Timeline';
 export * from './ToggleSwitch';
 export { default as Tooltip } from './Tooltip';
 export { default as TooltipButton } from './TooltipButton';
@@ -48,4 +50,5 @@ export { default as A11yInfoProvider, useA11yInfo } from './A11yInfoProvider';
 export { default as BaseProvider } from './BaseProvider';
 export { default as ViewportProvider, useViewport, ViewportContext } from './ViewportProvider';
 export { default as ThemeProvider, useTheme, useSetTheme, useThemeTokens, getThemeTokens, applyOuterBorder, applyTextStyles, applyShadowToken } from './ThemeProvider';
-export * from './utils';
+export * from './utils';
+export { Portal } from '@gorhom/portal';

package/package.json

@@ -7,9 +7,10 @@
     "url": "https://github.com/telus/universal-design-system/issues"
   },
   "dependencies": {
-    "airbnb-prop-types": "^2.16.0",
+    "@gorhom/portal": "^1.0.14",
     "@telus-uds/system-constants": "^1.0.4",
-    "@telus-uds/system-theme-tokens": "^2.5.0",
+    "@telus-uds/system-theme-tokens": "^2.6.0",
+    "airbnb-prop-types": "^2.16.0",
     "lodash.debounce": "^4.0.8",
     "lodash.merge": "^4.6.2",
     "prop-types": "^15.7.2",
@@ -21,10 +22,10 @@
     "@telus-uds/browserslist-config": "^1.0.4",
     "@testing-library/jest-native": "^4.0.1",
     "@testing-library/react": "^13.3.0",
-    "@testing-library/react-native": "11.0.0",
-    "react-test-renderer": "~18.0.0",
     "@testing-library/react-hooks": "~7.0.1",
+    "@testing-library/react-native": "11.0.0",
     "@testing-library/react-native-17": "npm:@testing-library/react-native@7.2.0",
+    "react-test-renderer": "~18.0.0",
     "react-test-renderer-17": "npm:react-test-renderer@17.0.2",
     "webpack": "5.x"
   },
@@ -66,5 +67,5 @@
   "standard-engine": {
     "skip": true
   },
-  "version": "1.16.0"
+  "version": "1.17.0"
 }

package/src/BaseProvider/index.jsx

@@ -1,5 +1,6 @@
 import React from 'react'
 import PropTypes from 'prop-types'
+import { PortalProvider } from '@gorhom/portal'
 import A11yInfoProvider from '../A11yInfoProvider'
 import ViewportProvider from '../ViewportProvider'
 import ThemeProvider from '../ThemeProvider'
@@ -8,7 +9,7 @@ const BaseProvider = ({ defaultTheme, children, themeOptions }) => (
   <A11yInfoProvider>
     <ViewportProvider>
       <ThemeProvider defaultTheme={defaultTheme} themeOptions={themeOptions}>
-        {children}
+        <PortalProvider>{children}</PortalProvider>
       </ThemeProvider>
     </ViewportProvider>
   </A11yInfoProvider>

package/src/Button/ButtonBase.jsx

@@ -148,9 +148,9 @@ const selectWebOnlyStyles = (inactive, themeTokens, { accessibilityRole }) => {
   })
 }
 
-const selectItemIconTokens = ({ color, iconSize }) => ({
+const selectItemIconTokens = ({ color, iconColor, iconSize }) => ({
   size: iconSize,
-  color
+  color: iconColor || color
 })
 
 const ButtonBase = forwardRef(

package/src/List/List.jsx

@@ -1,18 +1,16 @@
 import React, { cloneElement, forwardRef, Children } from 'react'
 import { View, Platform } from 'react-native'
 import PropTypes from 'prop-types'
-import {
-  a11yProps,
-  componentPropType,
-  getTokensPropType,
-  selectSystemProps,
-  variantProp,
-  viewProps
-} from '../utils'
-import ListItem from './ListItem'
+import { a11yProps, getTokensPropType, selectSystemProps, variantProp, viewProps } from '../utils'
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
 
+const isListItem = (element) => {
+  const elementName = element?.type?.displayName || element?.type?.name
+  // Match our own ListItem, and also, custom list items
+  return Boolean(elementName.match(/Item/))
+}
+
 /**
  * An unordered List component has a child a ListItem that
  * allows icon, dividers and customized typography
@@ -31,9 +29,7 @@ const List = forwardRef(
   ) => {
     const items = Children.map(children, (child, index) => {
       // Pass ListItem-specific props to children (by name so teams can add their own ListItems)
-      const isListItem = (componentName) => Boolean(componentName === ListItem.displayName)
-
-      if (isListItem(child?.type?.displayName) || isListItem(child?.type?.name)) {
+      if (isListItem(child)) {
         return cloneElement(child, {
           showDivider,
           isLastItem: index + 1 === Children.count(children),
@@ -58,7 +54,7 @@ List.propTypes = {
   ...selectedSystemPropTypes,
   tokens: getTokensPropType('List'),
   variant: variantProp.propType,
-  children: componentPropType('ListItem'),
+  children: PropTypes.node,
   /**
    * In case it is not the last item allow display divider
    */

package/src/List/PressableListItemBase.jsx

@@ -9,12 +9,13 @@ import {
   clickProps,
   linkProps,
   hrefAttrsProp,
+  selectTokens,
   withLinkRouter
 } from '../utils'
 
 import ListItemBase from './ListItemBase'
-import ListItemContent, { tokenTypes as contentTokenTypes } from './ListItemContent'
-import ListItemMark, { tokenTypes as markTokenTypes } from './ListItemMark'
+import ListItemContent from './ListItemContent'
+import ListItemMark from './ListItemMark'
 
 const selectPressableStyles = ({
   backgroundColor,
@@ -39,8 +40,10 @@ const PressableListItemBase = forwardRef(
     const { hrefAttrs, rest: listItemProps } = hrefAttrsProp.bundle(props)
     const handlePress = linkProps.handleHref({ href, onPress })
 
+    const listItemTokens = selectTokens('List', typeof tokens === 'function' ? tokens() : tokens)
+
     return (
-      <ListItemBase ref={listItemRef} tokens={tokens()} {...listItemProps}>
+      <ListItemBase ref={listItemRef} tokens={listItemTokens} {...listItemProps}>
         {({ isLastItem }) => {
           const getTokens = (pressableState) =>
             resolvePressableTokens(tokens, pressableState, { last: isLastItem })
@@ -81,18 +84,13 @@ const staticStyles = StyleSheet.create({
   itemContainer: {
     flexDirection: 'row',
     flex: 1
-  },
-  tokens: {
-    ...contentTokenTypes,
-    ...markTokenTypes
   }
 })
 
 PressableListItemBase.propTypes = {
+  ...withLinkRouter.propTypes,
   href: PropTypes.string,
   onPress: PropTypes.func,
-  // TODO - type this better, maybe import the subcomponent token types and run it through util
-  // eslint-disable-next-line react/forbid-prop-types
   tokens: PropTypes.any,
   icon: PropTypes.elementType,
   children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),