@telus-uds/components-base 1.3.0 → 1.3.1

package/lib-module/RadioCard/RadioCard.js

@@ -0,0 +1,218 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Text from "react-native-web/dist/exports/Text";
+import View from "react-native-web/dist/exports/View";
+import { useThemeTokensCallback, applyTextStyles } from '../ThemeProvider';
+import { a11yProps, getTokensPropType, selectSystemProps, selectTokens, useInputValue, useUniqueId, variantProp, viewProps } from '../utils';
+import { PressableCardBase, selectPressableCardTokens } from '../Card';
+import StackView from '../StackView';
+import RadioButton, { selectRadioButtonTokens } from '../Radio/RadioButton';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+/**
+ * A Card that behaves like a radio button. Use when users select a single choice from mutually exclusive options
+ * with need to show additional information for each option. The whole card is interactive as one item.
+ *
+ * ## Component API
+ *
+ * Use `title` prop to provide a main description, and `children` for additional content. Avoid including
+ * interactive elements within the RadioCard content.
+ *
+ * For a disabled `RadioCard`, set the `inactive` prop to `true`.
+ *
+ * ### Controlled version
+ *
+ * If the radio card is controlled from outside, it needs to receive `checked` and `onChange` props.
+ *
+ * ### Uncontrolled version
+ *
+ * In case of uncontrolled radio card you can use `defaultChecked` prop to provide the initial value.
+ * Whenever the radio card gets toggled, it calls the `onChange` callback with the new value (boolean).
+ *
+ * ### Using within forms
+ *
+ * You can pass `name` and `value` props if you need a particular radio card to be a part of a radio group
+ * on a form.
+ *
+ * ### Validation
+ *
+ * You can mark a radio card as failing validation by setting the `error` prop to `true`.
+ *
+ * ## A11y guidelines
+ *
+ * Radio card accepts all the common accessibility props, but also sets some defaults, including
+ * accessibility role `'radio'` and accessibility state that depends on the other props (`checked`, `inactive`)
+ * or the internal state in case of uncontrolled radio button.
+ */
+
+const RadioCard = /*#__PURE__*/forwardRef(({
+  tokens,
+  variant,
+  title,
+  children,
+  inactive,
+  defaultChecked,
+  checked,
+  name: inputName,
+  value,
+  id,
+  onChange,
+  ...rest
+}, ref) => {
+  const {
+    currentValue: isChecked,
+    setValue: setIsChecked,
+    isControlled
+  } = useInputValue({
+    value: checked,
+    initialValue: defaultChecked,
+    onChange
+  });
+
+  const handleChange = event => {
+    if (!inactive && !isChecked) {
+      setIsChecked(true, event);
+    }
+  };
+
+  const uniqueId = useUniqueId('RadioCard');
+  const inputId = id ?? uniqueId;
+  const getTokens = useThemeTokensCallback('RadioCard', tokens, variant);
+
+  const getCardTokens = cardState => selectPressableCardTokens(getTokens(cardState));
+
+  return /*#__PURE__*/_jsx(PressableCardBase, {
+    ref: ref,
+    inactive: inactive,
+    checked: isChecked,
+    tokens: getCardTokens,
+    onPress: handleChange,
+    accessibilityRole: "radio",
+    accessibilityState: {
+      checked: isChecked,
+      disabled: inactive
+    },
+    ...selectProps(rest),
+    children: cardState => {
+      const {
+        radioSpace,
+        contentSpace,
+        ...themeTokens
+      } = getTokens(cardState);
+      const radioTokens = selectRadioButtonTokens(themeTokens, 'radio');
+      const titleTokens = selectTokens('Typography', themeTokens);
+      const textStyle = applyTextStyles(titleTokens);
+      return /*#__PURE__*/_jsxs(StackView, {
+        direction: "row",
+        space: radioSpace,
+        children: [/*#__PURE__*/_jsx(View, {
+          style: [staticStyles.alignWithText, {
+            height: textStyle.lineHeight
+          }],
+          children: /*#__PURE__*/_jsx(RadioButton, {
+            tokens: radioTokens,
+            isControlled: isControlled,
+            isChecked: isChecked,
+            inactive: inactive,
+            defaultChecked: defaultChecked,
+            inputId: inputId,
+            handleChange: handleChange,
+            name: inputName,
+            value: value
+          })
+        }), /*#__PURE__*/_jsxs(StackView, {
+          direction: "column",
+          space: contentSpace,
+          tokens: {
+            flexShrink: 1
+          },
+          children: [title && /*#__PURE__*/_jsx(Text, {
+            style: textStyle,
+            children: title
+          }), typeof children === 'function' ? children(cardState, textStyle) : children]
+        })]
+      });
+    }
+  });
+});
+RadioCard.displayName = 'RadioCard';
+RadioCard.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Content to be displayed at the top of the card alongside the radio button
+   */
+  title: PropTypes.string,
+
+  /**
+   * Additional content to be displayed below the button.
+   */
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+
+  /**
+   * Use `checked` for controlled Radio. For uncontrolled Radio, use the `defaultChecked` prop.
+   */
+  checked: PropTypes.bool,
+
+  /**
+   * Use `defaultChecked` to provide the initial value for an uncontrolled Radio.
+   */
+  defaultChecked: PropTypes.bool,
+
+  /**
+   * An optional radio button description.
+   */
+  description: PropTypes.string,
+
+  /**
+   * Radio card button ID.
+   */
+  id: PropTypes.string,
+
+  /**
+   * Whether the corresponding input is disabled or active.
+   */
+  inactive: PropTypes.bool,
+
+  /**
+   * The label.
+   */
+  label: PropTypes.string,
+
+  /**
+   * Associate this radio card with a group (set as the name attribute).
+   */
+  name: PropTypes.string,
+
+  /**
+   * Whether the underlying input triggered a validation error or not.
+   */
+  error: PropTypes.bool,
+
+  /**
+   * The value. Must be unique within the group.
+   */
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool]),
+
+  /**
+   * Callback called when a controlled radio card gets interacted with.
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * Radio card tokens.
+   */
+  tokens: getTokensPropType('RadioCard'),
+
+  /**
+   * Radio variant.
+   */
+  variant: variantProp.propType
+};
+const staticStyles = StyleSheet.create({
+  alignWithText: {
+    justifyContent: 'center'
+  }
+});
+export default RadioCard;

