@telus-uds/components-base 3.7.1 → 3.9.0

package/lib/cjs/utils/index.js

@@ -20,7 +20,8 @@ var _exportNames = {
   transformGradient: true,
   convertFromMegaByteToByte: true,
   formatImageSource: true,
-  getSpacingScale: true
+  getSpacingScale: true,
+  useVariants: true
 };
 Object.defineProperty(exports, "BaseView", {
   enumerable: true,
@@ -118,6 +119,12 @@ Object.defineProperty(exports, "useUniqueId", {
     return _useUniqueId.default;
   }
 });
+Object.defineProperty(exports, "useVariants", {
+  enumerable: true,
+  get: function () {
+    return _useVariants.default;
+  }
+});
 Object.defineProperty(exports, "withLinkRouter", {
   enumerable: true,
   get: function () {
@@ -248,6 +255,7 @@ var _transformGradient = require("./transformGradient");
 var _convertFromMegaByteToByte = _interopRequireDefault(require("./convertFromMegaByteToByte"));
 var _formatImageSource = _interopRequireDefault(require("./formatImageSource"));
 var _getSpacingScale = _interopRequireDefault(require("./getSpacingScale"));
+var _useVariants = _interopRequireDefault(require("./useVariants"));
 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 }; }

package/lib/cjs/utils/useDetectOutsideClick.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Hook to detect clicks outside of a ref, only on web.
+ *
+ * @param {React.RefObject<HTMLElement>} ref
+ *   Reference to the element you want to “protect.”
+ * @param {() => void} onOutside
+ *   Callback invoked when a click occurs outside that ref.
+ * @param {boolean} [enabled=true]
+ *   Flag to enable or disable the outside-click detection at runtime.
+ *   @deprecated Will be removed in next major release; detection will always be enabled.
+ */
+
+function useDetectOutsideClick(ref, onOutside) {
+  let enabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  _react.default.useEffect(() => {
+    if (!enabled || _Platform.default.OS !== 'web') {
+      return undefined;
+    }
+    const handleClickOutside = e => {
+      if (ref.current && !ref.current.contains(e.target)) {
+        onOutside();
+      }
+    };
+    document.addEventListener('mousedown', handleClickOutside);
+    return () => {
+      document.removeEventListener('mousedown', handleClickOutside);
+    };
+  }, [ref, onOutside, enabled]);
+}
+var _default = exports.default = useDetectOutsideClick;

package/lib/cjs/utils/useVariants.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ThemeProvider = require("../ThemeProvider");
+/**
+ * Generates a label string for a variant based on the provided key and value.
+ *
+ * @param {string} key - The name of the variant.
+ * @param {*} value - The value of the variant. If it's a string, it will be appended to the key.
+ * @returns {string} The formatted variant label (e.g., "color: red" or "size").
+ */
+const getVariantLabel = (key, value) => `${key}${typeof value === 'string' ? `: ${value}` : ''}`;
+
+/**
+ * Retrieves the variant options for a given component from the theme.
+ *
+ * @param {string} componentName - The name of the component to get variants for.
+ * @returns {Array<Array>} An array of variant tuples. Each tuple contains:
+ *   - {string|undefined} The variant key (e.g., 'size', 'color', or undefined for default).
+ *   - {string|undefined} The variant value (e.g., 'small', 'primary', or undefined for default).
+ *   - {string} The human-readable label for the variant.
+ *   Returns [['default', {}]] if no componentName is provided.
+ * @throws {Error} If the theme does not define appearances for the given component.
+ */
+const useVariants = componentName => {
+  const theme = (0, _ThemeProvider.useTheme)();
+  if (!componentName) return [['default', {}]];
+  const {
+    appearances
+  } = (0, _ThemeProvider.getComponentTheme)(theme, componentName);
+  if (!appearances) {
+    throw new Error(`Theme ${theme.metadata?.name} does not have any appearances set for ${componentName}`);
+  }
+  const variants = Object.entries(appearances).reduce((pairs, _ref) => {
+    let [key, {
+      values,
+      type
+    } = {}] = _ref;
+    return type === 'variant' ? [...pairs, ...values.map(value => [key, value, getVariantLabel(key, value)])] : pairs;
+  }, [[undefined, undefined, 'default style']]);
+  return variants;
+};
+var _default = exports.default = useVariants;

package/lib/esm/ActivityIndicator/FullScreenIndicator.js

@@ -0,0 +1,82 @@
+import React from 'react';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Platform from "react-native-web/dist/exports/Platform";
+import PropTypes from 'prop-types';
+import StackView from '../StackView';
+import Typography from '../Typography';
+import RenderActivityIndicator from './RenderActivityIndicator';
+import { BACKDROP_Z_INDEX, SPACE_WITH_LABEL, SPACE_WITHOUT_LABEL } from './shared';
+import { activityIndicatorCommonProps } from './sharedProptypes';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const FullScreenIndicator = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    variantProps,
+    label,
+    labelPosition,
+    labelMapping,
+    backgroundColor,
+    showLabel
+  } = _ref;
+  return /*#__PURE__*/_jsx(View, {
+    style: [staticStyles.fullScreenOverlay, {
+      backgroundColor
+    }],
+    children: /*#__PURE__*/_jsxs(StackView, {
+      space: showLabel ? SPACE_WITH_LABEL : SPACE_WITHOUT_LABEL,
+      tokens: {
+        alignItems: 'center'
+      },
+      direction: labelMapping[labelPosition],
+      children: [/*#__PURE__*/_jsx(RenderActivityIndicator, {
+        ...variantProps,
+        ref: ref,
+        label: label
+      }), showLabel && /*#__PURE__*/_jsx(Typography, {
+        children: label
+      })]
+    })
+  });
+});
+FullScreenIndicator.displayName = 'FullScreenIndicator';
+const staticStyles = StyleSheet.create({
+  fullScreenOverlay: {
+    ...Platform.select({
+      web: {
+        position: 'fixed',
+        top: 0,
+        left: 0,
+        width: '100vw',
+        height: '100vh',
+        zIndex: BACKDROP_Z_INDEX,
+        justifyContent: 'center',
+        alignItems: 'center'
+      },
+      default: {
+        position: 'absolute',
+        top: 0,
+        left: 0,
+        right: 0,
+        bottom: 0,
+        justifyContent: 'center',
+        alignItems: 'center',
+        ...(Platform.OS === 'android' ? {
+          elevation: 5
+        } : {
+          zIndex: BACKDROP_Z_INDEX
+        })
+      }
+    })
+  }
+});
+FullScreenIndicator.propTypes = {
+  /**
+   * Shared props
+   * */
+  ...activityIndicatorCommonProps,
+  /**
+   * Background color for overlay
+   * */
+  backgroundColor: PropTypes.string.isRequired
+};
+export default FullScreenIndicator;

