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

package/lib/RadioCard/RadioCardGroup.js

@@ -0,0 +1,251 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _ViewportProvider = require("../ViewportProvider");
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _utils = require("../utils");
+
+var _StackView = _interopRequireWildcard(require("../StackView"));
+
+var _RadioCard = _interopRequireDefault(require("./RadioCard"));
+
+var _Fieldset = _interopRequireDefault(require("../Fieldset"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+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; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * A group of Cards that behave as a radio button group. Use when users select a single choice from mutually
+ * exclusive options with need to show additional information for each option. The whole cards are each
+ * interactive as one item.
+ *
+ * ## Component API
+ *
+ * Use the `items` prop to pass an array of objects describing each RadioCard in the group:
+ *
+ *  - `title`: main text passed to RadioCard's `title` prop
+ *  - `content`: React content passed to RadioCard's `children` prop
+ *  - `id`: identifier used to store which RadioCard is selected (uses `title` if undefinded)
+ *  - `onChange`: optional function called on selection, in addition to updating the group's selection state
+ *
+ * ### Controlled version
+ *
+ * If the selection state is controlled from outside, it needs to receive `checkedId` and `onChange` props.
+ *
+ * ### Uncontrolled version
+ *
+ * If the RadioCardGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.
+ * Whenever the radio card gets toggled, it calls the `onChange` callback with the new value (string).
+ *
+ * ### Use in forms
+ *
+ * For web forms, the `name` prop may be used to define the name of the group's `fieldset` and input elements.
+ *
+ * ### Validation
+ *
+ * Validation state may be set by passing 'error' or 'success' to the `validation` prop.
+ *
+ * ## A11y guidelines
+ *
+ * RadioCardGroup accepts all the common accessibility props, but also sets accessibility role `'radiogroup'`
+ * and controls the accessibility state of children like RadioCard and Feedback based on current state.
+ *
+ * @example
+ * ```jsx
+ * <RadioCardGroup
+ *   initialCheckedId="card1"
+ *   items={[
+ *     { title: 'Card 1', id: 'card1', content: <Typography>More info</Typography> },
+ *     { title: 'Card 2', id: 'card2', content: <Typography>Extra content</Typography> },
+ *     { title: 'Card 3', id: 'card3', content: <Typography>More content</Typography> }
+ *   ]}
+ *   legend="Cards"
+ *   hint="Choose a card to select"
+ * />
+ * ```
+ */
+const RadioCardGroup = ({
+  tokens,
+  radioCardTokens,
+  variant,
+  items = [],
+  legend,
+  tooltip,
+  hint,
+  validation,
+  feedback,
+  initialCheckedId,
+  checkedId,
+  onChange,
+  readOnly,
+  name: inputGroupName,
+  inactive
+}) => {
+  const viewport = (0, _ViewportProvider.useViewport)();
+  const {
+    space,
+    fieldSpace,
+    direction
+  } = (0, _ThemeProvider.useThemeTokens)('RadioCardGroup', tokens, variant, {
+    viewport
+  });
+  const {
+    currentValue,
+    setValue
+  } = (0, _utils.useInputValue)({
+    value: checkedId,
+    initialValue: initialCheckedId,
+    onChange,
+    readOnly: readOnly || inactive
+  });
+  const StackContainer = direction === 'row' ? _StackView.StackWrap : _StackView.default; // Needs 'radiogroup' role on direct parent of radios for MacOS Voiceover's numbering to work,
+  // and also needs 'radiogroup' role on fieldset for correct description on focusing the set.
+  // TODO: test this on more web screen readers.
+
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Fieldset.default, {
+    name: inputGroupName,
+    legend: legend,
+    tooltip: tooltip,
+    hint: hint,
+    space: fieldSpace,
+    feedback: feedback,
+    inactive: inactive || readOnly,
+    status: validation,
+    accessibilityRole: "radiogroup",
+    children: ({
+      a11yProps
+    }) => /*#__PURE__*/(0, _jsxRuntime.jsx)(StackContainer, {
+      space: space,
+      accessibilityRole: "radiogroup",
+      children: items.map(({
+        title,
+        content,
+        id,
+        onChange: itemOnChange
+      }, index) => {
+        const cardId = id || "RadioCard[".concat(index, "]");
+
+        const handleChange = (...args) => {
+          if (typeof itemOnChange === 'function') itemOnChange(...args);
+          setValue(cardId);
+        };
+
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(_RadioCard.default, {
+          id: cardId,
+          checked: currentValue === cardId,
+          onChange: handleChange,
+          inactive: inactive,
+          title: title,
+          name: inputGroupName,
+          tokens: radioCardTokens,
+          variant: variant,
+          readOnly: readOnly,
+          ...a11yProps,
+          children: content
+        }, cardId);
+      })
+    })
+  });
+};
+
+RadioCardGroup.propTypes = {
+  /**
+   * Optional theme token overrides for the outer RadioCardGroup component
+   */
+  tokens: (0, _utils.getTokensPropType)('RadioCardGroup'),
+
+  /**
+   * Optional theme token overrides for each inner RadioCard component
+   */
+  radioCardTokens: (0, _utils.getTokensPropType)('RadioCard'),
+
+  /**
+   * Theme variants, shared between both RadioCardGroup and RadioCard
+   */
+  variant: _utils.variantProp.propType,
+
+  /**
+   * Array of objects containing specifics for each RadioCard to be rendered in the group.
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.exact({
+    title: _propTypes.default.string,
+    content: _propTypes.default.node,
+    id: _propTypes.default.string,
+    onChange: _propTypes.default.func
+  })),
+
+  /**
+   * Main text used to describe this group, used in Fieldset's Legend element.
+   */
+  legend: _propTypes.default.string,
+
+  /**
+   * Optional additional text giving more detail to help a user make a choice.
+   */
+  hint: _propTypes.default.string,
+
+  /**
+   * Optional tooltip text content to include alongside the legend and hint.
+   */
+  tooltip: _propTypes.default.string,
+
+  /**
+   * Current validation status of the group, passed to the feedback element if there is one.
+   */
+  validation: _propTypes.default.oneOf(['error', 'success']),
+
+  /**
+   * If provided, a Feedback element is rendered containing this text.
+   */
+  feedback: _propTypes.default.string,
+
+  /**
+   * If provided, the radio card with this id is selected on first render.
+   */
+  initialCheckedId: _propTypes.default.string,
+
+  /**
+   * If not undefined, the radio card with this id is selected (or none is selected if `null`), and the
+   * element's selection state will be controlled by its parent using the `onChange` function.
+   */
+  checkedId: _propTypes.default.string,
+
+  /**
+   * Function to call on change in selection state. Is required if the selection state is controlled
+   * by a parent using checkedId and the input is not readOnly.
+   */
+  onChange: _propTypes.default.func,
+
+  /**
+   * If true, the radio cards cannot be selected by the user and simply show their current state.
+   */
+  readOnly: _propTypes.default.bool,
+
+  /**
+   * If true, the radio card cannot be interacted with, elements are set as `disabled` and if the
+   * theme supports `inactive` appearances rules, these are applied.
+   */
+  inactive: _propTypes.default.bool,
+
+  /**
+   * On Web, this is passed to the `name` attribute of the fieldset and each radio input.
+   */
+  name: _propTypes.default.string
+};
+var _default = RadioCardGroup;
+exports.default = _default;

package/lib/RadioCard/index.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "RadioCardGroup", {
+  enumerable: true,
+  get: function () {
+    return _RadioCardGroup.default;
+  }
+});
+exports.default = void 0;
+
+var _RadioCard = _interopRequireDefault(require("./RadioCard"));
+
+var _RadioCardGroup = _interopRequireDefault(require("./RadioCardGroup"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _RadioCard.default;
+exports.default = _default;

package/lib/Search/Search.js

@@ -0,0 +1,243 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _utils = require("../utils");
+
+var _TextInputBase = _interopRequireDefault(require("../TextInput/TextInputBase"));
+
+var _ButtonBase = _interopRequireDefault(require("../Button/ButtonBase"));
+
+var _StackView = _interopRequireDefault(require("../StackView"));
+
+var _useCopy = _interopRequireDefault(require("../utils/useCopy"));
+
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+
+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; }
+
+const selectInputTokens = ({
+  searchTokens,
+  buttonTokens,
+  buttonsGapSize
+}) => {
+  const {
+    paddingRight: inputPaddingRight,
+    clearButtonIcon,
+    submitButtonIcon
+  } = searchTokens;
+  const {
+    paddingLeft = 0,
+    paddingRight = 0,
+    iconSize = 0
+  } = buttonTokens;
+  const buttonWidth = paddingLeft + paddingRight + iconSize;
+  const paddingWithButtons = inputPaddingRight + (submitButtonIcon ? buttonWidth : 0) + (clearButtonIcon ? buttonsGapSize + buttonWidth : 0);
+  return { ...(0, _utils.selectTokens)('TextInput', searchTokens),
+    paddingRight: paddingWithButtons
+  };
+};
+
+const selectButtonTokens = tokens => (0, _utils.selectTokens)('Button', tokens);
+
+const selectIconsContainerStyle = ({
+  paddingRight
+}) => ({
+  paddingRight
+});
+
+const selectIconTokens = ({
+  iconSize,
+  iconColor
+}) => ({
+  color: iconColor,
+  size: iconSize
+});
+/**
+ * The `Search` component is a combination of a `TextInput` and 2 different kinds of custom buttons.
+ * Use `Search` to feature autocomplete interactions.
+ *
+ * This component includes a clear button, which will appear as text is entered and pressing it will
+ * cause the input's internal state value to be set to an empty string.
+ *
+ * This component may only be used as uncontrolled, as the search value is managed within an internal state.
+ * You can use the `onChange` prop to react to value changes and the `onSubmit` prop to react on search submission.
+ *
+ * Use the following props to supply additional accessibility labels for the input - `accessibilityLabel`,
+ * clear button - `clearButtonAccessibilityLabel`, and submit button - `submitButtonAccessibilityLabel`.
+ */
+
+
+const Search = ({
+  initialValue = '',
+  placeholder = 'Search',
+  inactive,
+  onChange,
+  onSubmit,
+  onClear,
+  accessibilityLabel,
+  copy = 'en',
+  tokens,
+  variant
+}) => {
+  const [value, setValue] = (0, _react.useState)(initialValue);
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Search', tokens, variant);
+  const buttonTokens = (0, _ThemeProvider.useThemeTokens)('SearchButton', tokens, variant);
+  const getThemeTokens = (0, _ThemeProvider.useThemeTokensCallback)('Search', tokens, variant);
+  const getButtonTokens = (0, _ThemeProvider.useThemeTokensCallback)('SearchButton', tokens, variant); // TODO: support overriding the a11y props using a custom dictionary
+
+  const getCopy = (0, _useCopy.default)({
+    dictionary: _dictionary.default,
+    copy
+  });
+  const {
+    placeholderColor,
+    buttonsGap,
+    clearButtonIcon: ClearButtonIcon,
+    submitButtonIcon: SubmitButtonIcon
+  } = themeTokens; // get the actual gap value for the current viewport
+
+  const buttonsGapSize = (0, _utils.useSpacingScale)(buttonsGap);
+
+  const handleSubmit = () => {
+    if (onSubmit !== undefined) {
+      onSubmit(value);
+    }
+  };
+
+  const handleChange = currentValue => {
+    setValue(currentValue);
+    if (onChange !== undefined) onChange(currentValue);
+  };
+
+  const handleClear = () => {
+    setValue('');
+    if (onClear !== undefined) onClear();
+    if (onChange !== undefined) onChange('');
+  };
+
+  const isEmpty = value === '';
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_TextInputBase.default, {
+      tokens: appearances => selectInputTokens({
+        searchTokens: getThemeTokens(appearances),
+        buttonTokens,
+        buttonsGapSize,
+        isEmpty
+      }),
+      placeholder: placeholder,
+      placeholderTextColor: placeholderColor,
+      inactive: inactive,
+      enablesReturnKeyAutomatically: true,
+      returnKeyType: "search",
+      value: value,
+      onChange: handleChange,
+      onSubmitEditing: handleSubmit,
+      accessibilityLabel: accessibilityLabel || getCopy('accessibilityLabel')
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      style: [staticStyles.iconsContainer, selectIconsContainerStyle(themeTokens)],
+      children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_StackView.default, {
+        direction: "row",
+        space: buttonsGap,
+        children: [ClearButtonIcon && !isEmpty && /*#__PURE__*/(0, _jsxRuntime.jsx)(_ButtonBase.default, {
+          onPress: handleClear,
+          inactive: inactive,
+          accessibilityRole: "button",
+          accessibilityLabel: getCopy('clearButtonAccessibilityLabel'),
+          tokens: appearances => selectButtonTokens(getButtonTokens(appearances)),
+          children: buttonState => /*#__PURE__*/(0, _jsxRuntime.jsx)(ClearButtonIcon, {
+            tokens: selectIconTokens(getButtonTokens(buttonState))
+          })
+        }), SubmitButtonIcon && /*#__PURE__*/(0, _jsxRuntime.jsx)(_ButtonBase.default, {
+          onPress: handleSubmit,
+          inactive: inactive,
+          accessibilityRole: "button",
+          accessibilityLabel: getCopy('submitButtonAccessibilityLabel'),
+          tokens: buttonState => selectButtonTokens(getButtonTokens({ ...buttonState,
+            priority: 'high'
+          })),
+          children: buttonState => /*#__PURE__*/(0, _jsxRuntime.jsx)(SubmitButtonIcon, {
+            tokens: selectIconTokens(getButtonTokens({ ...buttonState,
+              priority: 'high'
+            }))
+          })
+        })]
+      })
+    })]
+  });
+};
+
+Search.propTypes = {
+  /**
+   * Use this to set the initial value of the search input.
+   * Updating `initialValue` will **not** update the actual value.
+   */
+  initialValue: _propTypes.default.string,
+
+  /**
+   * Label rendered in the search input when it has no value.
+   */
+  placeholder: _propTypes.default.string,
+
+  /**
+   * Disables all user interactions with the search input.
+   */
+  inactive: _propTypes.default.bool,
+
+  /**
+   * Use to react upon search input's value changes.
+   * Will receive the searched value as an argument.
+   */
+  onChange: _propTypes.default.func,
+
+  /**
+   * Triggered when the search input is submitted,
+   * either by pressing the submit button, "Enter" key on web,
+   * or "Search" key in a mobile keyboard.
+   */
+  onSubmit: _propTypes.default.func,
+
+  /**
+   * Triggered when the clear button is pressed.
+   */
+  onClear: _propTypes.default.func,
+
+  /**
+   * Use to provide an accessible label for the input (visually hidden).
+   */
+  accessibilityLabel: _propTypes.default.string,
+  copy: _propTypes.default.oneOfType([_propTypes.default.oneOf(['en', 'fr']), _propTypes.default.object]),
+  tokens: (0, _utils.getTokensPropType)('Search'),
+  variant: _utils.variantProp.propType
+};
+var _default = Search;
+exports.default = _default;
+
+const staticStyles = _StyleSheet.default.create({
+  iconsContainer: {
+    position: 'absolute',
+    right: 0,
+    top: 0,
+    bottom: 0,
+    justifyContent: 'center'
+  }
+});

