@telus-uds/components-base 2.4.0 → 3.0.0

package/lib/cjs/CheckboxCardGroup/CheckboxCardGroup.js

@@ -0,0 +1,215 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _ViewportProvider = require("../ViewportProvider");
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _StackView = _interopRequireWildcard(require("../StackView"));
+var _CheckboxCard = _interopRequireDefault(require("../CheckboxCard"));
+var _Fieldset = _interopRequireDefault(require("../Fieldset"));
+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.viewProps]);
+const [selectItemProps, selectedItemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.focusHandlerProps, _utils.viewProps]);
+const CheckboxCardGroup = /*#__PURE__*/_react.default.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 = (0, _ViewportProvider.useViewport)();
+  const {
+    space,
+    fieldSpace,
+    direction,
+    showIcon,
+    outlineWidth,
+    borderTopLeftRadius,
+    borderTopRightRadius,
+    borderBottomLeftRadius,
+    borderBottomRightRadius,
+    outlineOffset
+  } = (0, _ThemeProvider.useThemeTokens)('CheckboxCardGroup', tokens, variant, {
+    viewport
+  });
+  const borderTokens = {
+    outlineWidth,
+    borderTopLeftRadius,
+    borderTopRightRadius,
+    borderBottomLeftRadius,
+    borderBottomRightRadius,
+    outlineOffset
+  };
+  const {
+    currentValues,
+    toggleOneValue
+  } = (0, _utils.useMultipleInputValues)({
+    value: checkedIds,
+    initialValues: initialCheckedIds,
+    onChange,
+    readOnly: readOnly || inactive
+  });
+  const StackContainer = direction === 'row' ? _StackView.StackWrap : _StackView.default;
+  // 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 (!(0, _utils.containUniqueFields)(items, uniqueFields)) {
+    throw new Error(`CheckboxCardGroup items must have unique ${uniqueFields.join(', ')}`);
+  }
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Fieldset.default, {
+    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__*/(0, _jsxRuntime.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__*/(0, _jsxRuntime.jsx)(_CheckboxCard.default, {
+          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.default.oneOf(['en', 'fr']),
+  /**
+   * Optional theme token overrides for the outer CheckboxCardGroup component
+   */
+  tokens: (0, _utils.getTokensPropType)('CheckboxCardGroup'),
+  /**
+   * Optional theme token overrides for each inner CheckboxCard component
+   */
+  checkboxCardTokens: (0, _utils.getTokensPropType)('CheckboxCard'),
+  /**
+   * Theme variants, shared between both CheckboxCardGroup and CheckboxCard
+   */
+  variant: _utils.variantProp.propType,
+  /**
+   * Array of objects containing specifics for each CheckboxCard to be rendered in the group.
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.exact({
+    ...selectedItemPropTypes,
+    title: _propTypes.default.string,
+    content: _propTypes.default.node,
+    id: _propTypes.default.string,
+    onChange: _propTypes.default.func
+  })),
+  /**
+   * 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 checkbox cards cannot be selected by the user and simply show their current state.
+   */
+  readOnly: _propTypes.default.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.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 = CheckboxCardGroup;

package/lib/cjs/CheckboxCardGroup/index.js

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

package/lib/cjs/ColourToggle/ColourBubble.js

@@ -0,0 +1,133 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _Pressable = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Pressable"));
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+var _pressability = require("../utils/pressability");
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const selectGeneralBubbleTokens = _ref => {
+  let {
+    outerBubbleHeight,
+    outerBubbleWidth,
+    outerBubbleContentAlignItems,
+    outerBubbleJustifyContent,
+    bubbleBorderColor,
+    bubbleBorderWidth,
+    bubbleBorderRadius
+  } = _ref;
+  return {
+    height: outerBubbleHeight,
+    width: outerBubbleWidth,
+    justifyContent: outerBubbleContentAlignItems,
+    alignItems: outerBubbleJustifyContent,
+    borderColor: bubbleBorderColor,
+    borderWidth: bubbleBorderWidth,
+    borderRadius: bubbleBorderRadius,
+    ..._Platform.default.select({
+      web: {
+        outline: 'none'
+      }
+    })
+  };
+};
+const selectInnerBubbleTokens = _ref2 => {
+  let {
+    innerBubbleHeight,
+    innerBubbleWidth,
+    innerBubbleBorderRadius,
+    borderColor,
+    borderWidth,
+    shadow
+  } = _ref2;
+  return {
+    height: innerBubbleHeight,
+    width: innerBubbleWidth,
+    borderRadius: innerBubbleBorderRadius,
+    borderColor,
+    borderWidth,
+    ...(0, _ThemeProvider.applyShadowToken)(shadow)
+  };
+};
+const selectBorderBubbleTokens = _ref3 => {
+  let {
+    bubbleBorderColor,
+    bubbleBorderWidth,
+    bubbleBorderRadius
+  } = _ref3;
+  return {
+    borderColor: bubbleBorderColor,
+    borderWidth: bubbleBorderWidth,
+    borderRadius: bubbleBorderRadius
+  };
+};
+const ColourBubble = /*#__PURE__*/_react.default.forwardRef((_ref4, ref) => {
+  let {
+    tokens = {},
+    id,
+    colourHexCode,
+    colourName,
+    isSelected,
+    onPress
+  } = _ref4;
+  const defaultTokens = tokens({
+    selected: isSelected
+  });
+  const resolveColourBubbleTokens = pressState => (0, _pressability.resolvePressableTokens)(tokens, pressState, {});
+  const themeTokens = _react.default.useMemo(() => tokens(), [tokens]);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Pressable.default, {
+    style: state => [selectGeneralBubbleTokens(resolveColourBubbleTokens(state)), isSelected && selectBorderBubbleTokens(defaultTokens)],
+    onPress: onPress,
+    accessible: true,
+    accessibilityRole: "radio",
+    accessibilityLabel: colourName,
+    accessibilityState: {
+      checked: isSelected
+    },
+    ref: ref,
+    testID: id,
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      style: [selectInnerBubbleTokens(themeTokens), {
+        backgroundColor: colourHexCode
+      }]
+    })
+  });
+});
+ColourBubble.displayName = 'ColourBubble';
+ColourBubble.propTypes = {
+  /**
+   * Colour toggle tokens callback.
+   */
+  tokens: (0, _utils.getTokensPropType)('ColourToggle'),
+  /**
+   * ID of each colour bubble
+   */
+  id: _propTypes.default.string,
+  /**
+   * Hexadecimal code for the background of the colour bubble
+   */
+  colourHexCode: _propTypes.default.string,
+  /**
+   * Name of the colour bubble
+   */
+  colourName: _propTypes.default.string,
+  /**
+   * If the current colour bubble is selected
+   */
+  isSelected: _propTypes.default.bool,
+  /**
+   * If provided, this function is called when the current selection
+   * of the color is changed of all currently `items`.
+   * Receives two parameters: item object selected and the event
+   */
+  onPress: _propTypes.default.func
+};
+var _default = exports.default = ColourBubble;

package/lib/cjs/ColourToggle/ColourToggle.js

@@ -0,0 +1,98 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _StackView = require("../StackView");
+var _Typography = _interopRequireDefault(require("../Typography"));
+var _ColourBubble = _interopRequireDefault(require("./ColourBubble"));
+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 ColourToggle = /*#__PURE__*/_react.default.forwardRef((_ref, ref) => {
+  let {
+    tokens,
+    variant,
+    defaultColourId,
+    items,
+    onChange,
+    ...rest
+  } = _ref;
+  const [currentColourId, setCurrentColourId] = _react.default.useState(defaultColourId);
+  const getTokens = (0, _ThemeProvider.useThemeTokensCallback)('ColourToggle', tokens, variant);
+  const {
+    space
+  } = getTokens();
+  const {
+    colourName: currentColourName = ''
+  } = items.find(item => item.id === currentColourId) || '';
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+    ref: ref,
+    ...selectProps(rest),
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Typography.default, {
+      children: currentColourName
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_StackView.StackWrap, {
+      space: space,
+      accessibilityRole: "radiogroup",
+      children: items.map((_ref2, index) => {
+        let {
+          id,
+          colourHexCode,
+          colourName
+        } = _ref2;
+        const colourBubbleId = id || `ColourBubble[${index}]`;
+        const handleChangeColour = event => {
+          setCurrentColourId(id);
+          onChange?.(event, {
+            id,
+            colourHexCode,
+            colourName
+          });
+        };
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(_ColourBubble.default, {
+          id: colourBubbleId,
+          tokens: getTokens,
+          isSelected: id === currentColourId,
+          colourHexCode: colourHexCode,
+          colourName: colourName,
+          onPress: handleChangeColour
+        }, colourBubbleId);
+      })
+    })]
+  });
+});
+ColourToggle.displayName = 'ColourToggle';
+ColourToggle.propTypes = {
+  ...selectedSystemPropTypes,
+  /**
+   * Optional theme token overrides for the outer ColourToggle component
+   */
+  tokens: (0, _utils.getTokensPropType)('ColourToggle'),
+  /**
+   * Colour toggle variant.
+   */
+  variant: _utils.variantProp.propType,
+  /**
+   * Id of the selected color when component mounts
+   */
+  defaultColourId: _propTypes.default.string,
+  /**
+   * Array of objects containing specifics for each ColourBubble to be rendered in the group.
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.exact({
+    colourHexCode: _propTypes.default.string,
+    colourName: _propTypes.default.string,
+    id: _propTypes.default.string
+  })),
+  /**
+   * If provided, this function is called when the current selection of the color is changed of all currently `items`. Receives two parameters: item object selected and the event
+   */
+  onChange: _propTypes.default.func
+};
+var _default = exports.default = ColourToggle;

