@telus-uds/components-base 3.4.0 → 3.5.0

package/lib/esm/ActivityIndicator/Dots.js

@@ -0,0 +1,158 @@
+import React from 'react';
+import { DOTS_TOTAL_ANIMATION_DURATION, OVERSHOOT_FACTOR, UNDERSHOOT_FACTOR, BOUNCY_CURVE, DOTS_SPACING_X, DOTS_BASE_Y_FACTOR, DOTS_JUMP_HEIGHT_FACTOR, DOTS_PADDING_FACTOR, DOTS_FADEOUT_KEYTIMES, DOTS_FADEOUT_VALUES, DOT1_COLOR_KEYTIMES, DOT2_COLOR_KEYTIMES, DOT3_COLOR_KEYTIMES, DOT1_ANIMATION_KEYTIMES, DOT2_ANIMATION_KEYTIMES, DOT3_ANIMATION_KEYTIMES, propTypes } from './shared';
+import { useA11yInfo } from '../A11yInfoProvider';
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+const CY_PROPS = {
+  attributeName: 'cy',
+  calcMode: 'spline',
+  dur: `${DOTS_TOTAL_ANIMATION_DURATION}ms`,
+  repeatCount: 'indefinite'
+};
+const FILL_PROPS = {
+  attributeName: 'fill',
+  calcMode: 'linear',
+  dur: `${DOTS_TOTAL_ANIMATION_DURATION}ms`,
+  repeatCount: 'indefinite'
+};
+const OPACITY_PROPS = {
+  attributeName: 'opacity',
+  calcMode: 'linear',
+  dur: `${DOTS_TOTAL_ANIMATION_DURATION}ms`,
+  repeatCount: 'indefinite'
+};
+const Dots = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    size,
+    color,
+    indicatorBackgroundColor,
+    label,
+    isStatic = false
+  } = _ref;
+  const {
+    reduceMotionEnabled
+  } = useA11yInfo();
+  const reduceMotion = reduceMotionEnabled || isStatic;
+  const spacingX = size + DOTS_SPACING_X;
+  const baseY = size * DOTS_BASE_Y_FACTOR;
+  const jumpHeight = size * DOTS_JUMP_HEIGHT_FACTOR;
+  const padding = size * DOTS_PADDING_FACTOR;
+  return /*#__PURE__*/_jsx("svg", {
+    ref: ref,
+    "aria-valuetext": label,
+    role: "progressbar",
+    "aria-busy": "true",
+    width: size * 3 + spacingX * 2 + padding * 2,
+    height: size * 6,
+    viewBox: `0 0 ${size * 3 + spacingX * 2 + padding * 2} ${size * 6}`,
+    children: /*#__PURE__*/_jsxs("g", {
+      children: [/*#__PURE__*/_jsx("circle", {
+        cx: padding + size / 2,
+        cy: baseY,
+        r: size / 2,
+        fill: color,
+        children: !reduceMotion && /*#__PURE__*/_jsxs(_Fragment, {
+          children: [/*#__PURE__*/_jsx("animate", {
+            ...CY_PROPS,
+            keyTimes: DOT1_ANIMATION_KEYTIMES,
+            keySplines: `${BOUNCY_CURVE};${BOUNCY_CURVE};${BOUNCY_CURVE}`,
+            values: `
+                  ${baseY};
+                  ${baseY - jumpHeight * OVERSHOOT_FACTOR};
+                  ${baseY + jumpHeight * UNDERSHOOT_FACTOR};
+                  ${baseY}
+                `
+          }), /*#__PURE__*/_jsx("animate", {
+            ...FILL_PROPS,
+            keyTimes: DOT1_COLOR_KEYTIMES,
+            values: `
+                  ${color}; 
+                  ${color}; 
+                  ${indicatorBackgroundColor}; 
+                  ${indicatorBackgroundColor}
+                `
+          }), /*#__PURE__*/_jsx("animate", {
+            ...OPACITY_PROPS,
+            keyTimes: DOTS_FADEOUT_KEYTIMES,
+            values: DOTS_FADEOUT_VALUES
+          })]
+        })
+      }), /*#__PURE__*/_jsx("circle", {
+        cx: padding + size + spacingX + size / 2,
+        cy: baseY,
+        r: size / 2,
+        fill: indicatorBackgroundColor,
+        children: reduceMotion ? null : /*#__PURE__*/_jsxs(_Fragment, {
+          children: [/*#__PURE__*/_jsx("animate", {
+            ...CY_PROPS,
+            keyTimes: DOT2_ANIMATION_KEYTIMES,
+            keySplines: `
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE}
+                `,
+            values: `
+                  ${baseY};
+                  ${baseY};
+                  ${baseY - jumpHeight * OVERSHOOT_FACTOR};
+                  ${baseY + jumpHeight * UNDERSHOOT_FACTOR};
+                  ${baseY}
+                `
+          }), /*#__PURE__*/_jsx("animate", {
+            ...FILL_PROPS,
+            keyTimes: DOT2_COLOR_KEYTIMES,
+            values: `
+                  ${indicatorBackgroundColor}; 
+                  ${indicatorBackgroundColor}; 
+                  ${color}; 
+                  ${color}; 
+                  ${indicatorBackgroundColor}; 
+                  ${indicatorBackgroundColor}
+                `
+          }), /*#__PURE__*/_jsx("animate", {
+            ...OPACITY_PROPS,
+            keyTimes: DOTS_FADEOUT_KEYTIMES,
+            values: DOTS_FADEOUT_VALUES
+          })]
+        })
+      }), /*#__PURE__*/_jsx("circle", {
+        cx: padding + (size + spacingX) * 2 + size / 2,
+        cy: baseY,
+        r: size / 2,
+        fill: indicatorBackgroundColor,
+        children: reduceMotion ? null : /*#__PURE__*/_jsxs(_Fragment, {
+          children: [/*#__PURE__*/_jsx("animate", {
+            ...CY_PROPS,
+            keyTimes: DOT3_ANIMATION_KEYTIMES,
+            keySplines: `
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE};
+                  ${BOUNCY_CURVE}
+                `,
+            values: `
+                  ${baseY};
+                  ${baseY};
+                  ${baseY - jumpHeight * OVERSHOOT_FACTOR};
+                  ${baseY + jumpHeight * UNDERSHOOT_FACTOR};
+                  ${baseY}
+                `
+          }), /*#__PURE__*/_jsx("animate", {
+            ...FILL_PROPS,
+            keyTimes: DOT3_COLOR_KEYTIMES,
+            values: `
+                  ${indicatorBackgroundColor}; 
+                  ${indicatorBackgroundColor}; 
+                  ${color}; 
+                  ${color}; 
+                  ${color}
+                `
+          })]
+        })
+      })]
+    })
+  });
+});
+Dots.displayName = 'Dots';
+Dots.propTypes = propTypes;
+export default Dots;