package/lib/esm/ActivityIndicator/InlineIndicator.js

@@ -0,0 +1,57 @@
+import React from 'react';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Platform from "react-native-web/dist/exports/Platform";
+import PropTypes from 'prop-types';
+import StackView from '../StackView';
+import Typography from '../Typography';
+import RenderActivityIndicator from './RenderActivityIndicator';
+import { activityIndicatorCommonProps } from './sharedProptypes';
+import { SPACE_WITH_LABEL, SPACE_WITHOUT_LABEL } from './shared';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const InlineIndicator = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    variantProps,
+    label,
+    labelPosition,
+    labelMapping,
+    showLabel
+  } = _ref;
+  return /*#__PURE__*/_jsx(View, {
+    style: staticStyles.container,
+    children: /*#__PURE__*/_jsxs(StackView, {
+      space: showLabel ? SPACE_WITH_LABEL : SPACE_WITHOUT_LABEL,
+      direction: labelMapping[labelPosition],
+      tokens: {
+        alignItems: 'center'
+      },
+      children: [/*#__PURE__*/_jsx(RenderActivityIndicator, {
+        ...variantProps,
+        ref: ref,
+        label: label
+      }), showLabel && /*#__PURE__*/_jsx(Typography, {
+        children: label
+      })]
+    })
+  });
+});
+InlineIndicator.displayName = 'InlineIndicator';
+const staticStyles = StyleSheet.create({
+  container: {
+    flexDirection: 'column',
+    alignItems: 'center',
+    display: Platform.OS === 'web' ? 'inline-flex' : 'flex',
+    alignSelf: 'flex-start'
+  }
+});
+InlineIndicator.propTypes = {
+  /**
+   * Shared props
+   * */
+  ...activityIndicatorCommonProps,
+  /**
+   * Whether the indicator sits inline with text/other elements
+   * */
+  inline: PropTypes.bool
+};
+export default InlineIndicator;

