@telus-uds/components-base 0.0.2-prerelease.4 → 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

@@ -0,0 +1,250 @@
+"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,
+  iconPosition,
+  iconSpace,
+  iconSize,
+  iconColor,
+  iconBackground,
+  iconBorderRadius,
+  iconAlignSelf,
+  iconPadding,
+  iconTranslateX,
+  iconTranslateY
+}) => ({
+  icon,
+  iconPosition,
+  iconSpace,
+  iconWrapperStyle: {
+    backgroundColor: iconBackground,
+    borderRadius: iconBorderRadius,
+    alignSelf: iconAlignSelf,
+    padding: iconPadding,
+    ..._Platform.default.select({
+      // TODO: https://github.com/telus/universal-design-system/issues/487
+      web: {
+        transition: 'color 200ms, background 200ms'
+      }
+    })
+  },
+  iconTokens: {
+    size: iconSize,
+    color: iconColor,
+    translateX: iconTranslateX,
+    translateY: iconTranslateY
+  }
+});
+
+const Tags = ({
+  variant,
+  tokens,
+  items = [],
+  values,
+  initialValues,
+  maxValues,
+  onChange,
+  readOnly = false,
+  inactive = false,
+  accessibilityRole = _Platform.default.select({
+    web: 'group',
+    default: 'none'
+  }),
+  ...rest
+}) => {
+  const viewport = (0, _ViewportProvider.useViewport)();
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Tags', tokens, variant, {
+    viewport
+  });
+  const stackTokens = (0, _propTypes2.selectTokens)('StackView', themeTokens);
+  const {
+    direction,
+    space
+  } = themeTokens;
+  const getItemTokens = (0, _ThemeProvider.useThemeTokensCallback)('TagsItem', tokens, variant);
+
+  const getButtonTokens = buttonState => (0, _propTypes2.selectTokens)('Button', getItemTokens(buttonState));
+
+  const {
+    currentValues,
+    toggleOneValue
+  } = (0, _input.useMultipleInputValues)({
+    initialValues,
+    values,
+    maxValues,
+    onChange,
+    readOnly
+  });
+
+  const a11y = _propTypes2.a11yProps.select({
+    accessibilityRole,
+    ...rest
+  });
+
+  const itemA11yRole = 'checkbox';
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_StackView.StackWrap, { ...a11y,
+    space: space,
+    direction: direction,
+    tokens: stackTokens,
+    children: 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 = (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 = { ..._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.default.number,
+
+  /**
+   * The options a user may select
+   */
+  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.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.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.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.default.func,
+
+  /**
+   * If the selected item(s) in the button group are to be controlled externally by
+   * a parent component, pass an array of strings as well as an `onChange` handler.
+   * 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.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.default.arrayOf(_propTypes.default.string)
+};
+var _default = Tags;
+exports.default = _default;

package/lib/Tags/index.js

@@ -0,0 +1,13 @@
+"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;

package/lib/TextInput/TextArea.js

@@ -0,0 +1,109 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+
+var _utils = require("../utils");
+
+var _InputSupports = _interopRequireDefault(require("../InputSupports"));
+
+var _TextInputBase = _interopRequireDefault(require("./TextInputBase"));
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _propTypes = _interopRequireDefault(require("../InputSupports/propTypes"));
+
+var _propTypes2 = _interopRequireDefault(require("./propTypes"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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; }
+
+/**
+ * Use to collect long-form information such as product feedback or support queries.
+ * Due to React Native's implementation of `TextInput` it's not possible to access the current value by passing a ref.
+ * The `TextArea` height will automatically increase when new lines are added - this behavior can be limited within the theme.
+ *
+ * ## Controlled component
+ * If it is required that the state of the `TextArea` be controlled by the application or other external methods,
+ * `value` and `onChange` props must be passed to the `TextArea`.
+ * If the `TextArea` value should not be changed by user input, a `readOnly` prop must be provided.
+ *
+ * ## Uncontrolled component
+ * If it is not necessary to control the `TextArea` state, you can create one without a value prop.
+ * In this case its value can be accessed within the `onChange` callback.
+ *
+ * ## Getting feedback for entered values
+ * Use the `feedback` prop to give the user feedback regarding their input.
+ * You can affirm that the user's input was correct, or highlight errors that must be corrected, using the `validation` prop.
+ * Keep feedback text as brief as possible, should be limited to text and links.
+ *
+ * ## Supplying a hint
+ * Use the `hint` prop to succinctly clarify attributes of the expected input data, such as the expected format,
+ * or an indicator that the field is optional.
+ * It is a more usable and accessible option than the HTML `placeholder` attribute.
+ */
+function TextArea({
+  tokens,
+  variant = {},
+  ...remainingProps
+}) {
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('TextArea', tokens, variant);
+  const [inputHeight, setInputHeight] = (0, _react.useState)(); // adjust the text area's height as new lines are added to the content
+
+  const onHeightChange = ({
+    nativeEvent: {
+      contentSize: {
+        height
+      }
+    }
+  }) => {
+    // on native this is happens out of the box
+    if (_Platform.default.OS === 'web') {
+      setInputHeight(height);
+    }
+  };
+
+  const {
+    props: supportsProps,
+    rest
+  } = _propTypes.default.select(remainingProps);
+
+  const inputProps = { ...rest,
+    variant: { ...variant,
+      validation: supportsProps.validation
+    },
+    multiline: true,
+    onContentSizeChange: onHeightChange,
+    height: inputHeight,
+    tokens: themeTokens
+  };
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_InputSupports.default, { ...supportsProps,
+    children: ({
+      a11yProps,
+      inputId
+    }) => /*#__PURE__*/(0, _jsxRuntime.jsx)(_TextInputBase.default, { ...inputProps,
+      ...a11yProps,
+      nativeID: inputId
+    })
+  });
+}
+
+TextArea.propTypes = { ..._propTypes.default.types,
+  ..._propTypes2.default,
+  tokens: (0, _utils.getTokensPropType)('TextArea', 'TextInput'),
+  // TODO: support both TextArea and TextInput tokens
+  variant: _utils.variantProp.propType
+};
+var _default = TextArea;
+exports.default = _default;