@telus-uds/components-base 1.73.0 → 1.75.0

package/lib-module/Footnote/Footnote.js

@@ -0,0 +1,319 @@
+import React, { useEffect, useState, useCallback } from 'react';
+import PropTypes from 'prop-types';
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Text from "react-native-web/dist/exports/Text";
+import Dimensions from "react-native-web/dist/exports/Dimensions";
+import TouchableWithoutFeedback from "react-native-web/dist/exports/TouchableWithoutFeedback";
+import Modal from "react-native-web/dist/exports/Modal";
+import View from "react-native-web/dist/exports/View";
+import SafeAreaView from "react-native-web/dist/exports/SafeAreaView";
+import ScrollView from "react-native-web/dist/exports/ScrollView";
+import defaultDictionary from './dictionary';
+import { getTokensPropType, htmlAttrs, selectSystemProps, useCopy, viewProps } from '../utils';
+import { useViewport } from '../ViewportProvider';
+import { useTheme, useThemeTokens } from '../ThemeProvider';
+import Typography from '../Typography';
+import Icon from '../Icon';
+import OrderedList from '../OrderedList';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs, 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 = defaultDictionary,
+    ...rest
+  } = _ref6;
+  const viewport = useViewport();
+  const themeTokens = useThemeTokens('Footnote', tokens, variant, {
+    viewport
+  });
+  const themeOptions = useTheme();
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
+  const [isVisible, setIsVisible] = useState(false);
+  const screenHeight = Dimensions.get('screen').height;
+  const screenWidth = Dimensions.get('screen').width;
+  const getFootnoteBodyContent = useCallback(() => {
+    if (!number || !content) {
+      return null;
+    }
+    if ( /*#__PURE__*/React.isValidElement(content)) {
+      return /*#__PURE__*/_jsx(View, {
+        style: selectCustomContentFontStyle(themeTokens),
+        children: content
+      });
+    }
+    return (
+      /*#__PURE__*/
+      // TODO: Extract the OrderedList.Item from the array when the issue #4361 is fixed
+      _jsx(OrderedList, {
+        start: number,
+        children: [/*#__PURE__*/_jsx(OrderedList.Item, {
+          children: /*#__PURE__*/_jsx(Text, {
+            style: selectCustomContentFontStyle(themeTokens),
+            children: content
+          })
+        }, number)]
+      })
+    );
+  }, [content, number, themeTokens]);
+  useEffect(() => {
+    if (isOpen) {
+      setIsVisible(true);
+    }
+  }, [isOpen]);
+  const closeFootnote = useCallback((event, options) => {
+    onClose(event, options);
+    setIsVisible(false);
+  }, [onClose]);
+  const handleClose = event => closeFootnote(event, {
+    returnFocus: true
+  });
+  return /*#__PURE__*/_jsx(View, {
+    ...selectProps(rest),
+    children: /*#__PURE__*/_jsx(Modal, {
+      visible: isVisible,
+      animationType: "slide",
+      children: /*#__PURE__*/_jsx(SafeAreaView, {
+        style: staticStyles.container,
+        children: /*#__PURE__*/_jsx(ScrollView, {
+          style: selectFootnoteStyle({
+            screenHeight,
+            isVisible,
+            ...themeTokens
+          }),
+          children: /*#__PURE__*/_jsxs(View, {
+            style: staticStyles.content,
+            children: [/*#__PURE__*/_jsxs(View, {
+              style: [selectFootnoteHeaderContentStyle(themeTokens), staticStyles.headerContent],
+              children: [/*#__PURE__*/_jsx(Typography, {
+                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__*/_jsx(TouchableWithoutFeedback, {
+                onPress: handleClose,
+                accessibilityLabel: getCopy('close'),
+                children: /*#__PURE__*/_jsx(View, {
+                  style: [selectFootnoteCloseButtonStyle(themeTokens), staticStyles.closeButton],
+                  children: /*#__PURE__*/_jsx(Icon, {
+                    icon: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.closeIcon,
+                    tokens: {
+                      size: themeTokens === null || themeTokens === void 0 ? void 0 : themeTokens.closeButtonIconSize
+                    }
+                  })
+                })
+              })]
+            }), /*#__PURE__*/_jsx(View, {
+              style: selectFootnoteBodyStyle({
+                maxWidth: themeOptions.contentMaxWidth,
+                screenWidth,
+                ...themeTokens
+              }),
+              children: getFootnoteBodyContent()
+            })]
+          })
+        })
+      })
+    })
+  });
+};
+const copyShape = PropTypes.shape({
+  close: PropTypes.string.isRequired,
+  heading: PropTypes.string.isRequired
+});
+
+// If a language dictionary entry is provided, it must contain every key
+const dictionaryContentShape = PropTypes.shape({
+  a11yLabel: PropTypes.string.isRequired,
+  close: PropTypes.string.isRequired,
+  heading: PropTypes.string.isRequired
+});
+Footnote.propTypes = {
+  ...selectedSystemPropTypes,
+  tokens: getTokensPropType('Footnote'),
+  /**
+   * The content.
+   */
+  content: PropTypes.oneOfType([PropTypes.string, PropTypes.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.oneOfType([PropTypes.oneOf(['en', 'fr']), copyShape]),
+  /**
+   * A boolean flag used hide or show the `Footnote`. Set to `true` to open the `Footnote`.
+   */
+  isOpen: PropTypes.bool,
+  /**
+   * The number, must match the number of the `FootnoteLink` that initiated the `Footnote`.
+   */
+  number: PropTypes.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.func.isRequired,
+  /**
+   * Override the default dictionary, by passing the complete dictionary object for `en` and `fr`
+   */
+  dictionary: PropTypes.shape({
+    en: dictionaryContentShape,
+    fr: dictionaryContentShape
+  })
+};
+export default Footnote;
+const staticStyles = StyleSheet.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-module/Footnote/FootnoteLink.js

@@ -0,0 +1,101 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+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 TouchableWithoutFeedback from "react-native-web/dist/exports/TouchableWithoutFeedback";
+import dictionary from './dictionary';
+import { htmlAttrs, selectSystemProps, useCopy, viewProps, wrapStringsInText } from '../utils';
+import { applyTextStyles, useThemeTokens } from '../ThemeProvider';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs, 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.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 = useThemeTokens('FootnoteLink', tokens, variant);
+  const textStyles = applyTextStyles(themeTokens);
+  const numbers = Array.isArray(content) ? content : [content];
+  const refs = numbers.map(() => /*#__PURE__*/React.createRef());
+  const handleOnClick = index => {
+    onClick(numbers[index], refs[index]);
+  };
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
+  return /*#__PURE__*/_jsx(_Fragment, {
+    children: numbers.map((num, index) => /*#__PURE__*/_jsx(View, {
+      accessibilityLabel: getCopy('a11yLabel'),
+      ref: refs[index],
+      ...selectProps(rest),
+      children: /*#__PURE__*/_jsx(TouchableWithoutFeedback, {
+        onPress: handleOnClick,
+        accessibilityRole: "button",
+        children: wrapStringsInText(`${num}${index !== numbers.length - 1 ? ',' : ''}`, {
+          style: {
+            ...textStyles,
+            ...staticStyles.text,
+            ...selectTextStyle(themeTokens)
+          }
+        })
+      })
+    }, num))
+  });
+};
+const copyShape = PropTypes.shape({
+  a11yLabel: PropTypes.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.oneOfType([PropTypes.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.oneOfType([PropTypes.number, PropTypes.arrayOf(PropTypes.number), PropTypes.string, PropTypes.arrayOf(PropTypes.string)]).isRequired,
+  /**
+   * A callback function to handle the click of a FootnoteLink.
+   */
+  onClick: PropTypes.func.isRequired
+};
+export default FootnoteLink;
+const staticStyles = StyleSheet.create({
+  text: {
+    position: 'relative',
+    textDecorationLine: 'underline'
+  }
+});

package/lib-module/Footnote/dictionary.js

@@ -0,0 +1,12 @@
+export 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'
+  }
+};

package/lib-module/Footnote/index.js

@@ -0,0 +1,4 @@
+import Footnote from './Footnote';
+import FootnoteLink from './FootnoteLink';
+Footnote.Link = FootnoteLink;
+export default Footnote;