@telus-uds/components-base 1.96.0 → 1.97.1

package/lib-module/Radio/RadioButton.js

@@ -1,184 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import Platform from "react-native-web/dist/exports/Platform";
-import StyleSheet from "react-native-web/dist/exports/StyleSheet";
-import View from "react-native-web/dist/exports/View";
-import RadioInput from './RadioInput';
-import { applyOuterBorder, applyShadowToken, resolveThemeTokens, validateThemeTokens, useThemeTokens } from '../ThemeProvider';
-import { a11yProps, getTokensSetPropType, selectSystemProps, selectTokens, viewProps } from '../utils';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { jsxs as _jsxs } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
-
-// TODO: roll out a standard approach to token sets
-// https://github.com/telus/universal-design-system/issues/782
-const tokenKeys = ['checkedBackgroundColor', 'checkedSize', 'inputBackgroundColor', 'inputBorderColor', 'inputBorderWidth', 'inputOutlineColor', 'inputOutlineWidth', 'inputSize', 'outerBorderColor', 'outerBorderWidth', 'outerBorderGap', 'inputSize'];
-export const selectRadioButtonTokens = (themeTokens, prefix) => selectTokens(tokenKeys, themeTokens, prefix);
-const getBorderRadius = inputSize => inputSize / 2;
-const selectCheckedStyles = _ref => {
-  let {
-    checkedBackgroundColor,
-    checkedSize
-  } = _ref;
-  return {
-    backgroundColor: checkedBackgroundColor,
-    borderRadius: checkedSize / 2,
-    height: checkedSize,
-    width: checkedSize
-  };
-};
-const selectIconTokens = _ref2 => {
-  let {
-    icon,
-    iconColor,
-    checkedSize
-  } = _ref2;
-  return {
-    icon,
-    color: iconColor,
-    size: checkedSize
-  };
-};
-const selectInputIconStyles = (_ref3, isChecked) => {
-  let {
-    iconBackgroundColor,
-    inputBackgroundColor,
-    inputBorderColor,
-    inputBorderWidth,
-    inputSize,
-    containerShadow
-  } = _ref3;
-  return {
-    borderColor: inputBorderColor,
-    borderRadius: getBorderRadius(inputSize),
-    borderWidth: inputBorderWidth,
-    backgroundColor: isChecked ? iconBackgroundColor : inputBackgroundColor,
-    height: inputSize,
-    width: inputSize,
-    ...applyShadowToken(containerShadow)
-  };
-};
-const selectInputStyles = _ref4 => {
-  let {
-    inputBackgroundColor,
-    inputBorderColor,
-    inputBorderWidth,
-    inputOutlineColor,
-    inputOutlineWidth,
-    inputSize
-  } = _ref4;
-  return {
-    borderColor: inputBorderColor,
-    borderRadius: getBorderRadius(inputSize),
-    borderWidth: inputBorderWidth,
-    backgroundColor: inputBackgroundColor,
-    height: inputSize,
-    width: inputSize,
-    ...Platform.select({
-      web: {
-        outlineStyle: 'solid',
-        outlineColor: inputOutlineColor,
-        outlineWidth: inputOutlineWidth
-      }
-    })
-  };
-};
-const selectOuterBorderStyles = _ref5 => {
-  let {
-    outerBorderColor,
-    outerBorderWidth,
-    outerBorderGap,
-    inputSize
-  } = _ref5;
-  return {
-    ...applyOuterBorder({
-      outerBorderColor,
-      outerBorderWidth,
-      outerBorderGap,
-      borderRadius: getBorderRadius(inputSize)
-    })
-  };
-};
-
-/**
- * The visual toggle of a radio input. Is not interactive on its own, should be used inside
- * an interactive parent that passes down props when interacted with.
- */
-const RadioButton = /*#__PURE__*/React.forwardRef((_ref6, ref) => {
-  let {
-    isChecked,
-    tokens,
-    inactive,
-    defaultChecked,
-    inputId,
-    isControlled,
-    handleChange,
-    name: inputName,
-    value,
-    testID = 'Radio-Checked',
-    ...rest
-  } = _ref6;
-  const radioTokens = useThemeTokens('Radio', tokens, {
-    checked: isChecked
-  });
-  const {
-    icon: IconComponent,
-    ...iconTokens
-  } = selectIconTokens(radioTokens);
-  const themeTokens = validateThemeTokens(resolveThemeTokens(IconComponent ? radioTokens : tokens, {
-    checked: isChecked
-  }), getTokensSetPropType(tokenKeys), 'RadioButton');
-  const getCheckedInput = checked => {
-    if (!checked) return null;
-    if (!IconComponent) {
-      return /*#__PURE__*/_jsx(View, {
-        style: selectCheckedStyles(themeTokens),
-        testID: testID
-      });
-    }
-    return /*#__PURE__*/_jsx(IconComponent, {
-      ...iconTokens
-    });
-  };
-  return /*#__PURE__*/_jsx(View, {
-    style: selectOuterBorderStyles(themeTokens),
-    ...selectProps(rest),
-    children: /*#__PURE__*/_jsxs(View, {
-      style: [staticStyles.defaultInputStyles, IconComponent ? selectInputIconStyles(themeTokens, isChecked) : selectInputStyles(themeTokens)],
-      testID: "Radio-Input",
-      children: [/*#__PURE__*/_jsx(RadioInput, {
-        ref: ref,
-        checked: isChecked,
-        defaultChecked: defaultChecked,
-        disabled: inactive,
-        id: inputId,
-        isControlled: isControlled,
-        onChange: handleChange,
-        name: inputName,
-        value: value
-      }), getCheckedInput(isChecked)]
-    })
-  });
-});
-RadioButton.displayName = 'RadioButton';
-RadioButton.propTypes = {
-  ...selectedSystemPropTypes,
-  isChecked: PropTypes.bool,
-  tokens: getTokensSetPropType(tokenKeys, {
-    allowFunction: true
-  }),
-  inactive: PropTypes.bool,
-  defaultChecked: PropTypes.bool,
-  inputId: PropTypes.string,
-  isControlled: PropTypes.bool,
-  handleChange: PropTypes.func,
-  name: PropTypes.string,
-  value: PropTypes.bool
-};
-const staticStyles = StyleSheet.create({
-  defaultInputStyles: {
-    alignItems: 'center',
-    justifyContent: 'center'
-  }
-});
-export default RadioButton;

