@telus-uds/components-base 0.0.2-prerelease.4 → 0.0.2-prerelease.8

package/lib/ToggleSwitch/index.js

@@ -1,2 +1,13 @@
-import ToggleSwitch from './ToggleSwitch';
-export default ToggleSwitch;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ToggleSwitch = _interopRequireDefault(require("./ToggleSwitch"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _default = _ToggleSwitch.default;
+exports.default = _default;

package/lib/Tooltip/Backdrop.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("react");
+
+var _reactDom = _interopRequireDefault(require("react-dom"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function createPortalNode(nodeId) {
+  const node = document.createElement('div');
+  node.id = nodeId; // we're mimicking React Native's Modal component, except for using an `absolute` position
+  // this way the backdrop stays in place when scrolling the window - that's why we need to
+  // position it at the scroll position when rendering
+
+  node.style.cssText = "\n  position: absolute; \n  top: ".concat(window.scrollY, "px;\n  left: ").concat(window.scrollX, "px; \n  right: 0; \n  bottom: 0; \n  z-index: 9999; \n  pointer-events: none;\n  ");
+  document.body.appendChild(node);
+  return node;
+}
+
+function removePortalNode(nodeId) {
+  const node = document.getElementById(nodeId);
+  node.parentElement.removeChild(node);
+}
+/**
+ * The Web version of Backdrop utilizes React Portal for overlaying page content, so it is
+ * dependent on ReactDOM. Tooltip's closing is handled by the onBlur callback of the control.
+ */
+
+
+function Backdrop({
+  children
+}) {
+  const [portalNode, setPortalNode] = (0, _react.useState)();
+  (0, _react.useEffect)(() => {
+    const nodeId = "tooltip-backdrop-".concat(Date.now());
+    const node = createPortalNode(nodeId);
+    setPortalNode(node);
+    return () => {
+      removePortalNode(nodeId);
+    };
+  }, []);
+  return portalNode ? /*#__PURE__*/_reactDom.default.createPortal(children, portalNode) : null;
+}
+
+Backdrop.propTypes = {
+  children: _propTypes.default.node
+};
+var _default = Backdrop;
+exports.default = _default;

package/lib/Tooltip/Backdrop.native.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _TouchableWithoutFeedback = _interopRequireDefault(require("react-native-web/dist/cjs/exports/TouchableWithoutFeedback"));
+
+var _Modal = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Modal"));
+
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * The Native version of Backdrop utilizes React Native's Modal component for overlaying
+ * the app's content, since this is the only reliable to do it. The only drawback of this
+ * approach is that a press on the Backdrop will actually stop the press event from propagating,
+ * i.e. anything rendered beneath the Backdrop can't be pressed until the Backdrop is closed.
+ */
+function Backdrop({
+  onPress,
+  children
+}) {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Modal.default, {
+    transparent: true,
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_TouchableWithoutFeedback.default, {
+      onPress: onPress,
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+        style: staticStyles.backdrop,
+        children: children
+      })
+    })
+  });
+}
+
+var _default = Backdrop;
+exports.default = _default;
+Backdrop.propTypes = {
+  onPress: _propTypes.default.func,
+  children: _propTypes.default.node
+};
+
+const staticStyles = _StyleSheet.default.create({
+  backdrop: {
+    flexBasis: '100%',
+    backgroundColor: 'rgba(255, 255, 255, 0.5)' // to visually mark that the content beneath is not pressable
+
+  }
+});

package/lib/Tooltip/Tooltip.js

