@telus-uds/components-base 1.96.0 → 1.97.1

package/lib-module/Checkbox/CheckboxGroup.js

@@ -1,240 +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, useMultipleInputValues, variantProp, viewProps } from '../utils';
-import { getStackedContent } from '../StackView';
-import Checkbox from './Checkbox';
-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 Checkboxs that behave as a fieldset. Use when users select any number of choices from options.
- *
- * ## Component API
- *
- * Use the `items` prop to pass an array of objects describing each Checkbox in the group:
- *
- *  - `label`: main text passed to CheckboxGroup's `label` prop
- *  - `id`: identifier used to store which CheckboxGroup 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 CheckboxGroup 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
- *
- * CheckboxGroup accepts all the common accessibility props, and controls the accessibility state
- * of children like Checkbox and Feedback based on current state.
- *
- * @example
- * ```jsx
- * <CheckboxGroup
- *   initialCheckedIds="check1"
- *   items={[
- *     { label: 'Checkbox 1', id: 'check1' },
- *     { label: 'Checkbox 2', id: 'check2' },
- *     { label: 'Checkbox 3', id: 'check3' }
- *   ]}
- *   legend="Checkboxes"
- *   hint="Choose from these options"
- * />
- * ```
- */
-const CheckboxGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    tokens,
-    radioTokens,
-    variant,
-    items = [],
-    legend,
-    tooltip,
-    hint,
-    hintPosition = 'inline',
-    validation,
-    feedback,
-    initialCheckedIds,
-    checkedIds,
-    onChange,
-    readOnly,
-    name: inputGroupName,
-    inactive,
-    ...rest
-  } = _ref;
-  const viewport = useViewport();
-  const {
-    space,
-    fieldSpace,
-    showIcon,
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  } = useThemeTokens('CheckboxGroup', tokens, variant, {
-    viewport
-  });
-  const borderTokens = {
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  };
-  const {
-    currentValues,
-    toggleOneValue
-  } = useMultipleInputValues({
-    values: checkedIds,
-    initialValues: initialCheckedIds,
-    onChange,
-    readOnly: readOnly || inactive
-  });
-  const uniqueFields = ['id', 'label'];
-  if (!containUniqueFields(items, uniqueFields)) {
-    throw new Error(`CheckboxGroup items must have unique ${uniqueFields.join(', ')}`);
-  }
-  const checkboxes = items.map((_ref2, index) => {
-    let {
-      label,
-      id,
-      onChange: itemOnChange,
-      ref: itemRef,
-      ...itemRest
-    } = _ref2;
-    const checkboxId = id || `Checkbox[${index}]`;
-    const handleChange = (newCheckedState, event) => {
-      if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event);
-      toggleOneValue(checkboxId, event);
-    };
-    return /*#__PURE__*/_jsx(Checkbox, {
-      ref: itemRef,
-      id: checkboxId,
-      checked: currentValues.includes(checkboxId),
-      onChange: handleChange,
-      inactive: inactive,
-      label: label,
-      name: inputGroupName,
-      tokens: radioTokens,
-      variant: variant,
-      ...selectItemProps(itemRest)
-    }, checkboxId);
-  });
-  return /*#__PURE__*/_jsx(Fieldset, {
-    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,
-    ...selectProps(rest),
-    children: getStackedContent(checkboxes, {
-      space,
-      direction: 'column'
-    })
-  });
-});
-CheckboxGroup.displayName = 'CheckboxGroup';
-CheckboxGroup.propTypes = {
-  ...selectedSystemPropTypes,
-  /**
-   * Optional theme token overrides for the outer CheckboxGroup component
-   */
-  tokens: getTokensPropType('CheckboxGroup'),
-  /**
-   * Optional theme token overrides for each inner Checkbox component
-   */
-  radioTokens: getTokensPropType('Checkbox'),
-  /**
-   * Theme variants, shared between both CheckboxGroup and Checkbox
-   */
-  variant: variantProp.propType,
-  /**
-   * Array of objects containing specifics for each Checkbox to be rendered in the group.
-   */
-  items: PropTypes.arrayOf(PropTypes.exact({
-    ...selectedItemPropTypes,
-    label: PropTypes.string,
-    id: PropTypes.string,
-    onChange: PropTypes.func,
-    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 checkboxed with this ids are selected on first render.
-   */
-  initialCheckedIds: PropTypes.arrayOf(PropTypes.string),
-  /**
-   * If not undefined, the checkboxes with these ids is selected, and the
-   * element's selection state will be controlled by its parent using the `onChange` function.
-   */
-  checkedIds: PropTypes.arrayOf(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 checkboxes cannot be selected by the user and simply show their current state.
-   */
-  readOnly: PropTypes.bool,
-  /**
-   * If true, the checkboxes 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 checkbox input.
-   */
-  name: PropTypes.string
-};
-export default CheckboxGroup;

package/lib-module/Checkbox/CheckboxInput.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 CheckboxInput = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    checked,
-    defaultChecked,
-    disabled = false,
-    id,
-    isControlled,
-    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: "checkbox",
-    value: value
-  });
-});
-CheckboxInput.displayName = 'CheckboxInput';
-CheckboxInput.propTypes = {
-  checked: PropTypes.bool,
-  defaultChecked: PropTypes.bool,
-  disabled: PropTypes.bool,
-  id: PropTypes.string.isRequired,
-  isControlled: PropTypes.bool.isRequired,
-  name: PropTypes.string,
-  onChange: PropTypes.func,
-  value: PropTypes.string
-};
-export default CheckboxInput;