package/lib-module/Radio/RadioGroup.js

@@ -1,255 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import ABBPropTypes from 'airbnb-prop-types';
-import { useViewport } from '../ViewportProvider';
-import { useThemeTokens } from '../ThemeProvider';
-import { a11yProps, containUniqueFields, focusHandlerProps, getTokensPropType, selectSystemProps, useInputValue, variantProp, viewProps } from '../utils';
-import { getStackedContent } from '../StackView';
-import Radio from './Radio';
-import Fieldset from '../Fieldset';
-import { jsx as _jsx } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
-const [selectItemProps, selectedItemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, viewProps]);
-
-/**
- * A group of Radios that behave as a radio group. Use when users select a single choice from mutually
- * exclusive options.
- *
- * ## Component API
- *
- * Use the `items` prop to pass an array of objects describing each Radio in the group:
- *
- *  - `label`: main text passed to Radio's `label` prop
- *  - `id`: identifier used to store which Radio is selected (uses `label` 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 RadioGroup manages its own state, you can use `initialCheckedId` prop to provide the initial value.
- * Whenever the radio 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
- *
- * RadioGroup accepts all the common accessibility props, but also sets accessibility role `'radiogroup'`
- * and controls the accessibility state of children like Radio and Feedback based on current state.
- *
- * @example
- * ```jsx
- * <RadioGroup
- *   initialCheckedId="radio1"
- *   items={[
- *     { label: 'Radio 1', id: 'radio1' },
- *     { label: 'Radio 2', id: 'radio2' },
- *     { label: 'Radio 3', id: 'radio3' }
- *   ]}
- *   legend="Radios"
- *   hint="Choose one option"
- * />
- * ```
- */
-const RadioGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    copy = 'en',
-    tokens,
-    radioTokens,
-    variant,
-    items = [],
-    legend,
-    tooltip,
-    hint,
-    hintPosition = 'inline',
-    validation,
-    feedback,
-    initialCheckedId,
-    checkedId,
-    onChange,
-    readOnly,
-    name: inputGroupName,
-    inactive,
-    ...rest
-  } = _ref;
-  const viewport = useViewport();
-
-  /* showIcon passes a boolean to displayIcon
-   */
-  const {
-    space,
-    fieldSpace,
-    showIcon,
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  } = useThemeTokens('RadioGroup', tokens, variant, {
-    viewport
-  });
-  const borderTokens = {
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  };
-  const {
-    currentValue,
-    setValue
-  } = useInputValue({
-    value: checkedId,
-    initialValue: initialCheckedId,
-    onChange,
-    readOnly: readOnly || inactive
-  });
-  const uniqueFields = ['id'];
-  if (!containUniqueFields(items, uniqueFields)) {
-    throw new Error(`RadioGroup items must have unique ${uniqueFields.join(', ')}`);
-  }
-  const radios = items.map((_ref2, index) => {
-    let {
-      label,
-      id,
-      onChange: itemOnChange,
-      ref: itemRef,
-      description,
-      ...itemRest
-    } = _ref2;
-    const radioId = id || `Radio[${index}]`;
-    const isChecked = currentValue === radioId;
-    const handleChange = (newCheckedState, event) => {
-      if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event);
-      if (newCheckedState) setValue(radioId, event);
-    };
-    return /*#__PURE__*/_jsx(Radio, {
-      ref: itemRef,
-      id: radioId,
-      checked: isChecked,
-      onChange: handleChange,
-      inactive: inactive,
-      label: label,
-      name: inputGroupName,
-      tokens: radioTokens,
-      variant: variant,
-      description: description,
-      ...selectItemProps(itemRest)
-    }, radioId);
-  });
-  return /*#__PURE__*/_jsx(Fieldset, {
-    copy: copy,
-    ref: ref,
-    name: inputGroupName,
-    legend: legend,
-    tooltip: tooltip,
-    hint: hint,
-    hintPosition: hintPosition,
-    space: fieldSpace,
-    feedback: feedback,
-    inactive: inactive,
-    validation: validation,
-    showErrorBorder: true,
-    tokens: borderTokens,
-    showIcon: showIcon,
-    accessibilityRole: "radiogroup",
-    ...selectProps(rest),
-    children: getStackedContent(radios, {
-      space,
-      direction: 'column'
-    })
-  });
-});
-RadioGroup.displayName = 'RadioGroup';
-RadioGroup.propTypes = {
-  ...selectedSystemPropTypes,
-  /**
-   * Whether the English or French copy will be used (e.g. for accessibility labels).
-   */
-  copy: PropTypes.oneOf(['en', 'fr']),
-  /**
-   * Optional theme token overrides for the outer RadioGroup component
-   */
-  tokens: getTokensPropType('RadioGroup'),
-  /**
-   * Optional theme token overrides for each inner Radio component
-   */
-  radioTokens: getTokensPropType('Radio'),
-  /**
-   * Theme variants, shared between both RadioGroup and Radio
-   */
-  variant: variantProp.propType,
-  /**
-   * Array of objects containing specifics for each Radio to be rendered in the group.
-   */
-  items: PropTypes.arrayOf(PropTypes.exact({
-    ...selectedItemPropTypes,
-    label: PropTypes.string,
-    id: PropTypes.string,
-    onChange: PropTypes.func,
-    description: PropTypes.string,
-    ref: ABBPropTypes.ref()
-  })),
-  /**
-   * 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,
-  /**
-   * Position of the hint relative to label. Use `below` to display a larger hint below the label.
-   */
-  hintPosition: PropTypes.oneOf(['inline', 'below']),
-  /**
-   * 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 with this id is selected on first render.
-   */
-  initialCheckedId: PropTypes.string,
-  /**
-   * If not undefined, the radio 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 radios cannot be selected by the user and simply show their current state.
-   */
-  readOnly: PropTypes.bool,
-  /**
-   * If true, the radios 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 RadioGroup;

package/lib-module/Radio/RadioInput.js

@@ -1,50 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-
-/**
- * On Web we need to include an actual input but hide it.
- */
-import { jsx as _jsx } from "react/jsx-runtime";
-const RadioInput = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    checked,
-    defaultChecked,
-    disabled = false,
-    id = null,
-    isControlled = false,
-    name,
-    onChange = () => {},
-    value
-  } = _ref;
-  const handleClick = event => {
-    // Cancel the click dispatched via the label tag, since it's already wrapped
-    // in <Pressable>
-    event.preventDefault();
-    event.stopPropagation();
-  };
-  return /*#__PURE__*/_jsx("input", {
-    checked: isControlled ? checked : undefined,
-    defaultChecked: isControlled ? undefined : defaultChecked,
-    disabled: disabled,
-    hidden: true,
-    id: id,
-    name: name,
-    onChange: onChange,
-    onClick: handleClick,
-    ref: ref,
-    type: "radio",
-    value: value
-  });
-});
-RadioInput.displayName = 'Radio';
-RadioInput.propTypes = {
-  checked: PropTypes.bool,
-  defaultChecked: PropTypes.bool,
-  disabled: PropTypes.bool,
-  id: PropTypes.string,
-  isControlled: PropTypes.bool,
-  name: PropTypes.string,
-  onChange: PropTypes.func,
-  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool])
-};
-export default RadioInput;