@@ -0,0 +1,357 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _Dimensions = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Dimensions"));
+
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+
+var _Pressable = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Pressable"));
+
+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 _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _utils = require("../utils");
+
+var _Backdrop = _interopRequireDefault(require("./Backdrop"));
+
+var _getTooltipPosition = _interopRequireDefault(require("./getTooltipPosition"));
+
+var _TooltipButton = _interopRequireDefault(require("../TooltipButton"));
+
+var _useCopy = _interopRequireDefault(require("../utils/useCopy"));
+
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+
+var _jsxRuntime = require("react/jsx-runtime");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const selectTooltipStyles = ({
+  backgroundColor,
+  paddingTop,
+  paddingBottom,
+  paddingLeft,
+  paddingRight,
+  borderRadius
+}) => ({
+  backgroundColor,
+  paddingTop,
+  paddingBottom,
+  paddingLeft,
+  paddingRight,
+  borderRadius
+});
+
+const selectTooltipShadowStyles = ({
+  shadow,
+  borderRadius
+}) => ({
+  borderRadius,
+  ...(0, _ThemeProvider.applyShadowToken)(shadow)
+});
+
+const selectTooltipPositionStyles = ({
+  top,
+  left,
+  width
+}) => {
+  return {
+    top,
+    left,
+    width
+  };
+};
+
+const selectArrowStyles = ({
+  backgroundColor,
+  arrowWidth,
+  arrowBorderRadius,
+  shadow
+}, {
+  position,
+  width: tooltipWidth,
+  height: tooltipHeight
+}) => {
+  // the arrow width is actually a diagonal of the rectangle that we'll use as a tip
+  const rectangleSide = Math.sqrt(arrowWidth * arrowWidth / 2); // position the arrow at the side and center of the tooltip - this happens before rotation
+  // so we use the rectangle size as basis
+
+  const verticalOffset = -1 * rectangleSide / 2;
+  const horizontalOffset = rectangleSide / 2; // percentage-based absolute positioning doesn't act well on native, so we have to
+  // calculate the pixel values
+
+  const directionalStyles = {
+    above: {
+      bottom: verticalOffset,
+      left: tooltipWidth / 2 - horizontalOffset,
+      transform: [{
+        rotateZ: '45deg'
+      }]
+    },
+    below: {
+      top: verticalOffset,
+      left: tooltipWidth / 2 - horizontalOffset,
+      transform: [{
+        rotateZ: '-135deg'
+      }]
+    },
+    left: {
+      right: verticalOffset,
+      top: tooltipHeight / 2 - horizontalOffset,
+      transform: [{
+        rotateZ: '-45deg'
+      }]
+    },
+    right: {
+      left: verticalOffset,
+      top: tooltipHeight / 2 - horizontalOffset,
+      transform: [{
+        rotateZ: '135deg'
+      }]
+    }
+  };
+  return {
+    backgroundColor,
+    width: rectangleSide,
+    height: rectangleSide,
+    borderBottomRightRadius: arrowBorderRadius,
+    // this corner will be the arrow tip after rotation
+    ...(0, _ThemeProvider.applyShadowToken)(shadow),
+    ...directionalStyles[position]
+  };
+};
+
+const selectTextStyles = tokens => (0, _ThemeProvider.applyTextStyles)((0, _utils.selectTokens)('Typography', tokens));
+
+const defaultControl = (pressableState, variant) => /*#__PURE__*/(0, _jsxRuntime.jsx)(_TooltipButton.default, {
+  pressableState: pressableState,
+  variant: variant
+});
+/**
+ * Tooltip provides a descriptive and detailed explanation or instructions. It can be used next to an input label
+ * to help a user fill it in, or as a standalone component.
+ *
+ * By default the TooltipButton component will be used as a control for triggering the tooltip, but you may attach
+ * a tooltip to any other component. A render function can be used to adjust the control's styling on state changes (hover, focus, etc.).
+ *
+ * ### Positioning
+ * By default a Tooltip will be automatically positioned in a way that ensures it fits within the viewport.
+ * You may suggest a position with a prop - it will be used, unless the tooltip would end up outside the viewport.
+ *
+ * ### Usage criteria
+ * - You may use one when the information is useful only to a small percentage of users (ie. tech savvy people wouldn't need this info).
+ * - Tooltips may also be useful when vertical space is an issue.
+ */
+
+
+const Tooltip = ({
+  children,
+  content,
+  position = 'auto',
+  copy = 'en',
+  tokens,
+  variant
+}) => {
+  const [isOpen, setIsOpen] = (0, _react.useState)(false);
+  const controlRef = (0, _react.useRef)();
+  const [controlLayout, setControlLayout] = (0, _react.useState)(null);
+  const [tooltipDimensions, setTooltipDimensions] = (0, _react.useState)(null);
+  const [windowDimensions, setWindowDimensions] = (0, _react.useState)(_Dimensions.default.get('window'));
+  const [tooltipPosition, setTooltipPosition] = (0, _react.useState)(null);
+  const getCopy = (0, _useCopy.default)({
+    dictionary: _dictionary.default,
+    copy
+  });
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Tooltip', tokens, variant);
+  const {
+    arrowWidth,
+    arrowOffset
+  } = themeTokens;
+  (0, _react.useEffect)(() => {
+    const subscription = _Dimensions.default.addEventListener('change', ({
+      window
+    }) => {
+      setWindowDimensions(window);
+    });
+
+    return () => subscription === null || subscription === void 0 ? void 0 : subscription.remove();
+  });
+
+  const toggleIsOpen = () => setIsOpen(!isOpen);
+
+  const close = () => setIsOpen(false);
+
+  const getPressableState = ({
+    pressed,
+    hovered,
+    focused
+  }) => ({
+    pressed,
+    hover: hovered,
+    focus: focused
+  });
+
+  const onTooltipLayout = ({
+    nativeEvent: {
+      layout: {
+        width,
+        height
+      }
+    }
+  }) => {
+    if (tooltipDimensions === null || tooltipDimensions.width !== width || tooltipDimensions.height !== height) {
+      setTooltipDimensions({
+        width: _Platform.default.select({
+          web: width + 0.3,
+          // avoids often unnecessary line breaks due to subpixel rendering of fonts
+          native: width
+        }),
+        height
+      });
+    }
+  };
+
+  (0, _react.useEffect)(() => {
+    if (isOpen) {
+      controlRef.current.measureInWindow((x, y, width, height) => {
+        setControlLayout({
+          x,
+          y,
+          width,
+          height
+        });
+      });
+    } else {
+      setControlLayout(null);
+      setTooltipDimensions(null);
+      setTooltipPosition(null);
+    }
+  }, [isOpen]);
+  (0, _react.useEffect)(() => {
+    setIsOpen(false);
+  }, [windowDimensions]);
+  (0, _react.useEffect)(() => {
+    if (tooltipPosition !== null && !(tooltipPosition !== null && tooltipPosition !== void 0 && tooltipPosition.isNormalized) || !isOpen || controlLayout === null || tooltipDimensions == null) {
+      return;
+    }
+
+    const updatedPosition = (0, _getTooltipPosition.default)(position, {
+      controlLayout,
+      tooltipDimensions,
+      windowDimensions,
+      arrowWidth,
+      arrowOffset
+    }); // avoid ending up in an infinite normalization loop
+
+    if (tooltipPosition !== null && tooltipPosition !== void 0 && tooltipPosition.isNormalized && updatedPosition.isNormalized) {
+      return;
+    }
+
+    setTooltipPosition(updatedPosition);
+  }, [isOpen, position, tooltipDimensions, controlLayout, windowDimensions, arrowWidth, arrowOffset, tooltipPosition]);
+  const control = children !== undefined ? children : defaultControl;
+  const pressableStyles = control === defaultControl ? _Platform.default.select({
+    web: {
+      outline: 'none'
+    }
+  }) : undefined;
+  const pressableHitSlop = control === defaultControl ? {
+    top: 10,
+    bottom: 10,
+    left: 10,
+    right: 10
+  } : undefined;
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+    style: staticStyles.container,
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Pressable.default, {
+      onPress: toggleIsOpen,
+      ref: controlRef,
+      onBlur: close,
+      style: pressableStyles,
+      hitSlop: pressableHitSlop,
+      accessibilityLabel: getCopy('a11yText'),
+      accessibilityRole: "button",
+      children: typeof control === 'function' ? pressableState => control(getPressableState(pressableState), variant) : control
+    }), isOpen && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Backdrop.default, {
+      onPress: close,
+      children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+        style: [staticStyles.tooltip, selectTooltipShadowStyles(themeTokens), // applied separately so that it doesn't cover the arrow
+        tooltipPosition && selectTooltipPositionStyles(tooltipPosition), (tooltipPosition === null || (tooltipPosition === null || tooltipPosition === void 0 ? void 0 : tooltipPosition.isNormalized)) && staticStyles.tooltipHidden // visually hide the tooltip until we have a final measurement
+        ],
+        onLayout: onTooltipLayout,
+        accessibilityRole: "alert",
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          style: [staticStyles.arrow, tooltipPosition && selectArrowStyles(themeTokens, tooltipPosition)]
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          style: selectTooltipStyles(themeTokens),
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+            style: selectTextStyles(themeTokens),
+            children: content
+          })
+        })]
+      })
+    })]
+  });
+};
+
+Tooltip.propTypes = {
+  /**
+   * Used to render the control (i.e. tooltip trigger). If a render function is used it will receive the
+   * pressable state and tooltip variant as an argument.
+   */
+  children: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.node]),
+
+  /**
+   * The message. Can be raw text or text components.
+   */
+  content: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]),
+
+  /**
+   * Select english or french copy for the accessible label.
+   */
+  copy: _propTypes.default.oneOf(['en', 'fr']),
+
+  /**
+   * Use to place the tooltip in a specific location (only if it fits within viewport).
+   */
+  position: _propTypes.default.oneOf(['auto', 'above', 'right', 'below', 'left']),
+  tokens: (0, _utils.getTokensPropType)('Tooltip'),
+  variant: _utils.variantProp.propType
+};
+var _default = Tooltip;
+exports.default = _default;
+
+const staticStyles = _StyleSheet.default.create({
+  container: {
+    alignItems: 'flex-start'
+  },
+  tooltip: {
+    position: 'absolute',
+    maxWidth: 240,
+    top: 0,
+    left: 0
+  },
+  tooltipHidden: {
+    opacity: 0
+  },
+  arrow: {
+    position: 'absolute'
+  }
+});

