@telus-uds/components-base 0.0.2-prerelease.6 → 1.0.0

package/lib/Search/Search.js

@@ -0,0 +1,254 @@
+"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 = /*#__PURE__*/(0, _react.forwardRef)(({
+  initialValue = '',
+  placeholder = 'Search',
+  inactive,
+  onChange,
+  onSubmit,
+  onClear,
+  accessibilityLabel,
+  copy = 'en',
+  tokens,
+  variant
+}, ref) => {
+  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 = event => {
+    if (onSubmit !== undefined) {
+      onSubmit(value, event);
+    }
+  };
+
+  const handleChange = (currentValue, event) => {
+    setValue(currentValue, event);
+    if (onChange !== undefined) onChange(currentValue, event);
+  };
+
+  const handleClear = event => {
+    setValue('', event);
+    if (onClear !== undefined) onClear('', event);
+    if (onChange !== undefined) onChange('', event);
+  };
+
+  const isEmpty = value === '';
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+    style: staticStyles.container,
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_TextInputBase.default, {
+      ref: ref,
+      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, { ...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, { ...selectIconTokens(getButtonTokens({ ...buttonState,
+              priority: 'high'
+            }))
+          })
+        })]
+      })
+    })]
+  });
+});
+Search.displayName = 'Search';
+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,
+
+  /**
+   * 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']), _propTypes.default.shape({
+    accessibilityLabel: _propTypes.default.string,
+    clearButtonAccessibilityLabel: _propTypes.default.string,
+    submitButtonAccessibilityLabel: _propTypes.default.string
+  })]),
+  tokens: (0, _utils.getTokensPropType)('Search'),
+  variant: _utils.variantProp.propType
+};
+var _default = Search;
+exports.default = _default;
+
+const staticStyles = _StyleSheet.default.create({
+  container: {// No styles needed here except the View defaults (position: relative etc)
+  },
+  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

@@ -0,0 +1,25 @@
+"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
+}) => {
+  return children;
+};
+
+var _default = Group;
+exports.default = _default;
+Group.propTypes = {
+  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

@@ -0,0 +1,19 @@
+"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;
+
+var _default = Item;
+exports.default = _default;
+Item.propTypes = {
+  children: _propTypes.default.string.isRequired,
+  value: _propTypes.default.string.isRequired
+};

package/lib/Select/Picker.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(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 }; }
+
+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 Picker = /*#__PURE__*/(0, _react.forwardRef)(({
+  value,
+  onChange,
+  onFocus,
+  onBlur,
+  onMouseOver,
+  onMouseOut,
+  style,
+  inactive,
+  children,
+  placeholder,
+  nativeID,
+  testID,
+  ...rest
+}, ref) => {
+  const {
+    accessibilityLabel,
+    accessibilityDescribedBy,
+    accessibilityInvalid
+  } = rest;
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)("select", {
+    ref: ref,
+    style: style,
+    onMouseOver: onMouseOver,
+    onMouseOut: onMouseOut,
+    onFocus: onFocus,
+    onBlur: onBlur,
+    disabled: inactive,
+    value: value || (placeholder !== undefined ? placeholder.value : undefined),
+    onChange: event => onChange(event.target.value, event),
+    id: nativeID,
+    "aria-label": accessibilityLabel,
+    "aria-describedby": accessibilityDescribedBy,
+    "aria-invalid": accessibilityInvalid,
+    "data-testid": testID,
+    children: [placeholder !== undefined && /*#__PURE__*/(0, _jsxRuntime.jsx)("option", {
+      value: placeholder.value,
+      disabled: true,
+      hidden: true,
+      children: placeholder.label
+    }), children]
+  });
+});
+Picker.displayName = 'Picker';
+var _default = Picker;
+exports.default = _default;
+Picker.propTypes = {
+  value: _propTypes.default.string,
+  onChange: _propTypes.default.func,
+  onFocus: _propTypes.default.func,
+  onBlur: _propTypes.default.func,
+  onMouseOver: _propTypes.default.func,
+  onMouseOut: _propTypes.default.func,
+  style: _propTypes.default.object,
+  inactive: _propTypes.default.bool,
+  children: (0, _utils.componentPropType)(['Item', 'Group']),
+  placeholder: _propTypes.default.shape({
+    value: _propTypes.default.string,
+    label: _propTypes.default.string
+  }),
+  nativeID: _propTypes.default.string,
+  testID: _propTypes.default.string
+};