package/lib-module/RadioCard/RadioCardGroup.js

@@ -0,0 +1,232 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import { useViewport } from '../ViewportProvider';
+import { useThemeTokens } from '../ThemeProvider';
+import { a11yProps, getTokensPropType, selectSystemProps, useInputValue, variantProp, viewProps } from '../utils';
+import StackView, { StackWrap } from '../StackView';
+import RadioCard from './RadioCard';
+import Fieldset from '../Fieldset';
+import { jsx as _jsx } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+/**
+ * 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 = /*#__PURE__*/forwardRef(({
+  tokens,
+  radioCardTokens,
+  variant,
+  items = [],
+  legend,
+  tooltip,
+  hint,
+  validation,
+  feedback,
+  initialCheckedId,
+  checkedId,
+  onChange,
+  readOnly,
+  name: inputGroupName,
+  inactive,
+  ...rest
+}, ref) => {
+  const viewport = useViewport();
+  const {
+    space,
+    fieldSpace,
+    direction
+  } = useThemeTokens('RadioCardGroup', tokens, variant, {
+    viewport
+  });
+  const {
+    currentValue,
+    setValue
+  } = useInputValue({
+    value: checkedId,
+    initialValue: initialCheckedId,
+    onChange,
+    readOnly: readOnly || inactive
+  });
+  const StackContainer = direction === 'row' ? StackWrap : StackView; // 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__*/_jsx(Fieldset, {
+    ref: ref,
+    name: inputGroupName,
+    legend: legend,
+    tooltip: tooltip,
+    hint: hint,
+    space: fieldSpace,
+    feedback: feedback,
+    inactive: inactive || readOnly,
+    validation: validation,
+    accessibilityRole: "radiogroup",
+    ...selectProps(rest),
+    children: props => /*#__PURE__*/_jsx(StackContainer, {
+      space: space,
+      accessibilityRole: "radiogroup",
+      children: items.map(({
+        title,
+        content,
+        id,
+        onChange: itemOnChange
+      }, index) => {
+        const cardId = id || `RadioCard[${index}]`;
+
+        const handleChange = (newCheckedState, event) => {
+          if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event);
+          if (newCheckedState) setValue(cardId, event);
+        };
+
+        return /*#__PURE__*/_jsx(RadioCard, {
+          id: cardId,
+          checked: currentValue === cardId,
+          onChange: handleChange,
+          inactive: inactive,
+          title: title,
+          name: inputGroupName,
+          tokens: radioCardTokens,
+          variant: variant,
+          readOnly: readOnly,
+          ...props,
+          children: content
+        }, cardId);
+      })
+    })
+  });
+});
+RadioCardGroup.displayName = 'RadioCardGroup';
+RadioCardGroup.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Optional theme token overrides for the outer RadioCardGroup component
+   */
+  tokens: getTokensPropType('RadioCardGroup'),
+
+  /**
+   * Optional theme token overrides for each inner RadioCard component
+   */
+  radioCardTokens: getTokensPropType('RadioCard'),
+
+  /**
+   * Theme variants, shared between both RadioCardGroup and RadioCard
+   */
+  variant: variantProp.propType,
+
+  /**
+   * Array of objects containing specifics for each RadioCard to be rendered in the group.
+   */
+  items: PropTypes.arrayOf(PropTypes.exact({
+    title: PropTypes.string,
+    content: PropTypes.node,
+    id: PropTypes.string,
+    onChange: PropTypes.func
+  })),
+
+  /**
+   * Main text used to describe this group, used in Fieldset's Legend element.
+   */
+  legend: PropTypes.string,
+
+  /**
+   * Optional additional text giving more detail to help a user make a choice.
+   */
+  hint: PropTypes.string,
+
+  /**
+   * Optional tooltip text content to include alongside the legend and hint.
+   */
+  tooltip: PropTypes.string,
+
+  /**
+   * Current validation status of the group, passed to the feedback element if there is one.
+   */
+  validation: PropTypes.oneOf(['error', 'success']),
+
+  /**
+   * If provided, a Feedback element is rendered containing this text.
+   */
+  feedback: PropTypes.string,
+
+  /**
+   * If provided, the radio card with this id is selected on first render.
+   */
+  initialCheckedId: PropTypes.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.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.func,
+
+  /**
+   * If true, the radio cards cannot be selected by the user and simply show their current state.
+   */
+  readOnly: PropTypes.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.bool,
+
+  /**
+   * On Web, this is passed to the `name` attribute of the fieldset and each radio input.
+   */
+  name: PropTypes.string
+};
+export default RadioCardGroup;

package/lib-module/RadioCard/index.js

@@ -0,0 +1,3 @@
+import RadioCard from './RadioCard';
+export default RadioCard;
+export { default as RadioCardGroup } from './RadioCardGroup';

package/lib-module/Search/Search.js

@@ -0,0 +1,233 @@
+import React, { forwardRef, useState } 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, useSpacingScale, 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 [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+
+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 { ...selectTokens('TextInput', searchTokens),
+    paddingRight: paddingWithButtons
+  };
+};
+
+const selectButtonTokens = tokens => 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__*/forwardRef(({
+  initialValue = '',
+  placeholder = 'Search',
+  inactive,
+  onChange,
+  onSubmit,
+  onClear,
+  accessibilityLabel,
+  copy = 'en',
+  tokens,
+  variant,
+  ...rest
+}, ref) => {
+  const [value, setValue] = useState(initialValue);
+  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(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__*/_jsxs(View, {
+    style: staticStyles.container,
+    ...selectProps(rest),
+    children: [/*#__PURE__*/_jsx(TextInputBase, {
+      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__*/_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 = { ...selectedSystemPropTypes,
+
+  /**
+   * 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,
+
+  /**
+   * 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;