package/lib/esm/ActivityIndicator/OverlayIndicator.js

@@ -0,0 +1,149 @@
+import React from 'react';
+import View from "react-native-web/dist/exports/View";
+import Platform from "react-native-web/dist/exports/Platform";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import PropTypes from 'prop-types';
+import StackView from '../StackView';
+import Typography from '../Typography';
+import RenderActivityIndicator from './RenderActivityIndicator';
+import { BACKDROP_Z_INDEX, BACKDROP_OPACITY, SPACE_WITH_LABEL, SPACE_WITHOUT_LABEL } from './shared';
+import { activityIndicatorCommonProps } from './sharedProptypes';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const recursiveMap = (nodeChildren, fn) => React.Children.map(nodeChildren, child => {
+  if (! /*#__PURE__*/React.isValidElement(child)) return child;
+  if (child.props?.children) {
+    return fn(/*#__PURE__*/React.cloneElement(child, {
+      children: recursiveMap(child.props.children, fn)
+    }));
+  }
+  return fn(child);
+});
+const OverlayIndicator = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    variantProps,
+    label,
+    labelPosition,
+    labelMapping,
+    children,
+    inline,
+    showLabel,
+    isActive = true
+  } = _ref;
+  const safeChildren = Platform.OS === 'web' && isActive ? recursiveMap(children, c => /*#__PURE__*/React.isValidElement(c) ? /*#__PURE__*/React.cloneElement(c, {
+    role: 'presentation'
+  }) : c) : children;
+
+  // inline + children
+  if (inline && children) {
+    return /*#__PURE__*/_jsxs(View, {
+      style: [staticStyles.container, Platform.OS === 'web' && staticStyles.inlineContainer],
+      children: [/*#__PURE__*/_jsx(View, {
+        style: staticStyles.backdropContainer,
+        children: safeChildren
+      }), /*#__PURE__*/_jsx(View, {
+        style: staticStyles.buttonOverlaySpinner,
+        children: /*#__PURE__*/_jsx(RenderActivityIndicator, {
+          ...variantProps,
+          ref: ref,
+          label: label
+        })
+      })]
+    });
+  }
+
+  // overlay
+  return /*#__PURE__*/_jsxs(View, {
+    style: staticStyles.container,
+    children: [/*#__PURE__*/_jsx(View, {
+      style: staticStyles.backdropContainer,
+      children: safeChildren
+    }), /*#__PURE__*/_jsx(View, {
+      style: [staticStyles.overlayContainer, Platform.OS === 'web' && staticStyles.webOverlayContainer],
+      children: /*#__PURE__*/_jsxs(StackView, {
+        space: showLabel ? SPACE_WITH_LABEL : SPACE_WITHOUT_LABEL,
+        tokens: {
+          alignItems: 'center'
+        },
+        direction: labelMapping[labelPosition],
+        children: [/*#__PURE__*/_jsx(RenderActivityIndicator, {
+          ...variantProps,
+          ref: ref,
+          label: label
+        }), showLabel && /*#__PURE__*/_jsx(Typography, {
+          children: label
+        })]
+      })
+    })]
+  });
+});
+OverlayIndicator.displayName = 'OverlayIndicator';
+const staticStyles = StyleSheet.create({
+  container: {
+    position: 'relative'
+  },
+  inlineContainer: {
+    display: 'inline-flex'
+  },
+  backdropContainer: {
+    opacity: BACKDROP_OPACITY
+  },
+  overlayContainer: {
+    position: 'absolute',
+    top: '50%',
+    left: '50%',
+    ...Platform.select({
+      ios: {
+        zIndex: BACKDROP_Z_INDEX
+      },
+      android: {
+        elevation: 5
+      }
+    })
+  },
+  webOverlayContainer: {
+    transform: [{
+      translateX: '-50%'
+    }, {
+      translateY: '-50%'
+    }],
+    zIndex: BACKDROP_Z_INDEX
+  },
+  buttonOverlaySpinner: {
+    position: 'absolute',
+    top: '50%',
+    left: '50%',
+    ...Platform.select({
+      web: {
+        transform: 'translate(-50%, -50%)',
+        zIndex: BACKDROP_Z_INDEX
+      },
+      default: {
+        transform: [{
+          translateX: -0.5
+        }, {
+          translateY: -0.5
+        }],
+        zIndex: BACKDROP_Z_INDEX
+      }
+    })
+  }
+});
+OverlayIndicator.propTypes = {
+  /**
+   * Shared props
+   * */
+  ...activityIndicatorCommonProps,
+  /**
+   * Background color for overlay
+   * */
+  inline: PropTypes.bool,
+  /**
+   * Children on which the overlay is drawn
+   * */
+  children: PropTypes.node,
+  /**
+   * Controls whether the overlay is active and should apply the presentation role
+   * */
+  isActive: PropTypes.bool
+};
+export default OverlayIndicator;