package/lib/Select/Picker.native.js

@@ -0,0 +1,130 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+
+var _reactNativePickerSelect = _interopRequireDefault(require("react-native-picker-select"));
+
+var _utils = require("../utils");
+
+var _Group = _interopRequireDefault(require("./Group"));
+
+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; }
+
+// styling of the native input is very limited, most of the styles have to be applied to an additional View
+const selectAndroidInputStyles = ({
+  height = 0,
+  paddingBottom = 0,
+  paddingTop = 0,
+  borderWidth = 0,
+  color
+}) => ({
+  height: height - paddingTop - paddingBottom - 2 * borderWidth,
+  color
+}); // the native input has a side padding of 8px, which can't be adjusted, so we have to account for that in the container
+
+
+const selectAndroidContainerStyles = ({
+  paddingLeft = 0,
+  paddingRight = 0,
+  ...rest
+}) => ({
+  paddingLeft: paddingLeft > 8 ? paddingLeft - 8 : 0,
+  paddingRight: paddingRight > 8 ? paddingRight - 8 : 0,
+  ...rest
+});
+
+const Picker = /*#__PURE__*/(0, _react.forwardRef)(({
+  value,
+  onChange,
+  onFocus,
+  onBlur,
+  style,
+  inactive,
+  children,
+  placeholder,
+  ...rest
+}, ref) => {
+  // ungroup items, since there's no way to support groups on native
+  const flatChildren = _react.Children.toArray(children).flatMap(child => {
+    if (child.type === _Group.default) {
+      return child.props.children;
+    }
+
+    return child;
+  });
+
+  const items = flatChildren.map(({
+    props
+  }) => ({
+    label: props.children,
+    value: props.value
+  })); // Unlike other input components, react-native-picker-select doesn't pass an event to its change fn.
+
+  const handleChange = (newValue, index) => {
+    if (onChange) onChange(newValue, {
+      // TODO: see if it's possible to pass a real React SyntheticEvent here. For now, just pass an
+      // object with a shape where if an onChange deconstructs `event.nativeEvent`, it won't crash.
+      nativeEvent: {
+        index,
+        value: newValue
+      }
+    });
+  };
+
+  const picker = /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactNativePickerSelect.default, {
+    pickerProps: {
+      ref
+    },
+    touchableWrapperProps: _utils.a11yProps.select(rest),
+    onOpen: onFocus,
+    onClose: onBlur,
+    disabled: inactive,
+    items: items,
+    value: value,
+    onValueChange: handleChange,
+    style: {
+      inputIOS: style,
+      inputAndroid: selectAndroidInputStyles(style)
+    },
+    placeholder: placeholder !== undefined ? placeholder : {}
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+    children: _Platform.default.OS === 'android' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      style: selectAndroidContainerStyles(style),
+      children: picker
+    }) : picker
+  });
+});
+Picker.displayName = 'Picker';
+var _default = Picker;
+exports.default = _default;
+Picker.propTypes = {
+  value: _propTypes.default.string,
+  onChange: _propTypes.default.func,
+  onFocus: _propTypes.default.func,
+  onBlur: _propTypes.default.func,
+  style: _propTypes.default.object,
+  inactive: _propTypes.default.bool,
+  children: (0, _utils.componentPropType)(['Item', 'Group']),
+  placeholder: _propTypes.default.shape({
+    value: _propTypes.default.string,
+    label: _propTypes.default.string
+  })
+};