@telus-uds/components-base 2.4.0 → 3.0.0

package/lib/cjs/Checkbox/CheckboxGroup.js

@@ -0,0 +1,249 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _airbnbPropTypes = _interopRequireDefault(require("airbnb-prop-types"));
+var _ViewportProvider = require("../ViewportProvider");
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _StackView = require("../StackView");
+var _Checkbox = _interopRequireDefault(require("./Checkbox"));
+var _Fieldset = _interopRequireDefault(require("../Fieldset"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.viewProps]);
+const [selectItemProps, selectedItemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.focusHandlerProps, _utils.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.default.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 = (0, _ViewportProvider.useViewport)();
+  const {
+    space,
+    fieldSpace,
+    showIcon,
+    outlineWidth,
+    borderTopLeftRadius,
+    borderTopRightRadius,
+    borderBottomLeftRadius,
+    borderBottomRightRadius,
+    outlineOffset
+  } = (0, _ThemeProvider.useThemeTokens)('CheckboxGroup', tokens, variant, {
+    viewport
+  });
+  const borderTokens = {
+    outlineWidth,
+    borderTopLeftRadius,
+    borderTopRightRadius,
+    borderBottomLeftRadius,
+    borderBottomRightRadius,
+    outlineOffset
+  };
+  const {
+    currentValues,
+    toggleOneValue
+  } = (0, _utils.useMultipleInputValues)({
+    values: checkedIds,
+    initialValues: initialCheckedIds,
+    onChange,
+    readOnly: readOnly || inactive
+  });
+  const uniqueFields = ['id', 'label'];
+  if (!(0, _utils.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,
+      inactive: itemInactive,
+      ...itemRest
+    } = _ref2;
+    const checkboxId = id || `Checkbox[${index}]`;
+    const handleChange = (newCheckedState, event) => {
+      if (typeof itemOnChange === 'function') itemOnChange(newCheckedState, event);
+      toggleOneValue(checkboxId, event);
+    };
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Checkbox.default, {
+      ref: itemRef,
+      id: checkboxId,
+      checked: currentValues.includes(checkboxId),
+      onChange: handleChange,
+      inactive: itemInactive,
+      label: label,
+      name: inputGroupName,
+      tokens: radioTokens,
+      variant: variant,
+      ...selectItemProps(itemRest)
+    }, checkboxId);
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Fieldset.default, {
+    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: (0, _StackView.getStackedContent)(checkboxes, {
+      space,
+      direction: 'column'
+    })
+  });
+});
+CheckboxGroup.displayName = 'CheckboxGroup';
+CheckboxGroup.propTypes = {
+  ...selectedSystemPropTypes,
+  /**
+   * Optional theme token overrides for the outer CheckboxGroup component
+   */
+  tokens: (0, _utils.getTokensPropType)('CheckboxGroup'),
+  /**
+   * Optional theme token overrides for each inner Checkbox component
+   */
+  radioTokens: (0, _utils.getTokensPropType)('Checkbox'),
+  /**
+   * Theme variants, shared between both CheckboxGroup and Checkbox
+   */
+  variant: _utils.variantProp.propType,
+  /**
+   * Array of objects containing specifics for each Checkbox to be rendered in the group.
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.exact({
+    ...selectedItemPropTypes,
+    label: _propTypes.default.string,
+    id: _propTypes.default.string,
+    onChange: _propTypes.default.func,
+    ref: _airbnbPropTypes.default.ref(),
+    inactive: _propTypes.default.bool
+  })),
+  /**
+   * Main text used to describe this group, used in Fieldset's Legend element.
+   */
+  legend: _propTypes.default.string,
+  /**
+   * Optional additional text giving more detail to help a user make a choice.
+   */
+  hint: _propTypes.default.string,
+  /**
+   * Position of the hint relative to label. Use `below` to display a larger hint below the label.
+   */
+  hintPosition: _propTypes.default.oneOf(['inline', 'below']),
+  /**
+   * Optional tooltip text content to include alongside the legend and hint.
+   */
+  tooltip: _propTypes.default.string,
+  /**
+   * Current validation status of the group, passed to the feedback element if there is one.
+   */
+  validation: _propTypes.default.oneOf(['error', 'success']),
+  /**
+   * If provided, a Feedback element is rendered containing this text.
+   */
+  feedback: _propTypes.default.string,
+  /**
+   * If provided, the checkboxed with this ids are selected on first render.
+   */
+  initialCheckedIds: _propTypes.default.arrayOf(_propTypes.default.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.default.arrayOf(_propTypes.default.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.default.func,
+  /**
+   * If true, the checkboxes cannot be selected by the user and simply show their current state.
+   */
+  readOnly: _propTypes.default.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.default.bool,
+  /**
+   * On Web, this is passed to the `name` attribute of the fieldset and each checkbox input.
+   */
+  name: _propTypes.default.string
+};
+var _default = exports.default = CheckboxGroup;

package/lib/cjs/Checkbox/CheckboxInput.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * On Web we need to include an actual input but hide it.
+ */const CheckboxInput = /*#__PURE__*/_react.default.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__*/(0, _jsxRuntime.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.default.bool,
+  defaultChecked: _propTypes.default.bool,
+  disabled: _propTypes.default.bool,
+  id: _propTypes.default.string.isRequired,
+  isControlled: _propTypes.default.bool.isRequired,
+  name: _propTypes.default.string,
+  onChange: _propTypes.default.func,
+  value: _propTypes.default.string
+};
+var _default = exports.default = CheckboxInput;

package/lib/cjs/Checkbox/CheckboxInput.native.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * There's no checkbox input on native platforms, so this is a noop.
+ */
+const CheckboxInput = () => null;
+var _default = exports.default = CheckboxInput;

package/lib/cjs/Checkbox/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "CheckboxGroup", {
+  enumerable: true,
+  get: function () {
+    return _CheckboxGroup.default;
+  }
+});
+exports.default = void 0;
+var _Checkbox = _interopRequireDefault(require("./Checkbox"));
+var _CheckboxGroup = _interopRequireDefault(require("./CheckboxGroup"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _default = exports.default = _Checkbox.default;

package/lib/cjs/CheckboxCard/CheckboxCard.js

@@ -0,0 +1,191 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+var _Text = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Text"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _Card = require("../Card");
+var _StackView = _interopRequireDefault(require("../StackView"));
+var _CheckboxButton = _interopRequireWildcard(require("../Checkbox/CheckboxButton"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.focusHandlerProps, _utils.viewProps]);
+const CheckboxCard = /*#__PURE__*/_react.default.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
+  } = (0, _utils.useInputValue)({
+    value: checked,
+    initialValue: defaultChecked,
+    onChange
+  });
+  const handleChange = event => {
+    if (!inactive) {
+      setIsChecked(!isChecked, event);
+    }
+  };
+  const uniqueId = (0, _utils.useUniqueId)('CheckboxCard');
+  const inputId = id ?? uniqueId;
+  const uniqueIconId = (0, _utils.useUniqueId)('CheckboxIcon');
+  const iconCheckboxId = iconId ?? uniqueIconId;
+  const getTokens = (0, _ThemeProvider.useThemeTokensCallback)('CheckboxCard', tokens, variant);
+  const getCardTokens = cardState => (0, _Card.selectPressableCardTokens)(getTokens(cardState));
+  const {
+    themeOptions
+  } = (0, _ThemeProvider.useTheme)();
+  const selectedProps = selectProps({
+    accessibilityRole: 'checkbox',
+    accessibilityState: {
+      checked: isChecked,
+      disabled: inactive
+    },
+    ...rest
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Card.PressableCardBase, {
+    ref: ref,
+    inactive: inactive,
+    checked: isChecked,
+    tokens: getCardTokens,
+    onPress: handleChange,
+    ...selectedProps,
+    children: cardState => {
+      const {
+        checkboxSpace,
+        contentSpace,
+        ...themeTokens
+      } = getTokens(cardState);
+      const checkboxTokens = (0, _CheckboxButton.selectCheckboxTokens)(themeTokens, 'checkbox');
+      const titleTokens = (0, _utils.selectTokens)('Typography', themeTokens);
+      const textStyle = (0, _ThemeProvider.applyTextStyles)({
+        ...titleTokens,
+        themeOptions
+      });
+      return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_StackView.default, {
+        direction: "row",
+        space: checkboxSpace,
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          style: [staticStyles.alignWithText, {
+            height: textStyle.lineHeight
+          }],
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_CheckboxButton.default, {
+            tokens: checkboxTokens,
+            isControlled: isControlled,
+            isChecked: isChecked,
+            inactive: inactive,
+            defaultChecked: defaultChecked,
+            inputId: inputId,
+            iconId: iconCheckboxId,
+            handleChange: handleChange,
+            name: inputName,
+            value: value
+          })
+        }), /*#__PURE__*/(0, _jsxRuntime.jsxs)(_StackView.default, {
+          direction: "column",
+          space: contentSpace,
+          tokens: {
+            flexShrink: 1
+          },
+          children: [title ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+            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.default.string,
+  /**
+   * Additional content to be displayed below the checkbox.
+   */
+  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+  /**
+   * Use `checked` for controlled checkbox. For uncontrolled checkbox, use the `defaultChecked` prop.
+   */
+  checked: _propTypes.default.bool,
+  /**
+   * Use `defaultChecked` to provide the initial value for an uncontrolled checkbox.
+   */
+  defaultChecked: _propTypes.default.bool,
+  /**
+   * An optional checkboxdescription.
+   */
+  description: _propTypes.default.string,
+  /**
+   * Checkbox card ID.
+   */
+  id: _propTypes.default.string,
+  /**
+   * Checkbox icon ID.
+   */
+  iconId: _propTypes.default.string,
+  /**
+   * Whether the corresponding input is disabled or active.
+   */
+  inactive: _propTypes.default.bool,
+  /**
+   * The label.
+   */
+  label: _propTypes.default.string,
+  /**
+   * Associate this checkbox card with a group (set as the name attribute).
+   */
+  name: _propTypes.default.string,
+  /**
+   * Whether the underlying input triggered a validation error or not.
+   */
+  error: _propTypes.default.bool,
+  /**
+   * The value. Must be unique within the group.
+   */
+  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number, _propTypes.default.bool]),
+  /**
+   * Callback called when a controlled checkbox card gets interacted with.
+   */
+  onChange: _propTypes.default.func,
+  /**
+   * checkbox card tokens.
+   */
+  tokens: (0, _utils.getTokensPropType)('CheckboxCard'),
+  /**
+   * checkbox variant.
+   */
+  variant: _utils.variantProp.propType
+};
+var _default = exports.default = CheckboxCard;
+const staticStyles = _StyleSheet.default.create({
+  alignWithText: {
+    justifyContent: 'center'
+  }
+});

package/lib/cjs/CheckboxCard/index.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _CheckboxCard = _interopRequireDefault(require("./CheckboxCard"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _default = exports.default = _CheckboxCard.default;