@telus-uds/components-base 2.0.0 → 2.0.1

package/lib-module/Checkbox/Checkbox.js

@@ -1,355 +0,0 @@
-import React, { forwardRef } from 'react';
-import PropTypes from 'prop-types';
-import Platform from "react-native-web/dist/exports/Platform";
-import Pressable from "react-native-web/dist/exports/Pressable";
-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 CheckboxInput from './CheckboxInput';
-import CheckboxLabel from '../InputLabel/LabelContent';
-import Feedback from '../Feedback';
-import StackView from '../StackView';
-import { applyShadowToken, applyTextStyles, useTheme, useThemeTokensCallback } from '../ThemeProvider';
-import { a11yProps, focusHandlerProps, getTokensPropType, selectSystemProps, useInputValue, variantProp, viewProps } from '../utils';
-import useUniqueId from '../utils/useUniqueId';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { jsxs as _jsxs } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, viewProps]);
-
-const selectInputStyles = (_ref, isChecked) => {
-  let {
-    iconBackgroundColor,
-    inputBorderColor,
-    inputBorderRadius,
-    inputBorderWidth,
-    inputBackgroundColor,
-    inputHeight,
-    inputOutlineColor,
-    inputOutlineWidth,
-    inputShadow,
-    inputWidth
-  } = _ref;
-  return {
-    borderColor: inputBorderColor,
-    borderWidth: inputBorderWidth,
-    borderRadius: inputBorderRadius,
-    backgroundColor: isChecked ? iconBackgroundColor : inputBackgroundColor,
-    height: inputHeight,
-    width: inputWidth,
-    ...applyShadowToken(inputShadow),
-    ...Platform.select({
-      web: {
-        outlineStyle: 'solid',
-        outlineColor: inputOutlineColor,
-        outlineWidth: inputOutlineWidth
-      }
-    })
-  };
-};
-
-const selectLabelStyles = (_ref2, themeOptions) => {
-  let {
-    labelColor,
-    labelFontName,
-    labelFontSize,
-    labelFontWeight,
-    labelMarginLeft,
-    labelLineHeight
-  } = _ref2;
-  return {
-    marginLeft: labelMarginLeft,
-    ...applyTextStyles({
-      color: labelColor,
-      fontName: labelFontName,
-      fontWeight: labelFontWeight,
-      fontSize: labelFontSize,
-      lineHeight: labelLineHeight,
-      themeOptions
-    })
-  };
-};
-
-const selectIconTokens = _ref3 => {
-  let {
-    icon,
-    iconColor,
-    iconSize
-  } = _ref3;
-  return {
-    icon,
-    color: iconColor,
-    size: iconSize
-  };
-};
-
-const selectFeedbackTokens = _ref4 => {
-  let {
-    feedbackMarginBottom,
-    feedbackMarginTop,
-    feedbackPosition
-  } = _ref4;
-  return {
-    feedbackPosition,
-    feedbackMarginBottom,
-    feedbackMarginTop
-  };
-};
-/**
- * Basic Checkbox component.
- *
- * ## Component API
- *
- * Use `label` prop to provide a label for the checkbox.
- * For a disabled `Checkbox` set the `inactive` prop to `true`.
- *
- * ### Controlled version
- *
- * If the checkbox is controlled from outside, it needs to receive `checked` and `onChange` props.
- *
- * ### Uncontrolled version
- *
- * In case of uncontrolled checkbox you can use `defaultChecked` prop to provide the initial value.
- * Whenever the checkbox 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 checkbox to be a part of a group of
- * checkboxes on a form.
- *
- * ### Validation and feedback
- *
- * You can use the `feedback` prop to provide a comment related to the checkbox element. If the comment
- * is related to a validation error, the checkbox and the feedback can be styled accordingly by setting
- * the `error` prop to `true` (can also be done without feedback).
- *
- * ## A11y guidelines
- *
- * Checkbox component accepts all the common accessibility props, but also sets some defaults, including
- * accessibility role `'checkbox'` and accessibility state that depends on the other props (`checked`, `inactive`)
- * or the internal state in case of uncontrolled checkbox.
- *
- */
-
-
-const Checkbox = /*#__PURE__*/forwardRef((_ref5, ref) => {
-  let {
-    checked,
-    defaultChecked,
-    error = false,
-    feedback,
-    id,
-    inactive,
-    label,
-    name,
-    onChange,
-    tokens,
-    value,
-    variant,
-    ...rest
-  } = _ref5;
-  const {
-    currentValue: isChecked,
-    setValue: setIsChecked,
-    isControlled
-  } = useInputValue({
-    value: checked,
-    initialValue: defaultChecked,
-    onChange
-  }, 'useCheckboxValue');
-  const getTokens = useThemeTokensCallback('Checkbox', tokens, {
-    checked: isChecked,
-    inactive,
-    error,
-    ...variant
-  });
-  const defaultTokens = getTokens();
-  const {
-    feedbackMarginBottom,
-    feedbackMarginTop,
-    feedbackPosition
-  } = selectFeedbackTokens(defaultTokens);
-  const styles = StyleSheet.create({
-    feedbackContainer: {
-      marginTop: feedbackMarginTop,
-      marginBottom: feedbackMarginBottom
-    }
-  });
-
-  const handleChange = event => {
-    if (!inactive) {
-      setIsChecked(!isChecked, event);
-    }
-  };
-
-  const handleKeyDown = event => {
-    // The expected keyboard shortcut for activating a checkbox is the Space key
-    if ((event === null || event === void 0 ? void 0 : event.key) === ' ') handleChange(event);
-  };
-
-  const uniqueId = useUniqueId('checkbox');
-  const inputId = id !== null && id !== void 0 ? id : uniqueId;
-  const {
-    themeOptions
-  } = useTheme();
-  const selectedProps = selectProps({
-    accessibilityRole: 'checkbox',
-    accessibilityState: {
-      checked: isChecked,
-      disabled: inactive
-    },
-    ...rest
-  });
-  return /*#__PURE__*/_jsx(View, {
-    style: staticStyles.wrapper,
-    ref: ref,
-    children: /*#__PURE__*/_jsxs(StackView, {
-      direction: feedbackPosition === 'top' ? 'column-reverse' : 'column',
-      space: 0,
-      children: [/*#__PURE__*/_jsx(Pressable, {
-        disabled: inactive,
-        onKeyDown: handleKeyDown,
-        onPress: handleChange,
-        ...selectedProps,
-        children: _ref6 => {
-          let {
-            focused: focus,
-            hovered: hover,
-            pressed
-          } = _ref6;
-          const {
-            icon: IconComponent,
-            ...stateTokens
-          } = getTokens({
-            focus,
-            hover,
-            pressed
-          });
-          const iconTokens = selectIconTokens(stateTokens);
-          const labelStyles = selectLabelStyles(stateTokens, themeOptions);
-          const alignWithLabel = label ? [staticStyles.alignWithLabel, {
-            height: labelStyles.lineHeight
-          }] : null;
-          return /*#__PURE__*/_jsxs(View, {
-            style: staticStyles.container,
-            children: [/*#__PURE__*/_jsx(View, {
-              style: alignWithLabel,
-              children: /*#__PURE__*/_jsxs(View, {
-                style: [staticStyles.defaultInputStyles, selectInputStyles(stateTokens, isChecked)],
-                testID: "Checkbox-Input",
-                children: [/*#__PURE__*/_jsx(CheckboxInput, {
-                  checked: isChecked,
-                  defaultChecked: defaultChecked,
-                  disabled: inactive,
-                  id: inputId,
-                  isControlled: isControlled,
-                  name: name,
-                  value: value
-                }), isChecked && IconComponent && /*#__PURE__*/_jsx(View, {
-                  testID: "Checkbox-Icon",
-                  children: /*#__PURE__*/_jsx(IconComponent, { ...iconTokens
-                  })
-                })]
-              })
-            }), Boolean(label) && /*#__PURE__*/_jsx(Text, {
-              style: labelStyles,
-              children: /*#__PURE__*/_jsx(CheckboxLabel, {
-                forId: inputId,
-                children: label
-              })
-            })]
-          });
-        }
-      }), Boolean(feedback) && /*#__PURE__*/_jsx(View, {
-        style: styles.feedbackContainer,
-        children: /*#__PURE__*/_jsx(Feedback, {
-          title: feedback,
-          variant: {
-            icon: error === true
-          },
-          validation: error === true ? 'error' : undefined
-        })
-      })]
-    })
-  });
-});
-Checkbox.displayName = 'Checkbox';
-Checkbox.propTypes = { ...selectedSystemPropTypes,
-
-  /**
-   * 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,
-
-  /**
-   * A detailed description of related validation error or additional instructions (depending on the `error` prop).
-   */
-  feedback: PropTypes.string,
-
-  /**
-   * Checkbox ID.
-   */
-  id: PropTypes.string,
-
-  /**
-   * Whether the corresponding input is disabled or active.
-   */
-  inactive: PropTypes.bool,
-
-  /**
-   * The label.
-   */
-  label: PropTypes.string,
-
-  /**
-   * Associate this checkbox 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 gets interacted with.
-   */
-  onChange: PropTypes.func,
-
-  /**
-   * Checkbox tokens.
-   */
-  tokens: getTokensPropType('Checkbox'),
-
-  /**
-   * Checkbox variant.
-   */
-  variant: variantProp.propType
-};
-export default Checkbox;
-const staticStyles = StyleSheet.create({
-  wrapper: {
-    backgroundColor: 'transparent'
-  },
-  container: {
-    flexDirection: 'row',
-    alignItems: 'center'
-  },
-  defaultInputStyles: {
-    alignItems: 'center',
-    justifyContent: 'center'
-  },
-  alignWithLabel: {
-    alignSelf: 'flex-start',
-    justifyContent: 'center'
-  }
-});

package/lib-module/Checkbox/CheckboxGroup.js

@@ -1,242 +0,0 @@
-import React, { forwardRef } 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__*/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
-  } = useThemeTokens('CheckboxGroup', tokens, variant, {
-    viewport
-  });
-  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 ".concat(uniqueFields.join(', ')));
-  }
-
-  const checkboxes = items.map((_ref2, index) => {
-    let {
-      label,
-      id,
-      onChange: itemOnChange,
-      ref: itemRef,
-      ...itemRest
-    } = _ref2;
-    const checkboxId = id || "Checkbox[".concat(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,
-    showIcon: true,
-    showErrorBorder: true,
-    ...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,60 +0,0 @@
-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 CheckboxInput = /*#__PURE__*/forwardRef((_ref, ref) => {
-  let {
-    checked,
-    defaultChecked,
-    disabled,
-    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
-};
-CheckboxInput.defaultProps = {
-  checked: undefined,
-  defaultChecked: undefined,
-  disabled: false,
-  name: undefined,
-  onChange: () => {},
-  value: undefined
-};
-export default CheckboxInput;

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

@@ -1,6 +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';