package/lib/esm/ActivityIndicator/Dots.native.js

@@ -0,0 +1,212 @@
+import React from 'react';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Animated from "react-native-web/dist/exports/Animated";
+import Easing from "react-native-web/dist/exports/Easing";
+import Svg, { Circle } from 'react-native-svg';
+import { DOTS_TOTAL_ANIMATION_DURATION, OVERSHOOT_FACTOR, UNDERSHOOT_FACTOR, DOTS_SPACING_X, DOTS_BASE_Y_FACTOR, DOTS_JUMP_HEIGHT_FACTOR, DOTS_PADDING_FACTOR, DOT_FADEOUT_INPUT_RANGE, DOT_FADEOUT_OUTPUT_RANGE, DOT1_ANIMATION_INPUT_RANGE, DOT2_ANIMATION_INPUT_RANGE, DOT3_ANIMATION_INPUT_RANGE, propTypes } from './shared';
+import { useA11yInfo } from '../A11yInfoProvider';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const AnimatedCircle = Animated.createAnimatedComponent(Circle);
+const Dots = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    size,
+    color,
+    indicatorBackgroundColor,
+    label,
+    isStatic = false
+  } = _ref;
+  const {
+    reduceMotionEnabled
+  } = useA11yInfo();
+  const reduceMotion = reduceMotionEnabled || isStatic;
+  const spacingX = size + DOTS_SPACING_X;
+  const baseY = size * DOTS_BASE_Y_FACTOR;
+  const jumpHeight = size * DOTS_JUMP_HEIGHT_FACTOR;
+  const padding = size * DOTS_PADDING_FACTOR;
+  const width = (size + 1) * 6;
+  const height = size * 6;
+  const animationValue = React.useRef(new Animated.Value(0)).current;
+  React.useEffect(() => {
+    if (reduceMotion) {
+      animationValue.stopAnimation();
+      animationValue.setValue(0);
+      return () => {};
+    }
+    const loopAnimation = Animated.loop(Animated.timing(animationValue, {
+      toValue: 1,
+      duration: DOTS_TOTAL_ANIMATION_DURATION,
+      easing: Easing.linear,
+      useNativeDriver: false
+    }));
+    loopAnimation.start();
+    return () => loopAnimation.stop();
+  }, [reduceMotion, animationValue]);
+  const makeStepInterpolation = steps => {
+    const inputRange = [];
+    const outputRange = [];
+    steps.forEach(_ref2 => {
+      let {
+        time,
+        value
+      } = _ref2;
+      inputRange.push(time);
+      outputRange.push(value);
+    });
+    return {
+      inputRange,
+      outputRange
+    };
+  };
+
+  // ---- DOT 1 ----
+  const dot1Cy = animationValue.interpolate({
+    inputRange: DOT1_ANIMATION_INPUT_RANGE,
+    outputRange: [baseY, baseY - jumpHeight * OVERSHOOT_FACTOR, baseY + jumpHeight * UNDERSHOOT_FACTOR, baseY],
+    extrapolate: 'clamp'
+  });
+  const {
+    inputRange: dot1FillInputRange,
+    outputRange: dot1FillOutputRange
+  } = makeStepInterpolation([{
+    time: 0,
+    value: color
+  }, {
+    time: 0.3,
+    value: color
+  }, {
+    time: 0.4,
+    value: indicatorBackgroundColor
+  }, {
+    time: 1,
+    value: indicatorBackgroundColor
+  }]);
+  const dot1Fill = animationValue.interpolate({
+    inputRange: dot1FillInputRange,
+    outputRange: dot1FillOutputRange,
+    extrapolate: 'clamp'
+  });
+
+  // Fade-out Dot 1
+  const dot1Opacity = animationValue.interpolate({
+    inputRange: DOT_FADEOUT_INPUT_RANGE,
+    outputRange: DOT_FADEOUT_OUTPUT_RANGE,
+    extrapolate: 'clamp'
+  });
+
+  // ---- DOT 2 ----
+  const dot2Cy = animationValue.interpolate({
+    inputRange: DOT2_ANIMATION_INPUT_RANGE,
+    outputRange: [baseY, baseY, baseY - jumpHeight * OVERSHOOT_FACTOR, baseY + jumpHeight * UNDERSHOOT_FACTOR, baseY],
+    extrapolate: 'clamp'
+  });
+  const {
+    inputRange: dot2FillInputRange,
+    outputRange: dot2FillOutputRange
+  } = makeStepInterpolation([{
+    time: 0,
+    value: indicatorBackgroundColor
+  }, {
+    time: 0.3,
+    value: indicatorBackgroundColor
+  }, {
+    time: 0.4,
+    value: color
+  }, {
+    time: 0.6,
+    value: color
+  }, {
+    time: 0.7,
+    value: indicatorBackgroundColor
+  }, {
+    time: 1,
+    value: indicatorBackgroundColor
+  }]);
+  const dot2Fill = animationValue.interpolate({
+    inputRange: dot2FillInputRange,
+    outputRange: dot2FillOutputRange,
+    extrapolate: 'clamp'
+  });
+
+  // Fade-out Dot 2
+  const dot2Opacity = animationValue.interpolate({
+    inputRange: DOT_FADEOUT_INPUT_RANGE,
+    outputRange: DOT_FADEOUT_OUTPUT_RANGE,
+    extrapolate: 'clamp'
+  });
+
+  // ---- DOT 3 ----
+  const dot3Cy = animationValue.interpolate({
+    inputRange: DOT3_ANIMATION_INPUT_RANGE,
+    outputRange: [baseY, baseY, baseY - jumpHeight * OVERSHOOT_FACTOR, baseY + jumpHeight * UNDERSHOOT_FACTOR, baseY],
+    extrapolate: 'clamp'
+  });
+  const {
+    inputRange: dot3FillInputRange,
+    outputRange: dot3FillOutputRange
+  } = makeStepInterpolation([{
+    time: 0,
+    value: indicatorBackgroundColor
+  }, {
+    time: 0.5,
+    value: indicatorBackgroundColor
+  }, {
+    time: 0.6,
+    value: color
+  }, {
+    time: 0.8,
+    value: color
+  }, {
+    time: 1,
+    value: color
+  }]);
+  const dot3Fill = animationValue.interpolate({
+    inputRange: dot3FillInputRange,
+    outputRange: dot3FillOutputRange,
+    extrapolate: 'clamp'
+  });
+  const dot3Opacity = new Animated.Value(1);
+  return /*#__PURE__*/_jsx(View, {
+    ref: ref,
+    style: styles.container,
+    accessible: true,
+    accessibilityLabel: label,
+    accessibilityRole: "progressbar",
+    accessibilityState: {
+      busy: true
+    },
+    children: /*#__PURE__*/_jsxs(Svg, {
+      width: width,
+      height: height,
+      viewBox: `0 0 ${width} ${height}`,
+      children: [/*#__PURE__*/_jsx(AnimatedCircle, {
+        cx: size,
+        cy: reduceMotion ? baseY : dot1Cy,
+        r: padding,
+        fill: reduceMotion ? color : dot1Fill,
+        opacity: reduceMotion ? 1 : dot1Opacity
+      }), /*#__PURE__*/_jsx(AnimatedCircle, {
+        cx: 2 * size + spacingX,
+        cy: reduceMotion ? baseY : dot2Cy,
+        r: padding,
+        fill: reduceMotion ? indicatorBackgroundColor : dot2Fill,
+        opacity: reduceMotion ? 1 : dot2Opacity
+      }), /*#__PURE__*/_jsx(AnimatedCircle, {
+        cx: 3 * size + 2 * spacingX,
+        cy: reduceMotion ? baseY : dot3Cy,
+        r: padding,
+        fill: reduceMotion ? indicatorBackgroundColor : dot3Fill,
+        opacity: reduceMotion ? 1 : dot3Opacity
+      })]
+    })
+  });
+});
+Dots.displayName = 'Dots';
+Dots.propTypes = propTypes;
+const styles = StyleSheet.create({
+  container: {
+    alignItems: 'center',
+    justifyContent: 'center'
+  }
+});
+export default Dots;

