@telus-uds/components-base 1.73.0 → 1.75.0

package/CHANGELOG.md

@@ -1,19 +1,43 @@
 # Change Log - @telus-uds/components-base
 
-This log was last generated on Mon, 08 Jan 2024 20:08:06 GMT and should not be manually modified.
+This log was last generated on Mon, 29 Jan 2024 18:26:01 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.75.0
+
+Mon, 29 Jan 2024 18:26:01 GMT
+
+### Minor changes
+
+- Styles changed in notification component to be SSR (35577399+JoshHC@users.noreply.github.com)
+- Bump @telus-uds/system-theme-tokens to v2.50.1
+
+## 1.74.0
+
+Thu, 18 Jan 2024 22:55:53 GMT
+
+### Minor changes
+
+- refactor footnote component for multi-platform (guillermo.peitzner@telus.com)
+- introducing inheritedStyles prop for responsive (srikanthkhari@gmail.com)
+- Bump @telus-uds/system-theme-tokens to v2.50.0
+
+### Patches
+
+- expandcollapse doesn't expand in react native (guillermo.peitzner@telus.com)
+- Typography ignoring viewport-based theme rules with enableMediaQueryStylesheet set to false Fixed. (srikanthkhari@gmail.com)
+
 ## 1.73.0
 
-Mon, 08 Jan 2024 20:08:06 GMT
+Mon, 08 Jan 2024 20:16:06 GMT
 
 ### Minor changes
 
 - RNMQ integration to Responsive component (srikanthkhari@gmail.com)
 - Changes in the Notification component (35577399+JoshHC@users.noreply.github.com)
 - Support server component (wlsdud194@hotmail.com)
-- Changes to the box component for allow gradient in mobile  (35577399+JoshHC@users.noreply.github.com)
+- Changes to the box component for allow gradient in mobile (35577399+JoshHC@users.noreply.github.com)
 - update story for badge to include subtle variant (evander.owusu@telus.com)
 - Bump @telus-uds/system-theme-tokens to v2.49.0
 

package/lib/ExpandCollapse/Panel.js

@@ -174,7 +174,7 @@ const ExpandCollapsePanel = /*#__PURE__*/(0, _react.forwardRef)((_ref4, ref) =>
         },
         children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
           style: selectContainerStyles(themeTokens),
-          children: isExpanded ? children : null
+          children: children
         })
       })
     })]

package/lib/Footnote/Footnote.js