package/lib-module/Radio/RadioInput.native.js

@@ -1,5 +0,0 @@
-/**
- * There's no radio button input on native platforms, so this is a noop.
- */
-const RadioInput = () => null;
-export default RadioInput;

package/lib-module/Radio/index.js

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

package/lib-module/RadioCard/RadioCard.js

@@ -1,211 +0,0 @@
-import React 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 { applyTextStyles, useTheme, useThemeTokensCallback } from '../ThemeProvider';
-import { a11yProps, focusHandlerProps, 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, focusHandlerProps, 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__*/React.forwardRef((_ref, ref) => {
-  let {
-    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));
-  const {
-    themeOptions
-  } = useTheme();
-  const selectedProps = selectProps({
-    accessibilityRole: 'radio',
-    accessibilityState: {
-      checked: isChecked,
-      disabled: inactive
-    },
-    ...rest
-  });
-  return /*#__PURE__*/_jsx(PressableCardBase, {
-    ref: ref,
-    inactive: inactive,
-    checked: isChecked,
-    tokens: getCardTokens,
-    onPress: handleChange,
-    ...selectedProps,
-    children: cardState => {
-      const {
-        radioSpace,
-        contentSpace,
-        ...themeTokens
-      } = getTokens(cardState);
-      const radioTokens = selectRadioButtonTokens(themeTokens, 'radio');
-      const titleTokens = selectTokens('Typography', themeTokens);
-      const textStyle = applyTextStyles({
-        ...titleTokens,
-        themeOptions
-      });
-      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;