package/lib/Tooltip/dictionary.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  en: {
+    a11yText: 'Reveal additional information.'
+  },
+  fr: {
+    a11yText: 'Afficher des renseignements supplémentaires.'
+  }
+};
+exports.default = _default;

package/lib/Tooltip/getTooltipPosition.js

@@ -0,0 +1,172 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function normalizePosition(position) {
+  const {
+    left,
+    right,
+    bottom,
+    top,
+    width,
+    ...rest
+  } = position; // adjust the coordinates so that it fits within the window
+
+  const normalized = {
+    left: Math.max(0, left),
+    right: Math.max(0, right),
+    top: Math.max(0, top),
+    bottom // since it's ok the make the document grow downwards - no need to normalize here
+
+  };
+
+  const getAbsoluteDiff = (value1, value2) => Math.abs(Math.abs(value1) - Math.abs(value2)); // adjust the width by whatever has been subtracted from left or right
+
+
+  normalized.width = width - Math.abs(getAbsoluteDiff(left, normalized.left) - getAbsoluteDiff(right, normalized.right));
+
+  if (normalized.top !== top) {
+    normalized.bottom += normalized.top - top;
+  }
+
+  const isNormalized = normalized.right !== right || normalized.left !== left || normalized.top !== top;
+  return { ...normalized,
+    ...rest,
+    isNormalized
+  };
+}
+
+function invertPosition(position) {
+  switch (position) {
+    case 'above':
+      return 'below';
+
+    case 'below':
+      return 'above';
+
+    case 'left':
+      return 'right';
+
+    default:
+      return 'left';
+  }
+}
+
+function findRectByPosition(position, rectsArray) {
+  return rectsArray.find(({
+    position: rectPosition
+  }) => rectPosition === position);
+}
+/**
+ * Used for absolute positioning of the tooltip. Since the tooltip is always centered relatively
+ * to the control (button) and we have a limited set of positions, an easy and consistent way
+ * of positioning it is to check all of the possible positions and pick one that will be rendered
+ * within the window bounds. This way we can also rely on the tooltip being actually rendered
+ * before it is shown, which makes it account for the width being limiting in styles, custom font
+ * rendering, etc.
+ */
+
+
+function getTooltipPosition(position, {
+  controlLayout,
+  tooltipDimensions,
+  windowDimensions,
+  arrowWidth = 0,
+  arrowOffset = 0
+}) {
+  const {
+    width: controlWidth,
+    height: controlHeight,
+    x: controlX,
+    y: controlY
+  } = controlLayout;
+  const {
+    width: tooltipWidth,
+    height: tooltipHeight
+  } = tooltipDimensions;
+  const {
+    width: windowWidth,
+    height: windowHeight
+  } = windowDimensions;
+  const arrowSize = arrowWidth / 2 + arrowOffset;
+  const horizontalBounds = {
+    left: controlX + controlWidth / 2 - tooltipWidth / 2,
+    right: windowWidth - (controlX + controlWidth / 2 + tooltipWidth / 2)
+  };
+  const verticalBounds = {
+    top: controlY + controlHeight / 2 - tooltipHeight / 2,
+    bottom: windowHeight - (controlY + controlHeight / 2 + tooltipHeight / 2)
+  }; // calculate absolute coordinates for each of the potential positions (relative to window)
+
+  const boundingRects = [{
+    position: 'above',
+    ...horizontalBounds,
+    top: controlY - tooltipHeight - arrowSize,
+    bottom: windowHeight - (controlY - arrowSize)
+  }, {
+    position: 'right',
+    ...verticalBounds,
+    left: controlX + controlWidth + arrowSize,
+    right: windowWidth - (controlX + controlWidth + tooltipWidth + arrowSize)
+  }, {
+    position: 'below',
+    ...horizontalBounds,
+    top: controlY + controlHeight + arrowSize,
+    bottom: windowHeight - (controlY + controlHeight + tooltipHeight + arrowSize)
+  }, {
+    position: 'left',
+    ...verticalBounds,
+    left: controlX - tooltipWidth - arrowSize,
+    right: windowWidth - (controlX - arrowSize)
+  }].map(rect => {
+    // an absolute value representing how much of the tooltip is overflowing the window on each side
+    const windowOverflow = Math.abs(Math.min(rect.top, 0) - Math.min(rect.left, 0) - Math.min(rect.right, 0) - Math.min(rect.bottom, 0));
+    return { ...rect,
+      ...tooltipDimensions,
+      overflow: windowOverflow,
+      isNormalized: false
+    };
+  }); // the 'position' prop overrides the automatic positioning
+
+  if (position !== 'auto') {
+    let rect = findRectByPosition(position, boundingRects); // check if the suggested 'position' fits in window
+
+    if (rect.overflow === 0) {
+      return rect;
+    } // otherwise try the inverted position (e.g. left -> right)
+
+
+    rect = findRectByPosition(invertPosition(position), boundingRects);
+
+    if (rect.overflow === 0) {
+      return rect;
+    }
+  }
+
+  const inWindow = boundingRects.filter(({
+    overflow
+  }) => overflow === 0); // pick the first position that fits in window
+  // (these are sorted clockwise which makes them show where one would expect them to be)
+
+  if (inWindow.length > 0) {
+    return inWindow[0];
+  } // if all positions would end up being out of window bounds, let's pick the one that is
+  // the least overflowing and normalize its position to fit within window bounds
+
+
+  boundingRects.sort(({
+    overflow: overflowA
+  }, {
+    overflow: overflowB
+  }) => overflowA - overflowB);
+  const leastOverflowing = boundingRects[0]; // prefer 'below' over 'above', since we can always expand the document downwards,
+  // and 'above' might cause issues on small viewports with large tooltips
+
+  return normalizePosition(leastOverflowing.position === 'above' ? findRectByPosition('below', boundingRects) : leastOverflowing);
+}
+
+var _default = getTooltipPosition;
+exports.default = _default;

package/lib/Tooltip/index.js

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