package/lib/esm/ActivityIndicator/RenderActivityIndicator.js

@@ -0,0 +1,83 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import Spinner from './Spinner';
+import Dots from './Dots';
+import { DOTS_STYLE } from './shared';
+
+/**
+ * Return <Dots/> or <Spinner/> based on `variant?.dots`.
+ * Reused in all the variants of the component.
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
+const RenderActivityIndicator = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    variant = {},
+    dotSize,
+    size,
+    color,
+    indicatorBackgroundColor,
+    thickness,
+    label,
+    isStatic
+  } = _ref;
+  const {
+    dots,
+    style
+  } = variant || {};
+  const isDots = dots === true || style === DOTS_STYLE;
+  return isDots ? /*#__PURE__*/_jsx(Dots, {
+    ref: ref,
+    size: dotSize,
+    color: color,
+    indicatorBackgroundColor: indicatorBackgroundColor,
+    label: label,
+    isStatic: isStatic
+  }) : /*#__PURE__*/_jsx(Spinner, {
+    ref: ref,
+    size: size,
+    color: color,
+    indicatorBackgroundColor: indicatorBackgroundColor,
+    thickness: thickness,
+    label: label,
+    isStatic: isStatic
+  });
+});
+RenderActivityIndicator.displayName = 'RenderActivityIndicator';
+RenderActivityIndicator.propTypes = {
+  /**
+   * ActivityIndicator variants
+   * */
+  variant: PropTypes.shape({
+    dots: PropTypes.bool,
+    style: PropTypes.oneOf([DOTS_STYLE])
+  }),
+  /**
+   * Size of the dots
+   * */
+  dotSize: PropTypes.number,
+  /**
+   * Size of the spinner
+   * */
+  size: PropTypes.number,
+  /**
+   * Primary color
+   * */
+  color: PropTypes.string,
+  /**
+   * Secondary color (background) of the indicator
+   * */
+  indicatorBackgroundColor: PropTypes.string,
+  /**
+   * Thickness of the indicator
+   * */
+  thickness: PropTypes.number,
+  /**
+   * Label for the ActivityIndicator
+   * */
+  label: PropTypes.string,
+  /**
+   * if true, there's no animation for ActivityIndicator
+   * */
+  isStatic: PropTypes.bool
+};
+export default RenderActivityIndicator;

package/lib/esm/ActivityIndicator/index.js

@@ -1,45 +1,83 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import Platform from "react-native-web/dist/exports/Platform";
+import { useScrollBlocking } from '../utils';
 import { useThemeTokens } from '../ThemeProvider';
 import { getTokensPropType, variantProp } from '../utils/props';
-import Spinner from './Spinner';
-import Dots from './Dots';
+import FullScreenIndicator from './FullScreenIndicator';
+import OverlayIndicator from './OverlayIndicator';
+import InlineIndicator from './InlineIndicator';
+import { jsx as _jsx } from "react/jsx-runtime";
+const labelMapping = {
+  top: 'column-reverse',
+  bottom: 'column',
+  left: 'row-reverse',
+  right: 'row'
+};
 
 /**
  * `ActivityIndicator` renders a visual loading state.
  * It does not handle positioning or layout of that visual loader.
  */