package/lib-module/Checkbox/CheckboxInput.native.js

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

package/lib-module/Checkbox/index.js

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

package/lib-module/CheckboxCard/CheckboxCard.js

@@ -1,183 +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 CheckboxButton, { selectCheckboxTokens } from '../Checkbox/CheckboxButton';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { jsxs as _jsxs } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, viewProps]);
-const CheckboxCard = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    tokens,
-    variant,
-    title,
-    children,
-    inactive,
-    defaultChecked,
-    checked,
-    name: inputName,
-    value,
-    id,
-    iconId,
-    onChange,
-    ...rest
-  } = _ref;
-  const {
-    currentValue: isChecked,
-    setValue: setIsChecked,
-    isControlled
-  } = useInputValue({
-    value: checked,
-    initialValue: defaultChecked,
-    onChange
-  });
-  const handleChange = event => {
-    if (!inactive) {
-      setIsChecked(!isChecked, event);
-    }
-  };
-  const uniqueId = useUniqueId('CheckboxCard');
-  const inputId = id ?? uniqueId;
-  const uniqueIconId = useUniqueId('CheckboxIcon');
-  const iconCheckboxId = iconId ?? uniqueIconId;
-  const getTokens = useThemeTokensCallback('CheckboxCard', tokens, variant);
-  const getCardTokens = cardState => selectPressableCardTokens(getTokens(cardState));
-  const {
-    themeOptions
-  } = useTheme();
-  const selectedProps = selectProps({
-    accessibilityRole: 'checkbox',
-    accessibilityState: {
-      checked: isChecked,
-      disabled: inactive
-    },
-    ...rest
-  });
-  return /*#__PURE__*/_jsx(PressableCardBase, {
-    ref: ref,
-    inactive: inactive,
-    checked: isChecked,
-    tokens: getCardTokens,
-    onPress: handleChange,
-    ...selectedProps,
-    children: cardState => {
-      const {
-        checkboxSpace,
-        contentSpace,
-        ...themeTokens
-      } = getTokens(cardState);
-      const checkboxTokens = selectCheckboxTokens(themeTokens, 'checkbox');
-      const titleTokens = selectTokens('Typography', themeTokens);
-      const textStyle = applyTextStyles({
-        ...titleTokens,
-        themeOptions
-      });
-      return /*#__PURE__*/_jsxs(StackView, {
-        direction: "row",
-        space: checkboxSpace,
-        children: [/*#__PURE__*/_jsx(View, {
-          style: [staticStyles.alignWithText, {
-            height: textStyle.lineHeight
-          }],
-          children: /*#__PURE__*/_jsx(CheckboxButton, {
-            tokens: checkboxTokens,
-            isControlled: isControlled,
-            isChecked: isChecked,
-            inactive: inactive,
-            defaultChecked: defaultChecked,
-            inputId: inputId,
-            iconId: iconCheckboxId,
-            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
-          }) : null, typeof children === 'function' ? children(cardState, textStyle) : children]
-        })]
-      });
-    }
-  });
-});
-CheckboxCard.displayName = 'CheckboxCard';
-CheckboxCard.propTypes = {
-  ...selectedSystemPropTypes,
-  /**
-   * Content to be displayed at the top of the card alongside the checkbox
-   */
-  title: PropTypes.string,
-  /**
-   * Additional content to be displayed below the checkbox.
-   */
-  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  /**
-   * Use `checked` for controlled checkbox. For uncontrolled checkbox, use the `defaultChecked` prop.
-   */
-  checked: PropTypes.bool,
-  /**
-   * Use `defaultChecked` to provide the initial value for an uncontrolled checkbox.
-   */
-  defaultChecked: PropTypes.bool,
-  /**
-   * An optional checkboxdescription.
-   */
-  description: PropTypes.string,
-  /**
-   * Checkbox card ID.
-   */
-  id: PropTypes.string,
-  /**
-   * Checkbox icon ID.
-   */
-  iconId: PropTypes.string,
-  /**
-   * Whether the corresponding input is disabled or active.
-   */
-  inactive: PropTypes.bool,
-  /**
-   * The label.
-   */
-  label: PropTypes.string,
-  /**
-   * Associate this checkbox 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 checkbox card gets interacted with.
-   */
-  onChange: PropTypes.func,
-  /**
-   * checkbox card tokens.
-   */
-  tokens: getTokensPropType('CheckboxCard'),
-  /**
-   * checkbox variant.
-   */
-  variant: variantProp.propType
-};
-export default CheckboxCard;
-const staticStyles = StyleSheet.create({
-  alignWithText: {
-    justifyContent: 'center'
-  }
-});