@@ -0,0 +1,328 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(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 _Dimensions = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Dimensions"));
+var _TouchableWithoutFeedback = _interopRequireDefault(require("react-native-web/dist/cjs/exports/TouchableWithoutFeedback"));
+var _Modal = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Modal"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _SafeAreaView = _interopRequireDefault(require("react-native-web/dist/cjs/exports/SafeAreaView"));
+var _ScrollView = _interopRequireDefault(require("react-native-web/dist/cjs/exports/ScrollView"));
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+var _utils = require("../utils");
+var _ViewportProvider = require("../ViewportProvider");
+var _ThemeProvider = require("../ThemeProvider");
+var _Typography = _interopRequireDefault(require("../Typography"));
+var _Icon = _interopRequireDefault(require("../Icon"));
+var _OrderedList = _interopRequireDefault(require("../OrderedList"));
+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 [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.htmlAttrs, _utils.viewProps]);
+const selectFootnoteStyle = _ref => {
+  let {
+    screenHeight,
+    footnoteBackground,
+    isVisible,
+    footnoteBorderTopSizeMd,
+    footnoteBorderColorMd
+  } = _ref;
+  return {
+    left: 0,
+    backgroundColor: footnoteBackground,
+    display: isVisible ? 'flex' : 'none',
+    height: screenHeight,
+    borderTopColor: footnoteBorderColorMd,
+    borderTopWidth: footnoteBorderTopSizeMd
+  };
+};
+const selectFootnoteHeaderContentStyle = _ref2 => {
+  let {
+    footnoteHeaderPaddingTop,
+    footnoteHeaderPaddingBottom,
+    footnoteHeaderPaddingRight,
+    footnoteHeaderPaddingLeft,
+    headerMargin
+  } = _ref2;
+  return {
+    paddingTop: footnoteHeaderPaddingTop,
+    paddingBottom: footnoteHeaderPaddingBottom,
+    paddingRight: footnoteHeaderPaddingRight,
+    paddingLeft: footnoteHeaderPaddingLeft,
+    marginRight: headerMargin
+  };
+};
+const selectFootnoteCloseButtonStyle = _ref3 => {
+  let {
+    closeButtonBorderSize,
+    closeButtonBorderColor,
+    closeButtonHeight,
+    closeButtonBackgroundColor,
+    closeButtonMarginTop,
+    closeButtonMarginRight,
+    closeButtonMarginBottom,
+    closeButtonMarginLeft,
+    closeButtonWidth
+  } = _ref3;
+  return {
+    backgroundColor: closeButtonBackgroundColor,
+    borderWidth: closeButtonBorderSize,
+    borderColor: closeButtonBorderColor,
+    height: closeButtonHeight,
+    marginTop: closeButtonMarginTop,
+    marginRight: closeButtonMarginRight,
+    marginBottom: closeButtonMarginBottom,
+    marginLeft: closeButtonMarginLeft,
+    width: closeButtonWidth
+  };
+};
+const selectFootnoteBodyStyle = _ref4 => {
+  let {
+    maxWidth,
+    footnoteBodyBackground,
+    footnoteBodyPaddingTop,
+    footnoteBodyPaddingRight,
+    footnoteBodyPaddingBottom,
+    footnoteBodyPaddingLeft,
+    screenWidth
+  } = _ref4;
+  return {
+    maxWidth,
+    backgroundColor: footnoteBodyBackground,
+    paddingTop: footnoteBodyPaddingTop,
+    paddingRight: footnoteBodyPaddingRight * 2,
+    paddingBottom: footnoteBodyPaddingBottom,
+    paddingLeft: footnoteBodyPaddingLeft,
+    width: screenWidth
+  };
+};
+const selectCustomContentFontStyle = _ref5 => {
+  let {
+    listItemColor,
+    listItemFontSize,
+    listItemLineHeight,
+    listItemPaddingLeft,
+    listItemFontName,
+    listItemFontWeight
+  } = _ref5;
+  return {
+    fontSize: listItemFontSize,
+    lineHeight: listItemLineHeight * listItemFontSize,
+    paddingLeft: listItemPaddingLeft,
+    color: listItemColor,
+    fontName: listItemFontName,
+    fontWeight: listItemFontWeight
+  };
+};
+
+/**
+ * Use `Footnote` to display a single legal content.
+ *
+ * ## Usage Criteria
+ *
+ * - Use `Footnote` to display a single legal statement
+ * - Display on top of all UI, including other sticky elements such as Cart Summary
+ * - Dismiss by clicking on the close button, clicking anywhere outside of the `Footnote`
+ * - Use copy to set language, ‘en’ for English or ‘fr’ for French
+ *
+ * ## Accessibility requirements
+ *
+ * - Only one instance of `Footnote` should display at a time
+ * - Place `Footnote` as the last element in the body or main
+ * - When `Footnote` is open, the inert prop must be set on all children of body excluding the Footnote
+ * - When `Footnote` is closed, focus must return to the initiating element
+ */
+const Footnote = _ref6 => {
+  let {
+    copy = 'en',
+    number = undefined,
+    content = undefined,
+    onClose,
+    isOpen = false,
+    tokens,
+    variant = {},
+    dictionary = _dictionary.default,
+    ...rest
+  } = _ref6;
+  const viewport = (0, _ViewportProvider.useViewport)();
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('Footnote', tokens, variant, {
+    viewport
+  });
+  const themeOptions = (0, _ThemeProvider.useTheme)();
+  const getCopy = (0, _utils.useCopy)({
+    dictionary,
+    copy
+  });
+  const [isVisible, setIsVisible] = (0, _react.useState)(false);
+  const screenHeight = _Dimensions.default.get('screen').height;
+  const screenWidth = _Dimensions.default.get('screen').width;
+  const getFootnoteBodyContent = (0, _react.useCallback)(() => {
+    if (!number || !content) {
+      return null;
+    }
+    if ( /*#__PURE__*/_react.default.isValidElement(content)) {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+        style: selectCustomContentFontStyle(themeTokens),
+        children: content
+      });
+    }
+    return (
+      /*#__PURE__*/
+      // TODO: Extract the OrderedList.Item from the array when the issue #4361 is fixed
+      (0, _jsxRuntime.jsx)(_OrderedList.default, {
+        start: number,
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_OrderedList.default.Item, {
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+            style: selectCustomContentFontStyle(themeTokens),
+            children: content
+          })
+        }, number)]
+      })
+    );
+  }, [content, number, themeTokens]);
+  (0, _react.useEffect)(() => {
+    if (isOpen) {
+      setIsVisible(true);
+    }
+  }, [isOpen]);
+  const closeFootnote = (0, _react.useCallback)((event, options) => {
+    onClose(event, options);
+    setIsVisible(false);
+  }, [onClose]);
+  const handleClose = event => closeFootnote(event, {
+    returnFocus: true
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+    ...selectProps(rest),
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Modal.default, {
+      visible: isVisible,
+      animationType: "slide",
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_SafeAreaView.default, {
+        style: staticStyles.container,
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_ScrollView.default, {
+          style: selectFootnoteStyle({
+            screenHeight,
+            isVisible,
+            ...themeTokens
+          }),
+          children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+            style: staticStyles.content,
+            children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+              style: [selectFootnoteHeaderContentStyle(themeTokens), staticStyles.headerContent],
+              children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Typography.default, {
+                tokens: {
+                  fontSize: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.headerFontSize,
+                  lineHeight: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.headerLineHeight
+                },
+                variant: {
+                  size: 'h4'
+                },
+                children: getCopy('heading')
+              }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_TouchableWithoutFeedback.default, {
+                onPress: handleClose,
+                accessibilityLabel: getCopy('close'),
+                children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+                  style: [selectFootnoteCloseButtonStyle(themeTokens), staticStyles.closeButton],
+                  children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Icon.default, {
+                    icon: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.closeIcon,
+                    tokens: {
+                      size: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.closeButtonIconSize
+                    }
+                  })
+                })
+              })]
+            }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+              style: selectFootnoteBodyStyle({
+                maxWidth: themeOptions.contentMaxWidth,
+                screenWidth,
+                ...themeTokens
+              }),
+              children: getFootnoteBodyContent()
+            })]
+          })
+        })
+      })
+    })
+  });
+};
+const copyShape = _propTypes.default.shape({
+  close: _propTypes.default.string.isRequired,
+  heading: _propTypes.default.string.isRequired
+});
+
+// If a language dictionary entry is provided, it must contain every key
+const dictionaryContentShape = _propTypes.default.shape({
+  a11yLabel: _propTypes.default.string.isRequired,
+  close: _propTypes.default.string.isRequired,
+  heading: _propTypes.default.string.isRequired
+});
+Footnote.propTypes = {
+  ...selectedSystemPropTypes,
+  tokens: (0, _utils.getTokensPropType)('Footnote'),
+  /**
+   * The content.
+   */
+  content: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.element]),
+  /**
+   * Use the `copy` prop to either select provided English or French copy by passing 'en' or 'fr' respectively.
+   * To provide your own, pass a JSON object with the keys `heading` and `close`.
+   */
+  copy: _propTypes.default.oneOfType([_propTypes.default.oneOf(['en', 'fr']), copyShape]),
+  /**
+   * A boolean flag used hide or show the `Footnote`. Set to `true` to open the `Footnote`.
+   */
+  isOpen: _propTypes.default.bool,
+  /**
+   * The number, must match the number of the `FootnoteLink` that initiated the `Footnote`.
+   */
+  number: _propTypes.default.number,
+  /**
+   * A callback function to handle the closing of the footnote.
+   *
+   * @param {SyntheticEvent} event The React `SyntheticEvent`
+   * @param {Object} options Custom options
+   * @param {boolean} options.returnFocus Should the `Footnote` return focus on close
+   */
+  onClose: _propTypes.default.func.isRequired,
+  /**
+   * Override the default dictionary, by passing the complete dictionary object for `en` and `fr`
+   */
+  dictionary: _propTypes.default.shape({
+    en: dictionaryContentShape,
+    fr: dictionaryContentShape
+  })
+};
+var _default = Footnote;
+exports.default = _default;
+const staticStyles = _StyleSheet.default.create({
+  container: {
+    flex: 1
+  },
+  content: {
+    marginLeft: 'auto',
+    marginRight: 'auto',
+    left: 0,
+    right: 0,
+    maxWidth: 1200,
+    paddingBottom: 100
+  },
+  headerContent: {
+    alignItems: 'center',
+    display: 'flex',
+    flexDirection: 'row',
+    justifyContent: 'space-between'
+  },
+  closeButton: {
+    alignItems: 'center',
+    borderRadius: 50,
+    display: 'flex',
+    justifyContent: 'center'
+  }
+});

