@telus-uds/components-base 1.65.0 → 1.67.0

package/lib-module/Radio/RadioGroup.js

@@ -10,6 +10,7 @@ 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.
@@ -58,7 +59,6 @@ const [selectItemProps, selectedItemPropTypes] = selectSystemProps([a11yProps, f
  * />
  * ```
  */
-
 const RadioGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
   let {
     copy = 'en',
@@ -81,9 +81,9 @@ const RadioGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
     ...rest
   } = _ref;
   const viewport = useViewport();
+
   /* showIcon passes a boolean to displayIcon
    */
-
   const {
     space,
     fieldSpace,
@@ -115,11 +115,9 @@ const RadioGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
     readOnly: readOnly || inactive
   });
   const uniqueFields = ['id', 'label'];
-
   if (!containUniqueFields(items, uniqueFields)) {
     throw new Error(`RadioGroup items must have unique ${uniqueFields.join(', ')}`);
   }
-
   const radios = items.map((_ref2, index) => {
     let {
       label,
@@ -131,12 +129,10 @@ const RadioGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
     } = _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,
@@ -175,97 +171,82 @@ const RadioGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
   });
 });
 RadioGroup.displayName = 'RadioGroup';
-RadioGroup.propTypes = { ...selectedSystemPropTypes,
-
+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,
+  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.
    */

package/lib-module/Radio/RadioInput.js

@@ -1,9 +1,9 @@
 import React, { forwardRef } 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__*/forwardRef((_ref, ref) => {
   let {
@@ -16,14 +16,12 @@ const RadioInput = /*#__PURE__*/forwardRef((_ref, ref) => {
     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,

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

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

package/lib-module/RadioCard/RadioCard.js

@@ -11,6 +11,7 @@ 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.
@@ -46,7 +47,6 @@ const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, foc
  * 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((_ref, ref) => {
   let {
     tokens,
@@ -71,19 +71,15 @@ const RadioCard = /*#__PURE__*/forwardRef((_ref, ref) => {
     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();
@@ -110,7 +106,8 @@ const RadioCard = /*#__PURE__*/forwardRef((_ref, ref) => {
       } = getTokens(cardState);
       const radioTokens = selectRadioButtonTokens(themeTokens, 'radio');
       const titleTokens = selectTokens('Typography', themeTokens);
-      const textStyle = applyTextStyles({ ...titleTokens,
+      const textStyle = applyTextStyles({
+        ...titleTokens,
         themeOptions
       });
       return /*#__PURE__*/_jsxs(StackView, {
@@ -147,73 +144,60 @@ const RadioCard = /*#__PURE__*/forwardRef((_ref, ref) => {
   });
 });
 RadioCard.displayName = 'RadioCard';
-RadioCard.propTypes = { ...selectedSystemPropTypes,
-
+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.
    */

package/lib-module/RadioCard/RadioCardGroup.js

@@ -9,6 +9,7 @@ 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 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
@@ -59,7 +60,6 @@ const [selectItemProps, selectedItemPropTypes] = selectSystemProps([a11yProps, f
  * />
  * ```
  */
-
 const RadioCardGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
   let {
     copy = 'en',
@@ -98,16 +98,15 @@ const RadioCardGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
     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,
+  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.
 
   const uniqueFields = ['id'];
-
   if (!containUniqueFields(items, uniqueFields)) {
     throw new Error(`RadioCardGroup items must have unique ${uniqueFields.join(', ')}`);
   }
-
   return /*#__PURE__*/_jsx(Fieldset, {
     copy: copy,
     ref: ref,
@@ -136,12 +135,10 @@ const RadioCardGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
           ...itemRest
         } = _ref2;
         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,
@@ -161,96 +158,81 @@ const RadioCardGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
   });
 });
 RadioCardGroup.displayName = 'RadioCardGroup';