package/lib/cjs/ColourToggle/index.js

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

package/lib/cjs/Divider/Divider.js

@@ -0,0 +1,138 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+var _ThemeProvider = require("../ThemeProvider");
+var _Spacer = _interopRequireDefault(require("../Spacer"));
+var _utils = require("../utils");
+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]);
+
+/**
+ * @typedef {import('../utils/props/spacingProps.js').SpacingIndex} SpacingIndex
+ * @typedef {import('../utils/props/spacingProps.js').SpacingObject} SpacingObject
+ */
+
+/**
+ * A basic divider component, horizontal by default. Color and thickness can be controlled by theme.
+ * Divider is based on the flexbox model and uses `alignSelf: flex` to span its flex parent.
+ *
+ * ## Vertical
+ *
+ * Vertical dividers can be created by passing a `vertical` boolean prop.
+ * Note that for a vertical divider the parent flex element **must** have flex direction set to row.
+ * This is the default for web but not for React Native.
+ *
+ * In a flexbox row, vertical dividers will automatically size to their parent height.
+ *
+ * ## Space
+ *
+ * Use this to create **space either side of the divider**. For simple cases, pass a number referring to
+ * a position on the theme's spacing scale; for example, this will put a Spacer of the smallest supported
+ * size either side of the divider:
+ *
+ * ```jsx
+ * <Divider space={1} />
+ * ```
+ *
+ * `space` prop uses `useSpacingScale` and may accept a {@link SpacingObject} or a {@link SpacingIndex} number.
+ *
+ * To **reduce the length of a divider** as well as creating space between it and its neighbours, wrap it in
+ * a `Box` component. For example, this will have the second-smallest theme-supported spacing value between
+ * the dividing line and its neighbours, and will shorten the line at either end by the same amount:
+ *
+ * ```jsx
+ * <Box space={2}><Divider /></Box>
+ * ```
+ *
+ * ## Accessibility
+ *
+ * For accessibility purposes a divider component will be described with ARIA attributes, i.e. `role="separator"` and `aria-orientation="vertical/horizontal"`.
+ */
+const Divider = /*#__PURE__*/_react.default.forwardRef((_ref, ref) => {
+  let {
+    variant,
+    vertical = false,
+    space,
+    tokens,
+    ...rest
+  } = _ref;
+  const {
+    color,
+    width
+  } = (0, _ThemeProvider.useThemeTokens)('Divider', tokens, variant);
+  const borderStyles = vertical ? {
+    borderRightColor: color,
+    borderRightWidth: width
+  } : {
+    borderBottomColor: color,
+    borderBottomWidth: width
+  };
+  const a11y = _Platform.default.OS === 'web' ?
+  // There are aria attributes for dividers on web
+  {
+    // Early versions of React Native Web support 'aria-orientation' while
+    // later versions only support accessibilityOrientation and map it. Supply both.
+    'aria-orientation': vertical ? 'vertical' : 'horizontal',
+    accessibilityOrientation: vertical ? 'vertical' : 'horizontal',
+    accessibilityRole: 'separator'
+  } :
+  // There are no such equivalent attributes for native
+  {};
+  const {
+    testID,
+    ...selectedProps
+  } = selectProps({
+    ...a11y,
+    ...rest
+  });
+  const divider = /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+    ref: ref,
+    style: [styles.divider, borderStyles],
+    testID: testID,
+    ...selectedProps
+  });
+  if (!space) return divider;
+  const spacerProps = {
+    space,
+    direction: vertical ? 'row' : 'column'
+  };
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Spacer.default, {
+      ...spacerProps,
+      testID: testID ? `${testID}-Spacer-before` : undefined
+    }), divider, /*#__PURE__*/(0, _jsxRuntime.jsx)(_Spacer.default, {
+      ...spacerProps,
+      testID: testID ? `${testID}-Spacer-after` : undefined
+    })]
+  });
+});
+Divider.displayName = 'Divider';
+Divider.propTypes = {
+  ...selectedSystemPropTypes,
+  tokens: (0, _utils.getTokensPropType)('Divider'),
+  /**
+   * A number referring to a position on the space scale to create space on either side of the divider
+   */
+  space: _utils.spacingProps.types.spacingValue,
+  variant: _utils.variantProp.propType,
+  /**
+   * By default, the divider is a horizontal line the full width of its parent.
+   * With `vertical` prop and when inside a container with { flexDirection: row }, draws a full height vertical line.
+   */
+  vertical: _propTypes.default.bool
+};
+const styles = _StyleSheet.default.create({
+  divider: {
+    alignSelf: 'stretch'
+  }
+});
+var _default = exports.default = Divider;

package/lib/cjs/Divider/index.js

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