package/lib/esm/ActivityIndicator/Spinner.js

@@ -1,28 +1,16 @@
 import React from 'react';
-import { DURATION, MIN_EMPTY_ANGLE, MIN_STROKE_ANGLE, BEZIER, propTypes } from './shared';
+import { DURATION, SVG_CIRCUMFERENCE, SVG_SIZE, ROTATION_TRANSFORM, SVG_CENTER, SPINNER_RADIUS, SPINNER_ROTATION_DEGREES, SPINNER_DASHARRAY_MIN, SPINNER_DASHARRAY_MAX, SPINNER_KEYTIMES, SPINNER_DASHARRAY_HALF, SPINNER_DASHOFFSET_FACTOR, propTypes } from './shared';
 import { useA11yInfo } from '../A11yInfoProvider';
 import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-const SVG_RADIUS = 20;
-const SVG_CIRCUMFERENCE = SVG_RADIUS * 2 * Math.PI;
-const MIN_SVG_LENGTH = MIN_STROKE_ANGLE / 360 * SVG_CIRCUMFERENCE;
-const MAX_SVG_LENGTH = (1 - MIN_EMPTY_ANGLE / 360) * SVG_CIRCUMFERENCE;
-const animationProps = {
-  begin: '0s',
-  dur: `${DURATION}ms`,
-  fill: 'freeze',
+const animateProps = {
+  keyTimes: SPINNER_KEYTIMES,
   repeatCount: 'indefinite'
 };
-const bezierProps = {
-  calcMode: 'spline',
-  keyTimes: '0; 0.5; 1',
-  keySplines: `${BEZIER.join(', ')} ; ${BEZIER.join(', ')}`
-};
-// We're using svg rather than css here to define the animation to avoid needing to introduce css injection mechanism
-// It's possible to replicate this functionality with RNW animations, but it snags on chrome at least, see https://github.com/telus/universal-design-system/pull/477 for details.
 const Spinner = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   let {
     size,
     color,
+    indicatorBackgroundColor,
     thickness,
     label,
     isStatic = false
@@ -31,46 +19,65 @@ const Spinner = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     reduceMotionEnabled
   } = useA11yInfo();
   const reduceMotion = reduceMotionEnabled || isStatic;
-  return /*#__PURE__*/_jsx("svg", {
+  const strokeWidth = thickness * SVG_SIZE / size;
+  return /*#__PURE__*/_jsxs("svg", {
     ref: ref,
     width: `${size}px`,
     height: `${size}px`,
-    viewBox: "0 0 48 48",
+    viewBox: `0 0 ${SVG_SIZE} ${SVG_SIZE}`,
     "aria-valuetext": label,
     role: "progressbar",
-    "aria-busy": true,
-    children: /*#__PURE__*/_jsxs("g", {
-      children: [reduceMotion ? null : /*#__PURE__*/_jsx("animateTransform", {
-        attributeName: "transform",
-        type: "rotate",
-        values: `-180 24 24;${360 + MIN_STROKE_ANGLE - 180} 24 24`,
-        ...animationProps
-      }), /*#__PURE__*/_jsx("circle", {
-        fill: "none",
-        stroke: color,
-        strokeWidth: thickness * 48 / size,
-        strokeLinecap: "round",
-        cx: "24",
-        cy: "24",
-        r: "20",
-        strokeDasharray: reduceMotion ? MAX_SVG_LENGTH : [MIN_SVG_LENGTH, SVG_CIRCUMFERENCE],
-        strokeDashoffset: 0,
-        vectorEffect: "non-scaling-stroke",
-        children: reduceMotion ? null : /*#__PURE__*/_jsxs(_Fragment, {
-          children: [/*#__PURE__*/_jsx("animate", {
-            attributeName: "stroke-dashoffset",
-            values: `0;-10;${MIN_SVG_LENGTH - SVG_CIRCUMFERENCE}`,
-            ...animationProps,
-            ...bezierProps
-          }), /*#__PURE__*/_jsx("animate", {
-            attributeName: "stroke-dasharray",
-            values: `${MIN_SVG_LENGTH}, 200;${MAX_SVG_LENGTH}, 200;${MIN_SVG_LENGTH}, 200`,
-            ...animationProps,
-            ...bezierProps
-          })]
-        })
-      })]
-    })
+    "aria-busy": "true",
+    children: [/*#__PURE__*/_jsx("circle", {
+      fill: "none",
+      stroke: indicatorBackgroundColor,
+      strokeWidth: strokeWidth,
+      cx: SVG_CENTER,
+      cy: SVG_CENTER,
+      r: SPINNER_RADIUS
+    }), /*#__PURE__*/_jsx("circle", {
+      fill: "none",
+      stroke: color,
+      strokeWidth: strokeWidth,
+      strokeLinecap: "round",
+      cx: SVG_CENTER,
+      cy: SVG_CENTER,
+      r: SPINNER_RADIUS,
+      strokeDasharray: `${SPINNER_DASHARRAY_MIN * SVG_CIRCUMFERENCE}, ${SPINNER_DASHARRAY_MAX * SVG_CIRCUMFERENCE}`,
+      strokeDashoffset: "0"
+      // Circle rotated -90° so that 0% is at the top (12 o'clock).
+      ,
+      transform: ROTATION_TRANSFORM,
+      children: reduceMotion ? null : /*#__PURE__*/_jsxs(_Fragment, {
+        children: [/*#__PURE__*/_jsx("animateTransform", {
+          attributeName: "transform",
+          type: "rotate",
+          from: "0 24 24",
+          to: `${SPINNER_ROTATION_DEGREES} ${SVG_CENTER} ${SVG_CENTER}`,
+          dur: `${DURATION}ms`,
+          repeatCount: "indefinite",
+          additive: "sum"
+        }), /*#__PURE__*/_jsx("animate", {
+          attributeName: "stroke-dasharray",
+          dur: `${DURATION}ms`,
+          values: `
+                  ${SPINNER_DASHARRAY_MIN * SVG_CIRCUMFERENCE},${SPINNER_DASHARRAY_MAX * SVG_CIRCUMFERENCE};
+                  ${SPINNER_DASHARRAY_HALF * SVG_CIRCUMFERENCE},${SPINNER_DASHARRAY_HALF * SVG_CIRCUMFERENCE};
+                  ${SPINNER_DASHARRAY_MIN * SVG_CIRCUMFERENCE},${SPINNER_DASHARRAY_MAX * SVG_CIRCUMFERENCE}
+                `,
+          ...animateProps
+        }), /*#__PURE__*/_jsx("animate", {
+          attributeName: "stroke-dashoffset",
+          dur: `${DURATION}ms`,
+          values: `
+                  0;
+                  0;
+                  -${SPINNER_DASHOFFSET_FACTOR * SVG_CIRCUMFERENCE}
+                `,
+          ...animateProps
+        })]
+      })
+    })]
   });
 });
 Spinner.displayName = 'Spinner';