package/lib-module/CheckboxCard/index.js

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

package/lib-module/CheckboxCardGroup/CheckboxCardGroup.js

@@ -1,206 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { useViewport } from '../ViewportProvider';
-import { useThemeTokens } from '../ThemeProvider';
-import { a11yProps, containUniqueFields, focusHandlerProps, getTokensPropType, selectSystemProps, useMultipleInputValues, variantProp, viewProps } from '../utils';
-import StackView, { StackWrap } from '../StackView';
-import CheckboxCard from '../CheckboxCard';
-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]);
-const CheckboxCardGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
-  let {
-    copy = 'en',
-    tokens,
-    checkboxCardTokens,
-    variant,
-    items = [],
-    legend,
-    tooltip,
-    hint,
-    hintPosition = 'inline',
-    validation,
-    feedback,
-    initialCheckedIds,
-    checkedIds,
-    onChange,
-    readOnly,
-    name: inputGroupName,
-    inactive,
-    ...rest
-  } = _ref;
-  const viewport = useViewport();
-  const {
-    space,
-    fieldSpace,
-    direction,
-    showIcon,
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  } = useThemeTokens('CheckboxCardGroup', tokens, variant, {
-    viewport
-  });
-  const borderTokens = {
-    outlineWidth,
-    borderTopLeftRadius,
-    borderTopRightRadius,
-    borderBottomLeftRadius,
-    borderBottomRightRadius,
-    outlineOffset
-  };
-  const {
-    currentValues,
-    toggleOneValue
-  } = useMultipleInputValues({
-    value: checkedIds,
-    initialValues: initialCheckedIds,
-    onChange,
-    readOnly: readOnly || inactive
-  });
-  const StackContainer = direction === 'row' ? StackWrap : StackView;
-  // Needs 'checkboxgroup' role on direct parent of checkboxes for MacOS Voiceover's numbering to work,
-  // and also needs 'checkboxgroup' 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(`CheckboxCardGroup items must have unique ${uniqueFields.join(', ')}`);
-  }
-  return /*#__PURE__*/_jsx(Fieldset, {
-    copy: copy,
-    ref: ref,
-    name: inputGroupName,
-    legend: legend,
-    tooltip: tooltip,
-    hint: hint,
-    hintPosition: hintPosition,
-    space: fieldSpace,
-    feedback: feedback,
-    inactive: inactive || readOnly,
-    validation: validation,
-    tokens: borderTokens,
-    showErrorBorder: true,
-    showIcon: showIcon,
-    accessibilityRole: "checkbox",
-    ...selectProps(rest),
-    children: checkboxCardProperties => /*#__PURE__*/_jsx(StackContainer, {
-      space: space,
-      accessibilityRole: "checkbox",
-      children: items.map((_ref2, index) => {
-        let {
-          title,
-          content,
-          id,
-          onChange: itemOnChange,
-          ...itemRest
-        } = _ref2;
-        const cardId = id || `CheckboxCard[${index}]`;
-        const handleChange = (newCheckedState, event) => {
-          if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event);
-          toggleOneValue(cardId, event);
-        };
-        return /*#__PURE__*/_jsx(CheckboxCard, {
-          id: cardId,
-          checked: currentValues.includes(cardId),
-          onChange: handleChange,
-          inactive: inactive,
-          title: title,
-          name: inputGroupName,
-          tokens: checkboxCardTokens,
-          variant: variant,
-          readOnly: readOnly,
-          ...selectItemProps(itemRest),
-          ...checkboxCardProperties,
-          children: content
-        }, cardId);
-      })
-    })
-  });
-});
-CheckboxCardGroup.displayName = 'CheckboxCardGroup';
-CheckboxCardGroup.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 CheckboxCardGroup component
-   */
-  tokens: getTokensPropType('CheckboxCardGroup'),
-  /**
-   * Optional theme token overrides for each inner CheckboxCard component
-   */
-  checkboxCardTokens: getTokensPropType('CheckboxCard'),
-  /**
-   * Theme variants, shared between both CheckboxCardGroup and CheckboxCard
-   */
-  variant: variantProp.propType,
-  /**
-   * Array of objects containing specifics for each CheckboxCard to be rendered in the group.
-   */
-  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 checkboxed with this ids are selected on first render.
-   */
-  initialCheckedIds: PropTypes.arrayOf(PropTypes.string),
-  /**
-   * If not undefined, the checkboxes with these ids is selected, and the
-   * element's selection state will be controlled by its parent using the `onChange` function.
-   */
-  checkedIds: PropTypes.arrayOf(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 checkbox cards cannot be selected by the user and simply show their current state.
-   */
-  readOnly: PropTypes.bool,
-  /**
-   * If true, the checkbox 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 checkbox input.
-   */
-  name: PropTypes.string
-};
-export default CheckboxCardGroup;

package/lib-module/CheckboxCardGroup/index.js

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