@telus-uds/components-base 0.0.2-prerelease.7 → 0.0.2-prerelease.8

package/lib/Tabs/TabsScrollButton.js

@@ -0,0 +1,121 @@
+"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 _ThemeProvider = require("../ThemeProvider");
+
+var _utils = require("../utils");
+
+var _Icon = _interopRequireDefault(require("../Icon"));
+
+var _Typography = _interopRequireDefault(require("../Typography"));
+
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const selectButtonStyles = ({
+  borderRadius,
+  backgroundColor,
+  borderColor,
+  borderWidth,
+  padding
+}, direction) => [staticStyles.absolute, staticStyles[direction], {
+  borderRadius,
+  backgroundColor,
+  borderColor,
+  borderWidth,
+  padding
+}];
+/**
+ * Button within a Tabs component showing users that content is available to the left or
+ * right, scrolling a screen's worth of content left or right when pressed.
+ *
+ * This is rendered automatically by `Tabs` and isn't intended be used directly.
+ *
+ * @TODO when IconButton is complete and stable revisit this and update interaction state styles.
+ */
+
+
+const TabsScrollButton = ({
+  direction = 'next',
+  icon,
+  onPress,
+  offset,
+  variant,
+  tokens,
+  copy
+}) => {
+  const getTokens = (0, _ThemeProvider.useThemeTokensCallback)('TabsScrollButton', tokens, variant);
+
+  const resolveButtonTokens = pressableState => (0, _utils.resolvePressableTokens)(getTokens, pressableState);
+
+  const getPressableStyle = pressableState => [selectButtonStyles(resolveButtonTokens(pressableState), direction), {
+    marginTop: -1 * (offset || 0)
+  }];
+
+  const getCopy = (0, _utils.useCopy)({
+    dictionary: _dictionary.default,
+    copy
+  });
+  const label = direction === 'previous' ? getCopy('previousText') : getCopy('nextText');
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Pressable.default, {
+    style: getPressableStyle,
+    onPress: onPress,
+    accessibilityLabel: label,
+    accessibilityRole: "button" // For keyboard-tab or screenreader-swipe navigation, users can just go through all items
+    ,
+    ..._utils.a11yProps.nonFocusableProps,
+    children: pressableState => {
+      const iconTokens = (0, _utils.selectTokens)('Icon', resolveButtonTokens(pressableState), 'icon');
+      return icon ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Icon.default, {
+        icon: icon,
+        tokens: iconTokens
+      }) : /*#__PURE__*/(0, _jsxRuntime.jsx)(_Typography.default, {
+        tokens: {
+          fontSize: iconTokens.size,
+          lineHeight: 1,
+          color: iconTokens.color
+        },
+        children: direction === 'next' ? '→' : '←'
+      });
+    }
+  });
+};
+
+const staticStyles = _StyleSheet.default.create({
+  absolute: {
+    position: 'absolute'
+  },
+  previous: {
+    left: 0
+  },
+  next: {
+    right: 0
+  }
+});
+
+TabsScrollButton.propTypes = {
+  tokens: (0, _utils.getTokensPropType)('TabsScrollButton'),
+  variant: _utils.variantProp.propType,
+  copy: _utils.copyPropTypes,
+  direction: _propTypes.default.oneOf(['previous', 'next']),
+  offset: _propTypes.default.number,
+  icon: _propTypes.default.elementType,
+  onPress: _propTypes.default.func.isRequired
+};
+var _default = TabsScrollButton;
+exports.default = _default;

package/lib/Tabs/dictionary.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  en: {
+    // English text from TDS Community `Tabs`
+    previousLabel: 'Move menu to the left',
+    nextLabel: 'Move menu to the right'
+  },
+  fr: {
+    previousLabel: 'Déplacer le menu vers la gauche',
+    nextLabel: 'Déplacer le menu vers la droite'
+  }
+};
+exports.default = _default;