-import { jsx as _jsx } from "react/jsx-runtime";
 const ActivityIndicator = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   let {
     variant,
     tokens,
     label,
-    isStatic = false
+    labelPosition = 'bottom',
+    showLabel = true,
+    inline = false,
+    fullScreen = false,
+    overlay = false,
+    isStatic = false,
+    children,
+    fullScreenBackgroundColor
   } = _ref;
   const {
     size,
     dotSize,
     color,
     indicatorBackgroundColor,
+    fullScreenOverlayBackground,
     thickness
   } = useThemeTokens('ActivityIndicator', tokens, variant);
-  return variant?.dots ? /*#__PURE__*/_jsx(Dots, {
-    ref: ref,
-    size: dotSize,
-    color: color,
-    indicatorBackgroundColor: indicatorBackgroundColor,
-    label: label,
-    isStatic: isStatic
-  }) : /*#__PURE__*/_jsx(Spinner, {
-    ref: ref,
-    size: size,
-    color: color,
-    indicatorBackgroundColor: indicatorBackgroundColor,
-    thickness: thickness,
-    label: label,
-    isStatic: isStatic
-  });
+  useScrollBlocking([Platform.OS === 'web' && fullScreen]);
+  const variantProps = {
+    variant,
+    dotSize,
+    size,
+    color,
+    indicatorBackgroundColor,
+    thickness,
+    isStatic
+  };
+  const visibleLabel = showLabel && !!label;
+  const commonProps = {
+    ref,
+    variantProps,
+    label,
+    labelPosition,
+    labelMapping,
+    showLabel: visibleLabel
+  };
+  switch (true) {
+    case fullScreen:
+      return /*#__PURE__*/_jsx(FullScreenIndicator, {
+        ...commonProps,
+        backgroundColor: fullScreenBackgroundColor || fullScreenOverlayBackground
+      });
+    case overlay:
+      return /*#__PURE__*/_jsx(OverlayIndicator, {
+        ...commonProps,
+        inline: inline,
+        isActive: overlay,
+        children: children
+      });
+    default:
+      return /*#__PURE__*/_jsx(InlineIndicator, {
+        ...commonProps
+      });
+  }
 });
 ActivityIndicator.displayName = 'ActivityIndicator';
 ActivityIndicator.propTypes = {
@@ -48,10 +86,38 @@ ActivityIndicator.propTypes = {
   /**
    * A visually hidden accessible label describing the action taking place
    */
-  label: PropTypes.string.isRequired,
+  label: PropTypes.string,
+  /**
+   * If true, it should render a static ActivityIndicator
+   */
+  isStatic: PropTypes.bool,
+  /**
+   * Position of the label relative to ActivityIndicator
+   */
+  labelPosition: PropTypes.oneOf(['top', 'bottom', 'left', 'right']),
+  /**
+   * show or hide the label
+   */
+  showLabel: PropTypes.bool,
+  /**
+   * If true, the ActivityIndicator will be displayed in full screen mode
+   */
+  fullScreen: PropTypes.bool,
+  /**
+   * If true, the ActivityIndicator will be displayed inline
+   */
+  inline: PropTypes.bool,
+  /**
+   * If true, the ActivityIndicator will be displayed in overlay mode
+   */
+  overlay: PropTypes.bool,
+  /**
+   * Children to be rendered inside ActivityIndicator
+   */
+  children: PropTypes.node,
   /**
-   * If true, it should render a static spinner
+   * Background color of the full screen overlay
    */
-  isStatic: PropTypes.bool
+  fullScreenBackgroundColor: PropTypes.string
 };
 export default ActivityIndicator;

package/lib/esm/ActivityIndicator/shared.js

@@ -50,6 +50,17 @@ export const DOT_FADEOUT_OUTPUT_RANGE = [1, 1, 0, 0];
 export const DOT1_ANIMATION_INPUT_RANGE = [0, 0.1, 0.2, 1];
 export const DOT2_ANIMATION_INPUT_RANGE = [0, 0.3, 0.4, 0.5, 1];
 export const DOT3_ANIMATION_INPUT_RANGE = [0, 0.6, 0.7, 0.8, 1];
+
+// Backdrop
+export const BACKDROP_OPACITY = 0.06;
+export const BACKDROP_Z_INDEX = 1400;
+
+// Space
+export const SPACE_WITH_LABEL = 3;
+export const SPACE_WITHOUT_LABEL = 0;
+
+// Style
+export const DOTS_STYLE = 'dots';
 export const propTypes = {
   color: PropTypes.string.isRequired,
   baseColor: PropTypes.string,