-RadioCardGroup.propTypes = { ...selectedSystemPropTypes,
-
+RadioCardGroup.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 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({ ...selectedItemPropTypes,
+  items: PropTypes.arrayOf(PropTypes.exact({
+    ...selectedItemPropTypes,
     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,
-
   /**
    * 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 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.
    */

package/lib-module/Responsive/Responsive.js

@@ -2,6 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { viewports } from '@telus-uds/system-constants';
 import { useResponsiveProp } from '../utils';
+
 /**
  * Responsive conditionally renders children based on whether the viewport matches the provided
  * min and max viewports.
@@ -10,10 +11,8 @@ import { useResponsiveProp } from '../utils';
  * during first hydration on the client side; then if the viewport is not `xs`, it re-renders
  * after hydration. This may cause a layout shift on devices other than the narrowest.
  */
-
 import { Fragment as _Fragment } from "react/jsx-runtime";
 import { jsx as _jsx } from "react/jsx-runtime";
-
 const Responsive = _ref => {
   let {
     min = 'xs',
@@ -24,25 +23,21 @@ const Responsive = _ref => {
   const byViewports = {
     [min]: children
   };
-
   if (max && max !== 'xl') {
     // Stop returning children at the viewport one above 'max' or greater
     const maxIndex = viewports.keys.indexOf(max);
     const maxPlusOne = maxIndex >= 0 ? viewports.keys[maxIndex + 1] : null;
     if (maxPlusOne) byViewports[maxPlusOne] = null;
   }
-
   return /*#__PURE__*/_jsx(_Fragment, {
     children: useResponsiveProp(byViewports, null)
   });
 };
-
 Responsive.propTypes = {
   /**
    * To hide children of `Responsive` if the current viewport is smaller than `min`
    */
   min: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', 'xl']),
-
   /**
    * To hide children of `Responsive` if the current viewport is larger than `max`
    */

package/lib-module/Search/Search.js

@@ -10,7 +10,6 @@ import dictionary from './dictionary';
 import { jsx as _jsx } from "react/jsx-runtime";
 const [selectContainerProps, selectedContainerPropTypes] = selectSystemProps([a11yProps, viewProps]);
 const [selectInputProps, selectedInputPropTypes] = selectSystemProps([textInputHandlerProps, textInputProps]);
-
 const selectInputTokens = _ref => {
   let {
     searchTokens,
@@ -29,13 +28,12 @@ const selectInputTokens = _ref => {
   } = buttonTokens;
   const buttonWidth = paddingLeft + paddingRight + iconSize;
   const paddingWithButtons = inputPaddingRight + (submitButtonIcon ? buttonWidth : 0) + (clearButtonIcon ? buttonsGapSize + buttonWidth : 0);
-  return { ...selectTokens('TextInput', searchTokens),
+  return {
+    ...selectTokens('TextInput', searchTokens),
     paddingRight: paddingWithButtons
   };
 };
-
 const selectButtonTokens = tokens => selectTokens('Button', tokens);
-
 const selectIconTokens = _ref2 => {
   let {
     iconSize,
@@ -46,6 +44,7 @@ const selectIconTokens = _ref2 => {
     size: iconSize
   };
 };
+
 /**
  * The `Search` component is a combination of a `TextInput` and 2 different kinds of custom buttons.
  * Use `Search` to feature autocomplete interactions.
@@ -59,8 +58,6 @@ const selectIconTokens = _ref2 => {
  * Use the following props to supply additional accessibility labels for the input - `accessibilityLabel`,
  * clear button - `clearButtonAccessibilityLabel`, and submit button - `submitButtonAccessibilityLabel`.
  */
-
-
 const Search = /*#__PURE__*/forwardRef((_ref3, ref) => {
   let {
     initialValue,
@@ -92,8 +89,9 @@ const Search = /*#__PURE__*/forwardRef((_ref3, ref) => {
   });
   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 getButtonTokens = useThemeTokensCallback('SearchButton', tokens, variant);
 
+  // TODO: support overriding the a11y props using a custom dictionary
   const getCopy = useCopy({
     dictionary,
     copy
@@ -103,39 +101,37 @@ const Search = /*#__PURE__*/forwardRef((_ref3, ref) => {
     buttonsGap,
     clearButtonIcon: ClearButtonIcon,
     submitButtonIcon: SubmitButtonIcon
-  } = themeTokens; // get the actual gap value for the current viewport
+  } = 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 => {
     var _ref$current;
-
     setValue('', event);
     onClear === null || onClear === void 0 ? void 0 : onClear('', event);
     ref === null || ref === void 0 ? void 0 : (_ref$current = ref.current) === null || _ref$current === void 0 ? void 0 : _ref$current.focus();
   };
-
   const handleFocus = event => {
     if (onFocus !== undefined) onFocus(event);
   };
+  const isEmpty = currentValue === '';
 
-  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
-
+  // 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 ?? a11yLabelText;
   const {
     nativeID,
     testID,
     ...containerProps
   } = selectContainerProps(rest);
-  return /*#__PURE__*/_jsx(View, { ...containerProps,
+  return /*#__PURE__*/_jsx(View, {
+    ...containerProps,
     children: /*#__PURE__*/_jsx(TextInputBase, {
       nativeID: nativeID,
       testID: testID,
@@ -163,18 +159,22 @@ const Search = /*#__PURE__*/forwardRef((_ref3, ref) => {
         inactive: inactive,
         onPress: handleClear,
         tokens: appearances => selectButtonTokens(getButtonTokens(appearances)),
-        children: buttonState => /*#__PURE__*/_jsx(ClearButtonIcon, { ...selectIconTokens(getButtonTokens(buttonState))
+        children: buttonState => /*#__PURE__*/_jsx(ClearButtonIcon, {
+          ...selectIconTokens(getButtonTokens(buttonState))
         })
       }, "clear"), SubmitButtonIcon && /*#__PURE__*/_jsx(ButtonBase, {
         accessibilityLabel: getCopy('submitButtonAccessibilityLabel'),
         accessibilityRole: "button",
         inactive: inactive,
         onPress: handleSubmit,
-        tokens: buttonState => selectButtonTokens(getButtonTokens({ ...buttonState,
+        tokens: buttonState => selectButtonTokens(getButtonTokens({
+          ...buttonState,
           priority: 'high'
         })),
         nativeID: nativeSubmitBtnID,
-        children: buttonState => /*#__PURE__*/_jsx(SubmitButtonIcon, { ...selectIconTokens(getButtonTokens({ ...buttonState,
+        children: buttonState => /*#__PURE__*/_jsx(SubmitButtonIcon, {
+          ...selectIconTokens(getButtonTokens({
+            ...buttonState,
             priority: 'high'
           }))
         })
@@ -183,54 +183,46 @@ const Search = /*#__PURE__*/forwardRef((_ref3, ref) => {
   });
 });
 Search.displayName = 'Search';
-Search.propTypes = { ...selectedContainerPropTypes,
+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.
@@ -242,7 +234,6 @@ Search.propTypes = { ...selectedContainerPropTypes,
   })]),
   tokens: getTokensPropType('Search'),
   variant: variantProp.propType,
-
   /**
    * ID for Submit button element on web
    */