package/lib/Tabs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Tabs = _interopRequireDefault(require("./Tabs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _Tabs.default;
+exports.default = _default;

package/lib/Tabs/itemPositions.js

@@ -0,0 +1,128 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.itemPositionsPropType = exports.useItemPositions = exports.getItemPositionLayoutHandler = exports.getItemPositionScrollTarget = void 0;
+
+var _react = require("react");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Utilities to assist scrolling a parent so that it snaps neatly to an appropriate child.
+
+/**
+ * @typedef ItemPositionPosition
+ * @property {number} [ItemPositionItem.start] - optional theme scale variants e.g. compact, wide
+ * @property {number} [ItemPositionItem.end] - optional override to force a particular pixel size
+ *
+ * @typedef {Object.<number, ItemPositionItem>} ItemPositionPositions - ref object of start/end coordinates
+ *
+ * @typedef ItemPositions
+ * @property {number} ItemPositions.contentWidth - current width of potentially-overflowing content inside scrollable
+ * @property {number} ItemPositions.containerWidth - current width of non-overflowing outer scroll container
+ * @property {number} ItemPositions.scrollOffset - current x position of the left edge of the visible section of the scrollable content
+ * @property {ItemPositionPositions} ItemPositions.positions - `{ start, end }` coordinates of each scrollable content item, by index
+ * @property {(targetX: number) => void)} ItemPositions.scrollTo - function to scroll to a co-ordinate, applying scrolling logic
+ * @property {() => void)} ItemPositions.setIsReady - function to call when layout has been calculated and itemPositions data is ready
+ */
+
+/**
+ * Takes a desired scroll target coordinate and returns a valid coordinate
+ * that, when not scrolling to one end or another, snaps to the start of an item,
+ * making sure any "scroll back" button doesn't overlap the first item.
+ *
+ * @param {number} x - the intended coordinate to scroll to
+ * @param {number} scrollMax - the highest posible coordinate to scroll to
+ * @param {ItemPositionPositions} positions - positions list from `useItemPositions` ref
+ * @param {number} [buttonClearance] - offset to allow space for a button
+ * @returns {number}
+ */
+const getItemPositionScrollTarget = (x, scrollMax, positions, buttonClearance = 0) => {
+  if (x <= 0) return 0;
+  if (x >= scrollMax) return scrollMax; // If not scrolling all the way to the start or end, stop
+  // where the first item is not coverred by the scroll previous button
+
+  const targetItem = Object.values(positions).find(({
+    start,
+    end
+  }) => start <= x && end > x); // If there's no target item we're landing at a gap between items
+
+  const targetX = targetItem ? targetItem.start : x;
+  return Math.max(0, targetX - buttonClearance);
+};
+/**
+ * Returns a handler for React Native's `onLayout` which updates the values of
+ * the ref object returned from `useItemPositions`.
+ *
+ * @param {ItemPositionPositions} positions
+ * @param {number} index
+ * @returns {function}
+ */
+
+
+exports.getItemPositionScrollTarget = getItemPositionScrollTarget;
+
+const getItemPositionLayoutHandler = (positions, index) => {
+  const handleLayout = ({
+    nativeEvent: {
+      layout: {
+        width,
+        x
+      }
+    }
+  }) => {
+    /* eslint-disable-next-line no-param-reassign */
+    positions[index] = {
+      start: x,
+      end: x + width
+    };
+  };
+
+  return handleLayout;
+};
+/**
+ * Wrapper for `useRef` which gives a mutable object in which item start/end coordinates,
+ * scrollTo method and content/container widths may be set and updated without causing a re-render.
+ *
+ * @returns {[ItemPositions, isReady: bool]} tuple array of:
+ *  - current ref object `{ positions, contentWidth, containerWidth, scrollOffset, scrollTo, setIsReady }`
+ *  - boolean that updates to `true` (causing a re-render) after the first time `setIsReady` is called
+ */
+
+
+exports.getItemPositionLayoutHandler = getItemPositionLayoutHandler;
+
+const useItemPositions = () => {
+  const [isReady, setIsReady] = (0, _react.useState)(false);
+  return [(0, _react.useRef)({
+    positions: {},
+    scrollTo: () => {},
+    contentWidth: 0,
+    containerWidth: 0,
+    scrollOffset: 0,
+    setIsReady
+  }).current, isReady];
+};
+/**
+ * PropType for the ref object returned by `useItemPositions`
+ */
+
+
+exports.useItemPositions = useItemPositions;
+
+const itemPositionsPropType = _propTypes.default.exact({
+  positions: _propTypes.default.objectOf(_propTypes.default.shape({
+    start: _propTypes.default.number,
+    end: _propTypes.default.number
+  })),
+  scrollTo: _propTypes.default.func,
+  contentWidth: _propTypes.default.number,
+  containerWidth: _propTypes.default.number,
+  scrollOffset: _propTypes.default.number,
+  setIsReady: _propTypes.default.func
+});
+
+exports.itemPositionsPropType = itemPositionsPropType;

package/lib/Tags/Tags.js

@@ -1,13 +1,39 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { Platform, Text, View } from 'react-native';
-import ButtonBase from '../Button/ButtonBase';
-import { StackWrap, getStackedContent } from '../StackView';
-import { useViewport } from '../ViewportProvider';
-import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider';
-import { a11yProps, pressProps, variantProp, getTokensPropType, selectTokens } from '../utils/propTypes';
-import { useMultipleInputValues } from '../utils/input';
-import { getPressHandlersWithArgs } from '../utils/pressability';
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+
+var _Text = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Text"));
+
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+
+var _ButtonBase = _interopRequireDefault(require("../Button/ButtonBase"));
+
+var _Icon = _interopRequireDefault(require("../Icon"));
+
+var _StackView = require("../StackView");
+
+var _ViewportProvider = require("../ViewportProvider");
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _propTypes2 = require("../utils/propTypes");
+
+var _input = require("../utils/input");
+
+var _pressability = require("../utils/pressability");
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const selectIconTextTokens = ({
   icon,
@@ -30,7 +56,7 @@ const selectIconTextTokens = ({
     borderRadius: iconBorderRadius,
     alignSelf: iconAlignSelf,
     padding: iconPadding,
-    ...Platform.select({
+    ..._Platform.default.select({
       // TODO: https://github.com/telus/universal-design-system/issues/487
       web: {
         transition: 'color 200ms, background 200ms'
@@ -55,149 +81,155 @@ const Tags = ({
   onChange,
   readOnly = false,
   inactive = false,
-  accessibilityRole = Platform.select({
+  accessibilityRole = _Platform.default.select({
     web: 'group',
     default: 'none'
   }),
   ...rest
 }) => {
-  const viewport = useViewport();
-  const themeTokens = useThemeTokens('Tags', tokens, variant, {
+  const viewport = (0, _ViewportProvider.useViewport)();
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Tags', tokens, variant, {
     viewport
   });
-  const stackTokens = selectTokens('StackView', themeTokens);
+  const stackTokens = (0, _propTypes2.selectTokens)('StackView', themeTokens);
   const {
     direction,
     space
   } = themeTokens;
-  const getItemTokens = useThemeTokensCallback('TagsItem', tokens, variant);
+  const getItemTokens = (0, _ThemeProvider.useThemeTokensCallback)('TagsItem', tokens, variant);
 
-  const getButtonTokens = buttonState => selectTokens('Button', getItemTokens(buttonState));
+  const getButtonTokens = buttonState => (0, _propTypes2.selectTokens)('Button', getItemTokens(buttonState));
 
   const {
     currentValues,
     toggleOneValue
-  } = useMultipleInputValues({
+  } = (0, _input.useMultipleInputValues)({
     initialValues,
     values,
     maxValues,
     onChange,
     readOnly
   });
-  const a11y = a11yProps.select({
+
+  const a11y = _propTypes2.a11yProps.select({
     accessibilityRole,
     ...rest
   });
+
   const itemA11yRole = 'checkbox';
-  return /*#__PURE__*/React.createElement(StackWrap, Object.assign({}, a11y, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_StackView.StackWrap, { ...a11y,
     space: space,
     direction: direction,
-    tokens: stackTokens
-  }), items.map(({
-    label,
-    id = label,
-    accessibilityLabel
-  }, index) => {
-    const isSelected = currentValues.includes(id); // Pass an object of relevant component state as first argument for any passed-in press handlers
-
-    const pressHandlers = getPressHandlersWithArgs(rest, [{
-      id,
+    tokens: stackTokens,
+    children: items.map(({
       label,
-      currentValues
-    }]);
-
-    const handlePress = () => {
-      if (pressHandlers.onPress) pressHandlers.onPress();
-      toggleOneValue(id);
-    };
-
-    const itemA11y = {
-      accessibilityState: {
-        checked: isSelected
-      },
-      accessibilityRole: itemA11yRole,
-      accessibilityLabel,
-      ...a11yProps.getPositionInSet(items.length, index)
-    };
-    return /*#__PURE__*/React.createElement(ButtonBase, Object.assign({
-      key: id
-    }, pressHandlers, {
-      onPress: handlePress,
-      tokens: getButtonTokens,
-      selected: isSelected,
-      inactive: inactive
-    }, itemA11y), ({
-      textStyles,
-      ...buttonState
-    }) => {
-      // TODO: once Icon/IconButton designs are stable, see if this sort of styling around
-      // an icon should go in Icon itself, or possibly via an IconText token set. Related issues:
-      // - Icon: https://github.com/telus/universal-design-system/issues/327
-      // - IconButton: https://github.com/telus/universal-design-system/issues/281
-      // - Token sets: https://github.com/telus/universal-design-system/issues/782
-      const itemTokens = getItemTokens(buttonState);
-      const {
-        iconTokens,
-        iconPosition,
-        iconSpace,
-        iconWrapperStyle,
-        icon: IconComponent
-      } = selectIconTextTokens(itemTokens);
-      const iconContent = IconComponent ? /*#__PURE__*/React.createElement(View, {
-        style: iconWrapperStyle
-      }, /*#__PURE__*/React.createElement(IconComponent, {
-        tokens: iconTokens
-      })) : null;
-      const textContent = /*#__PURE__*/React.createElement(Text, {
-        style: textStyles
-      }, label);
-      return getStackedContent(iconPosition === 'left' ? [iconContent, textContent] : [textContent, iconContent], {
-        space: iconSpace,
-        direction: 'row'
-      });
-    });
-  }));
+      id = label,
+      accessibilityLabel
+    }, index) => {
+      const isSelected = currentValues.includes(id); // Pass an object of relevant component state as first argument for any passed-in press handlers
+
+      const pressHandlers = (0, _pressability.getPressHandlersWithArgs)(rest, [{
+        id,
+        label,
+        currentValues
+      }]);
+
+      const handlePress = () => {
+        if (pressHandlers.onPress) pressHandlers.onPress();
+        toggleOneValue(id);
+      };
+
+      const itemA11y = {
+        accessibilityState: {
+          checked: isSelected
+        },
+        accessibilityRole: itemA11yRole,
+        accessibilityLabel,
+        ..._propTypes2.a11yProps.getPositionInSet(items.length, index)
+      };
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_ButtonBase.default, { ...pressHandlers,
+        onPress: handlePress,
+        tokens: getButtonTokens,
+        selected: isSelected,
+        inactive: inactive,
+        ...itemA11y,
+        children: ({
+          textStyles,
+          ...buttonState
+        }) => {
+          // TODO: once Icon/IconButton designs are stable, see if this sort of styling around
+          // an icon should go in Icon itself, or possibly via an IconText token set. Related issues:
+          // - Icon: https://github.com/telus/universal-design-system/issues/327
+          // - IconButton: https://github.com/telus/universal-design-system/issues/281
+          // - Token sets: https://github.com/telus/universal-design-system/issues/782
+          const itemTokens = getItemTokens(buttonState);
+          const {
+            iconTokens,
+            iconPosition,
+            iconSpace,
+            iconWrapperStyle,
+            icon: IconComponent
+          } = selectIconTextTokens(itemTokens);
+          const iconContent = IconComponent ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+            style: iconWrapperStyle,
+            children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Icon.default, {
+              icon: IconComponent,
+              tokens: iconTokens
+            })
+          }) : null;
+          const textContent = /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+            style: textStyles,
+            children: label
+          });
+          return (0, _StackView.getStackedContent)(iconPosition === 'left' ? [iconContent, textContent] : [textContent, iconContent], {
+            space: iconSpace,
+            direction: 'row'
+          });
+        }
+      }, id);
+    })
+  });
 };
 
-Tags.propTypes = { ...a11yProps.propTypes,
-  ...pressProps.propTypes,
-  tokens: getTokensPropType('Tags'),
-  variant: variantProp.propType,
+Tags.propTypes = { ..._propTypes2.a11yProps.propTypes,
+  ..._propTypes2.pressProps.propTypes,
+  tokens: (0, _propTypes2.getTokensPropType)('Tags'),
+  variant: _propTypes2.variantProp.propType,
 
   /**
    * If provided, sets a maximum number of items a user may select at once.
    */
-  maxValues: PropTypes.number,
+  maxValues: _propTypes.default.number,
 
   /**
    * The options a user may select
    */
-  items: PropTypes.arrayOf(PropTypes.shape({
+  items: _propTypes.default.arrayOf(_propTypes.default.shape({
     /**
      * The text displayed to the user in the button, describing this option,
      * passed to the button as its child.
      */
-    label: PropTypes.string.isRequired,
+    label: _propTypes.default.string.isRequired,
 
     /**
      * An optional accessibility label may be passed to ButtonGroup Buttons
      * which is applied as normal for a React Native accessibilityLabel prop.
      */
-    accessibilityLabel: PropTypes.string,
+    accessibilityLabel: _propTypes.default.string,
 
     /**
      * An optional unique string may be provided to identify this option,
      * which will be used in code and passed to any onChange function.
      * If not provided, the label is used.
      */
-    id: PropTypes.string
+    id: _propTypes.default.string
   })),
 
   /**
    * If provided, this function is called when the current selection is changed
    * and is passed an array of the `id`s of all currently selected `items`.
    */
-  onChange: PropTypes.func,
+  onChange: _propTypes.default.func,
 
   /**
    * If the selected item(s) in the button group are to be controlled externally by
@@ -205,13 +237,14 @@ Tags.propTypes = { ...a11yProps.propTypes,
    * Passing an array for "values" makes the ButtonGroup a "controlled" component that
    * expects its state to be handled via `onChange` and so doesn't handle it itself.
    */
-  values: PropTypes.arrayOf(PropTypes.string),
+  values: _propTypes.default.arrayOf(_propTypes.default.string),
 
   /**
    * If `values` is not passed, making the ButtonGroup an "uncontrolled" component
    * managing its own selected state, a default set of selections may be provided.
    * Changing the `initialValues` does not change the user's selections.
    */
-  initialValues: PropTypes.arrayOf(PropTypes.string)
+  initialValues: _propTypes.default.arrayOf(_propTypes.default.string)
 };
-export default Tags;
+var _default = Tags;
+exports.default = _default;

package/lib/Tags/index.js

@@ -1,2 +1,13 @@
-import Tags from './Tags';
-export default Tags;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Tags = _interopRequireDefault(require("./Tags"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _Tags.default;
+exports.default = _default;