@telus-uds/components-base 1.8.3 → 1.9.0

package/lib-module/Search/Search.js

@@ -0,0 +1,261 @@
+import React, { forwardRef } from 'react';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import PropTypes from 'prop-types';
+import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider';
+import { a11yProps, getTokensPropType, selectSystemProps, selectTokens, useInputValue, useSpacingScale, textInputHandlerProps, textInputProps, variantProp, viewProps } from '../utils';
+import TextInputBase from '../TextInput/TextInputBase';
+import ButtonBase from '../Button/ButtonBase';
+import StackView from '../StackView';
+import useCopy from '../utils/useCopy';
+import dictionary from './dictionary';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectContainerProps, selectedContainerPropTypes] = selectSystemProps([a11yProps, viewProps]);
+const [selectInputProps, selectedInputPropTypes] = selectSystemProps([textInputHandlerProps, textInputProps]);
+
+const selectInputTokens = _ref => {
+  let {
+    searchTokens,
+    buttonTokens,
+    buttonsGapSize
+  } = _ref;
+  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 { ...selectTokens('TextInput', searchTokens),
+    paddingRight: paddingWithButtons
+  };
+};
+
+const selectButtonTokens = tokens => selectTokens('Button', tokens);
+
+const selectIconsContainerStyle = _ref2 => {
+  let {
+    paddingRight
+  } = _ref2;
+  return {
+    paddingRight
+  };
+};
+
+const selectIconTokens = _ref3 => {
+  let {
+    iconSize,
+    iconColor
+  } = _ref3;
+  return {
+    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__*/forwardRef((_ref4, ref) => {
+  let {
+    initialValue,
+    value,
+    placeholder,
+    inactive,
+    onChange,
+    onSubmit,
+    onClear,
+    onFocus,
+    accessibilityLabel,
+    copy = 'en',
+    tokens,
+    variant,
+    ...rest
+  } = _ref4;
+  const {
+    currentValue = '',
+    setValue
+  } = useInputValue({
+    value,
+    initialValue,
+    onChange
+  });
+  const themeTokens = useThemeTokens('Search', tokens, variant);
+  const buttonTokens = useThemeTokens('SearchButton', tokens, variant);
+  const getThemeTokens = useThemeTokensCallback('Search', tokens, variant);
+  const getButtonTokens = useThemeTokensCallback('SearchButton', tokens, variant); // TODO: support overriding the a11y props using a custom dictionary
+
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
+  const {
+    placeholderColor,
+    buttonsGap,
+    clearButtonIcon: ClearButtonIcon,
+    submitButtonIcon: SubmitButtonIcon
+  } = themeTokens; // get the actual gap value for the current viewport
+
+  const buttonsGapSize = useSpacingScale(buttonsGap);
+
+  const handleSubmit = event => {
+    if (onSubmit !== undefined) {
+      onSubmit(currentValue, event);
+    }
+  };
+
+  const handleClear = event => {
+    setValue('', event);
+    if (onClear !== undefined) onClear('', event);
+  };
+
+  const handleFocus = event => {
+    if (onFocus !== undefined) onFocus(event);
+  };
+
+  const isEmpty = currentValue === ''; // Accessibility label should always be present and correctly localised
+
+  const a11yLabelText = accessibilityLabel || getCopy('accessibilityLabel'); // Placeholder is optional and may be unset by passing an empty string
+
+  const placeholderText = placeholder !== null && placeholder !== void 0 ? placeholder : a11yLabelText;
+  return /*#__PURE__*/_jsxs(View, {
+    style: staticStyles.container,
+    ...selectContainerProps(rest),
+    children: [/*#__PURE__*/_jsx(TextInputBase, { ...selectInputProps(rest),
+      ref: ref,
+      tokens: appearances => selectInputTokens({
+        searchTokens: getThemeTokens(appearances),
+        buttonTokens,
+        buttonsGapSize,
+        isEmpty
+      }),
+      placeholder: placeholderText,
+      placeholderTextColor: placeholderColor,
+      inactive: inactive,
+      enablesReturnKeyAutomatically: true,
+      returnKeyType: "search",
+      value: currentValue,
+      onChange: setValue,
+      onSubmitEditing: handleSubmit,
+      onFocus: handleFocus,
+      accessibilityLabel: a11yLabelText
+    }), /*#__PURE__*/_jsx(View, {
+      style: [staticStyles.iconsContainer, selectIconsContainerStyle(themeTokens)],
+      children: /*#__PURE__*/_jsxs(StackView, {
+        direction: "row",
+        space: buttonsGap,
+        children: [ClearButtonIcon && !isEmpty && /*#__PURE__*/_jsx(ButtonBase, {
+          onPress: handleClear,
+          inactive: inactive,
+          accessibilityRole: "button",
+          accessibilityLabel: getCopy('clearButtonAccessibilityLabel'),
+          tokens: appearances => selectButtonTokens(getButtonTokens(appearances)),
+          children: buttonState => /*#__PURE__*/_jsx(ClearButtonIcon, { ...selectIconTokens(getButtonTokens(buttonState))
+          })
+        }), SubmitButtonIcon && /*#__PURE__*/_jsx(ButtonBase, {
+          onPress: handleSubmit,
+          inactive: inactive,
+          accessibilityRole: "button",
+          accessibilityLabel: getCopy('submitButtonAccessibilityLabel'),
+          tokens: buttonState => selectButtonTokens(getButtonTokens({ ...buttonState,
+            priority: 'high'
+          })),
+          children: buttonState => /*#__PURE__*/_jsx(SubmitButtonIcon, { ...selectIconTokens(getButtonTokens({ ...buttonState,
+              priority: 'high'
+            }))
+          })
+        })]
+      })
+    })]
+  });
+});
+Search.displayName = 'Search';
+Search.propTypes = { ...selectedContainerPropTypes,
+  ...selectedInputPropTypes,
+
+  /**
+   * Use this to set the initial value of the search input.
+   * Updating `initialValue` will **not** update the actual value.
+   */
+  initialValue: PropTypes.string,
+
+  /**
+   * Label rendered in the search input when it has no value.
+   */
+  placeholder: PropTypes.string,
+
+  /**
+   * Disables all user interactions with the search input.
+   */
+  inactive: PropTypes.bool,
+
+  /**
+   * Use to react upon search input's value changes.
+   * Will receive the searched value as an argument.
+   */
+  onChange: PropTypes.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.func,
+
+  /**
+   * Triggered when the clear button is pressed.
+   */
+  onClear: PropTypes.func,
+
+  /**
+   * Triggered when the search input is focused.
+   */
+  onFocus: PropTypes.func,
+
+  /**
+   *
+   * Use to provide an accessible label for the input (visually hidden).
+   */
+  accessibilityLabel: PropTypes.string,
+
+  /**
+   * Select English or French copy for the accessible labels.
+   * You may also pass in a custom dictionary object.
+   */
+  copy: PropTypes.oneOfType([PropTypes.oneOf(['en', 'fr']), PropTypes.shape({
+    accessibilityLabel: PropTypes.string,
+    clearButtonAccessibilityLabel: PropTypes.string,
+    submitButtonAccessibilityLabel: PropTypes.string
+  })]),
+  tokens: getTokensPropType('Search'),
+  variant: variantProp.propType
+};
+export default Search;
+const staticStyles = StyleSheet.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-module/Search/dictionary.js

@@ -0,0 +1,12 @@
+export default {
+  en: {
+    accessibilityLabel: 'Search',
+    clearButtonAccessibilityLabel: 'Clear',
+    submitButtonAccessibilityLabel: 'Search'
+  },
+  fr: {
+    accessibilityLabel: 'Chercher',
+    clearButtonAccessibilityLabel: 'Effacer',
+    submitButtonAccessibilityLabel: 'Chercher'
+  }
+};

package/lib-module/Search/index.js

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

package/lib-module/Select/Group.js

@@ -0,0 +1,21 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { componentPropType } from '../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const Group = _ref => {
+  let {
+    children,
+    label
+  } = _ref;
+  return /*#__PURE__*/_jsx("optgroup", {
+    label: label,
+    children: children
+  });
+};
+
+export default Group;
+Group.propTypes = {
+  children: componentPropType('Item'),
+  label: PropTypes.string.isRequired
+};

package/lib-module/Select/Group.native.js

@@ -0,0 +1,15 @@
+import PropTypes from 'prop-types';
+import { componentPropType } from '../utils';
+
+const Group = _ref => {
+  let {
+    children
+  } = _ref;
+  return children;
+};
+
+export default Group;
+Group.propTypes = {
+  children: componentPropType('Item'),
+  label: PropTypes.string.isRequired
+};

package/lib-module/Select/Item.js

@@ -0,0 +1,20 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const Item = _ref => {
+  let {
+    children,
+    value
+  } = _ref;
+  return /*#__PURE__*/_jsx("option", {
+    value: value,
+    children: children
+  });
+};
+
+export default Item;
+Item.propTypes = {
+  children: PropTypes.string.isRequired,
+  value: PropTypes.string.isRequired
+};

package/lib-module/Select/Item.native.js

@@ -0,0 +1,3 @@
+const Item = () => null;
+
+export default Item;

package/lib-module/Select/Picker.js

@@ -0,0 +1,68 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import { componentPropType } from '../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const Picker = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    value,
+    onChange,
+    onFocus,
+    onBlur,
+    onMouseOver,
+    onMouseOut,
+    style,
+    inactive,
+    children,
+    placeholder,
+    nativeID,
+    testID,
+    ...rest
+  } = _ref;
+  const {
+    accessibilityLabel,
+    accessibilityDescribedBy,
+    accessibilityInvalid
+  } = rest;
+  return /*#__PURE__*/_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__*/_jsx("option", {
+      value: placeholder.value,
+      disabled: true,
+      hidden: true,
+      children: placeholder.label
+    }), children]
+  });
+});
+Picker.displayName = 'Picker';
+export default Picker;
+Picker.propTypes = {
+  value: PropTypes.string,
+  onChange: PropTypes.func,
+  onFocus: PropTypes.func,
+  onBlur: PropTypes.func,
+  onMouseOver: PropTypes.func,
+  onMouseOut: PropTypes.func,
+  style: PropTypes.object,
+  inactive: PropTypes.bool,
+  children: componentPropType(['Item', 'Group']),
+  placeholder: PropTypes.shape({
+    value: PropTypes.string,
+    label: PropTypes.string
+  }),
+  nativeID: PropTypes.string,
+  testID: PropTypes.string
+};