package/lib/Search/dictionary.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  en: {
+    accessibilityLabel: 'Search',
+    clearButtonAccessibilityLabel: 'Clear',
+    submitButtonAccessibilityLabel: 'Search'
+  },
+  fr: {
+    accessibilityLabel: 'Chercher',
+    clearButtonAccessibilityLabel: 'Effacer',
+    submitButtonAccessibilityLabel: 'Chercher'
+  }
+};
+exports.default = _default;

package/lib/Search/index.js

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

package/lib/Select/Group.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _utils = require("../utils");
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Group = ({
+  children,
+  label
+}) => {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)("optgroup", {
+    label: label,
+    children: children
+  });
+};
+
+var _default = Group;
+exports.default = _default;
+Group.propTypes = {
+  children: (0, _utils.componentPropType)('Item'),
+  label: _propTypes.default.string.isRequired
+};

package/lib/Select/Group.native.js

@@ -1,5 +1,15 @@
-import PropTypes from 'prop-types';
-import { componentPropType } from '../utils';
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _utils = require("../utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const Group = ({
   children
@@ -7,8 +17,9 @@ const Group = ({
   return children;
 };
 
-export default Group;
+var _default = Group;
+exports.default = _default;
 Group.propTypes = {
-  children: componentPropType('Item'),
-  label: PropTypes.string.isRequired
+  children: (0, _utils.componentPropType)('Item'),
+  label: _propTypes.default.string.isRequired
 };

package/lib/Select/Item.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Item = ({
+  children,
+  value
+}) => /*#__PURE__*/(0, _jsxRuntime.jsx)("option", {
+  value: value,
+  children: children
+});
+
+var _default = Item;
+exports.default = _default;
+Item.propTypes = {
+  children: _propTypes.default.string.isRequired,
+  value: _propTypes.default.string.isRequired
+};

package/lib/Select/Item.native.js

@@ -1,9 +1,19 @@
-import PropTypes from 'prop-types';
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const Item = () => null;
 
-export default Item;
+var _default = Item;
+exports.default = _default;
 Item.propTypes = {
-  children: PropTypes.string.isRequired,
-  value: PropTypes.string.isRequired
+  children: _propTypes.default.string.isRequired,
+  value: _propTypes.default.string.isRequired
 };