package/lib/Footnote/FootnoteLink.js

@@ -0,0 +1,108 @@
+"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 _TouchableWithoutFeedback = _interopRequireDefault(require("react-native-web/dist/cjs/exports/TouchableWithoutFeedback"));
+var _dictionary = _interopRequireDefault(require("./dictionary"));
+var _utils = require("../utils");
+var _ThemeProvider = require("../ThemeProvider");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.htmlAttrs, _utils.viewProps]);
+
+// The top property varies between devices due to how devices render the viewport.
+const selectTextStyle = _ref => {
+  let {
+    fontSize,
+    lineHeight
+  } = _ref;
+  return {
+    fontSize,
+    lineHeight: lineHeight !== 1 ? lineHeight : fontSize * 2,
+    ..._Platform.default.select({
+      ios: {
+        top: -fontSize / 2
+      },
+      android: {
+        top: fontSize / 4
+      },
+      web: {
+        top: -fontSize / 2.8
+      }
+    })
+  };
+};
+const FootnoteLink = _ref2 => {
+  let {
+    copy = 'en',
+    content = [],
+    onClick,
+    tokens,
+    variant = {},
+    ...rest
+  } = _ref2;
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('FootnoteLink', tokens, variant);
+  const textStyles = (0, _ThemeProvider.applyTextStyles)(themeTokens);
+  const numbers = Array.isArray(content) ? content : [content];
+  const refs = numbers.map(() => /*#__PURE__*/_react.default.createRef());
+  const handleOnClick = index => {
+    onClick(numbers[index], refs[index]);
+  };
+  const getCopy = (0, _utils.useCopy)({
+    dictionary: _dictionary.default,
+    copy
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+    children: numbers.map((num, index) => /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      accessibilityLabel: getCopy('a11yLabel'),
+      ref: refs[index],
+      ...selectProps(rest),
+      children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_TouchableWithoutFeedback.default, {
+        onPress: handleOnClick,
+        accessibilityRole: "button",
+        children: (0, _utils.wrapStringsInText)(`${num}${index !== numbers.length - 1 ? ',' : ''}`, {
+          style: {
+            ...textStyles,
+            ...staticStyles.text,
+            ...selectTextStyle(themeTokens)
+          }
+        })
+      })
+    }, num))
+  });
+};
+const copyShape = _propTypes.default.shape({
+  a11yLabel: _propTypes.default.string.isRequired
+});
+FootnoteLink.propTypes = {
+  ...selectedSystemPropTypes,
+  /**
+   * Use the `copy` prop to either select provided English or French copy by passing 'en' or 'fr' respectively.
+   * To provide your own, pass a JSON object with the key `a11yLabel`.
+   */
+  copy: _propTypes.default.oneOfType([_propTypes.default.oneOf(['en', 'fr']), copyShape]),
+  /**
+   * The footnote number, or multiple numbers if passed as an array.
+   * If using an array, a comma-separated group of numbers will be rendered as superscript.
+   */
+  content: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.arrayOf(_propTypes.default.number), _propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]).isRequired,
+  /**
+   * A callback function to handle the click of a FootnoteLink.
+   */
+  onClick: _propTypes.default.func.isRequired
+};
+var _default = FootnoteLink;
+exports.default = _default;
+const staticStyles = _StyleSheet.default.create({
+  text: {
+    position: 'relative',
+    textDecorationLine: 'underline'
+  }
+});

package/lib/Footnote/dictionary.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  en: {
+    a11yLabel: 'Read legal footnote',
+    close: 'close',
+    heading: 'Terms and conditions'
+  },
+  fr: {
+    a11yLabel: 'Lire la note de bas de page légale',
+    close: 'fermer',
+    heading: 'Modalités et conditions'
+  }
+};
+exports.default = _default;

package/lib/Footnote/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _Footnote = _interopRequireDefault(require("./Footnote"));
+var _FootnoteLink = _interopRequireDefault(require("./FootnoteLink"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+_Footnote.default.Link = _FootnoteLink.default;
+var _default = _Footnote.default;
+exports.default = _default;