package/lib-module/Select/Picker.native.js

@@ -0,0 +1,120 @@
+import React, { forwardRef, Children } from 'react';
+import PropTypes from 'prop-types';
+import View from "react-native-web/dist/exports/View";
+import Platform from "react-native-web/dist/exports/Platform";
+import NativePicker from 'react-native-picker-select';
+import { a11yProps, componentPropType } from '../utils';
+import Group from './Group'; // styling of the native input is very limited, most of the styles have to be applied to an additional View
+
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+
+const selectAndroidInputStyles = _ref => {
+  let {
+    height = 0,
+    paddingBottom = 0,
+    paddingTop = 0,
+    borderWidth = 0,
+    color
+  } = _ref;
+  return {
+    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 = _ref2 => {
+  let {
+    paddingLeft = 0,
+    paddingRight = 0,
+    ...rest
+  } = _ref2;
+  return {
+    paddingLeft: paddingLeft > 8 ? paddingLeft - 8 : 0,
+    paddingRight: paddingRight > 8 ? paddingRight - 8 : 0,
+    ...rest
+  };
+};
+
+const Picker = /*#__PURE__*/forwardRef((_ref3, ref) => {
+  let {
+    value,
+    onChange,
+    onFocus,
+    onBlur,
+    style,
+    inactive,
+    children,
+    placeholder,
+    ...rest
+  } = _ref3;
+  // ungroup items, since there's no way to support groups on native
+  const flatChildren = Children.toArray(children).flatMap(child => {
+    if (child.type === Group) {
+      return child.props.children;
+    }
+
+    return child;
+  });
+  const items = flatChildren.map(_ref4 => {
+    let {
+      props
+    } = _ref4;
+    return {
+      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__*/_jsx(NativePicker, {
+    pickerProps: {
+      ref
+    },
+    touchableWrapperProps: 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__*/_jsx(_Fragment, {
+    children: Platform.OS === 'android' ? /*#__PURE__*/_jsx(View, {
+      style: selectAndroidContainerStyles(style),
+      children: picker
+    }) : picker
+  });
+});
+Picker.displayName = 'Picker';
+export default Picker;
+Picker.propTypes = {
+  value: PropTypes.string,
+  onChange: PropTypes.func,
+  onFocus: PropTypes.func,
+  onBlur: PropTypes.func,
+  style: PropTypes.object,
+  inactive: PropTypes.bool,
+  children: componentPropType(['Item', 'Group']),
+  placeholder: PropTypes.shape({
+    value: PropTypes.string,
+    label: PropTypes.string
+  })
+};