@telus-uds/components-base 1.75.0 → 1.76.0

package/lib/PriceLockup/utils/renderPrice.js

@@ -0,0 +1,147 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _Text = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Text"));
+var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
+var _A11yText = _interopRequireDefault(require("../../A11yText"));
+var _renderTypography = _interopRequireDefault(require("./renderTypography"));
+var _renderFootnoteLinks = _interopRequireDefault(require("./renderFootnoteLinks"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const selectStrikeThroughStyles = _ref => {
+  let {
+    strikeThroughColor
+  } = _ref;
+  return {
+    textDecorationColor: strikeThroughColor
+  };
+};
+const selectFootnoteLinksStyles = _ref2 => {
+  let {
+    bottomLinksMarginLeft
+  } = _ref2;
+  return {
+    marginLeft: bottomLinksMarginLeft
+  };
+};
+const renderCurrencySymbol = (currencySymbol, currencySymbolTypographyTokens, ratePosition, fontColor) => (0, _renderTypography.default)(`${currencySymbol}`, currencySymbolTypographyTokens, ratePosition, fontColor);
+const renderAmount = (amount, amountTypographyTokens, strikeThrough, a11yText, fontColor, themeTokens) => {
+  const amountText = (0, _renderTypography.default)(amount, amountTypographyTokens, undefined, fontColor); // undefined is ratePosition
+  if (strikeThrough) {
+    return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_A11yText.default, {
+        text: a11yText
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+        style: [staticStyles.strikeThroughContainer, selectStrikeThroughStyles(themeTokens)],
+        children: amountText
+      })]
+    });
+  }
+  return amountText;
+};
+const renderPrice = (price, rateText, ratePosition, signDirection, currencySymbol, currencySymbolTypographyTokens, amountTypographyTokens, centsTypographyTokens, rateTypographyTokens, fontColor, strikeThrough, a11yText, bottomText, bottomLinksMarginLeft, footnoteLinks, onClickFootnote, themeTokens) => {
+  const priceString = price;
+  const lastDotPosition = priceString.lastIndexOf('.');
+  const lastCommaPosition = priceString.lastIndexOf(',');
+  const [separator, separatorPosition] = lastDotPosition > lastCommaPosition ? ['.', lastDotPosition] : [',', lastCommaPosition];
+
+  // If the separator is at the fourth character from the end of the string or more, it's most probably
+  // a part of the amount, and the cents are not included in the price string
+  const EXCLUDE_CENTS = 3;
+  const hasCents = separatorPosition !== -1 && separatorPosition >= priceString.length - EXCLUDE_CENTS;
+  const amount = hasCents ? priceString.substring(0, separatorPosition) : priceString;
+  const cents = hasCents ? priceString.substring(separatorPosition + 1) : null;
+  const footnoteLinkPositionStyles = rateText ? staticStyles.footnoteLinksWithoutBottomText : staticStyles.footnoteLinksWithoutBottomTextAndRateText;
+  const MAX_FOOTNOTE_LINKS_ALLOWED = 3;
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+      style: ratePosition === 'bottom' ? staticStyles.priceContainerColumn : staticStyles.priceContainerRow,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+        style: staticStyles.priceContainer,
+        children: [signDirection === 'left' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+          children: renderCurrencySymbol(currencySymbol, currencySymbolTypographyTokens, ratePosition, fontColor)
+        }) : null, renderAmount(amount, amountTypographyTokens, strikeThrough, a11yText, fontColor, themeTokens), cents ? (0, _renderTypography.default)(`${separator}${cents}`, centsTypographyTokens, undefined, fontColor) : null, signDirection === 'right' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+          style: staticStyles.currencySymbol,
+          children: renderCurrencySymbol(currencySymbol, currencySymbolTypographyTokens, ratePosition, fontColor)
+        }) : null]
+      }), rateText ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+        style: ratePosition === 'bottom' ? staticStyles.rateTextVerticalPosition : [staticStyles.rateTextPosition, staticStyles.rateTextVerticalPosition],
+        children: (0, _renderTypography.default)(rateText, rateTypographyTokens, ratePosition, fontColor)
+      }) : null, !bottomText && footnoteLinks.length <= MAX_FOOTNOTE_LINKS_ALLOWED ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_Text.default, {
+        style: [footnoteLinkPositionStyles, selectFootnoteLinksStyles({
+          bottomLinksMarginLeft
+        })],
+        children: (0, _renderFootnoteLinks.default)(footnoteLinks, themeTokens, onClickFootnote)
+      }) : null]
+    }), !bottomText && footnoteLinks.length > MAX_FOOTNOTE_LINKS_ALLOWED ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      style: staticStyles.verticalFootnoteLinkContainer,
+      children: (0, _renderFootnoteLinks.default)(footnoteLinks, themeTokens, onClickFootnote)
+    }) : null]
+  });
+};
+var _default = renderPrice;
+exports.default = _default;
+const staticStyles = _StyleSheet.default.create({
+  priceContainerRow: {
+    flexDirection: 'row'
+  },
+  priceContainerColumn: {
+    flexDirection: 'column'
+  },
+  priceContainer: {
+    flexDirection: 'row',
+    alignSelf: 'flex-start',
+    marginTop: 4
+  },
+  currencySymbol: {
+    paddingLeft: 4
+  },
+  verticalFootnoteLinkContainer: {
+    ..._Platform.default.select({
+      ios: {
+        top: 10
+      },
+      android: {
+        top: -2
+      }
+    })
+  },
+  footnoteLinksWithoutBottomText: {
+    ..._Platform.default.select({
+      ios: {
+        alignSelf: 'flex-end',
+        top: -10
+      },
+      android: {
+        alignSelf: 'center',
+        top: -14
+      }
+    })
+  },
+  footnoteLinksWithoutBottomTextAndRateText: {
+    ..._Platform.default.select({
+      ios: {
+        alignSelf: 'center'
+      },
+      android: {
+        alignSelf: 'flex-start'
+      }
+    })
+  },
+  strikeThroughContainer: {
+    textDecorationLine: 'line-through',
+    textDecorationThickness: '1px'
+  },
+  rateTextPosition: {
+    alignSelf: 'flex-end'
+  },
+  rateTextVerticalPosition: {
+    top: -8
+  }
+});

package/lib/PriceLockup/utils/renderTypography.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _Typography = _interopRequireDefault(require("../../Typography"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const renderTypography = (value, themeTokens, ratePosition, fontColor) => {
+  const customProps = ratePosition === 'bottom' ? {
+    variant: {
+      size: 'micro'
+    },
+    tokens: {
+      color: fontColor
+    }
+  } : {
+    tokens: {
+      ...themeTokens,
+      color: fontColor
+    }
+  };
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Typography.default, {
+    ...customProps,
+    children: value
+  });
+};
+var _default = renderTypography;
+exports.default = _default;

package/lib/index.js

@@ -36,6 +36,7 @@ var _exportNames = {
   Notification: true,
   OrderedList: true,
   Pagination: true,
+  PriceLockup: true,
   Progress: true,
   QuickLinks: true,
   QuickLinksFeature: true,
@@ -285,6 +286,12 @@ Object.defineProperty(exports, "PressableCardBase", {
     return _Card.PressableCardBase;
   }
 });
+Object.defineProperty(exports, "PriceLockup", {
+  enumerable: true,
+  get: function () {
+    return _PriceLockup.default;
+  }
+});
 Object.defineProperty(exports, "Progress", {
   enumerable: true,
   get: function () {
@@ -592,6 +599,7 @@ var _MultiSelectFilter = _interopRequireDefault(require("./MultiSelectFilter"));
 var _Notification = _interopRequireDefault(require("./Notification"));
 var _OrderedList = _interopRequireDefault(require("./OrderedList"));
 var _Pagination = _interopRequireDefault(require("./Pagination"));
+var _PriceLockup = _interopRequireDefault(require("./PriceLockup"));
 var _Progress = _interopRequireDefault(require("./Progress"));
 var _QuickLinks = _interopRequireDefault(require("./QuickLinks"));
 var _QuickLinksFeature = _interopRequireDefault(require("./QuickLinksFeature"));

package/lib-module/Carousel/CarouselThumbnail.js

@@ -54,7 +54,8 @@ const CarouselThumbnail = _ref2 => {
     padding,
     selectedBorderColor,
     selectedBorderWidth,
-    size
+    size,
+    margin
   } = getThumbnailTokens({
     viewport
   });
@@ -66,7 +67,12 @@ const CarouselThumbnail = _ref2 => {
     selected: {
       borderColor: selectedBorderColor,
       borderWidth: selectedBorderWidth,
-      padding: padding - selectedBorderWidth + borderWidth
+      padding: padding - selectedBorderWidth,
+      marginBottom: margin + selectedBorderWidth
+    },
+    nonSelected: {
+      padding: padding - borderWidth,
+      marginBottom: margin + selectedBorderWidth
     }
   };
   return /*#__PURE__*/_jsx(Pressable, {
@@ -83,9 +89,9 @@ const CarouselThumbnail = _ref2 => {
         pressed,
         focus: focused
       }));
-      return [pressableStyles, index === activeIndex && styles.selected, {
+      return [pressableStyles, index === activeIndex ? [styles.selected, {
         outline: 'none'
-      }];
+      }] : styles.nonSelected];
     },
     children: /*#__PURE__*/_jsx(Image, {
       accessibilityIgnoresInvertColors: true,

package/lib-module/Carousel/CarouselThumbnailNavigation.js

@@ -24,8 +24,7 @@ const CarouselThumbnailNavigation = /*#__PURE__*/forwardRef((_ref, ref) => {
     throw new Error('Thumbnail set provided does not match the number of slides in the carousel');
   }
   const {
-    containerPaddingTop: thumbnailContainerPaddingTop,
-    margin: thumbnailMargin
+    containerPaddingTop: thumbnailContainerPaddingTop
   } = useThemeTokens('CarouselThumbnail');
   const stackWrapTokens = {
     justifyContent: 'flex-start'
@@ -33,13 +32,14 @@ const CarouselThumbnailNavigation = /*#__PURE__*/forwardRef((_ref, ref) => {
   const containerStyles = {
     justifyContent: 'center',
     alignItems,
-    paddingTop: thumbnailContainerPaddingTop - thumbnailMargin
+    paddingTop: thumbnailContainerPaddingTop
   };
   return /*#__PURE__*/_jsx(View, {
     style: containerStyles,
     children: /*#__PURE__*/_jsx(StackWrap, {
       direction: "row",
       tokens: stackWrapTokens,
+      space: 2,
       ref: ref,
       children: thumbnails.map((_ref2, index) => {
         let {

package/lib-module/Footnote/Footnote.js

@@ -165,19 +165,15 @@ const Footnote = _ref6 => {
         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)]
-      })
-    );
+    return /*#__PURE__*/_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) {

package/lib-module/Link/ChevronLink.js

@@ -18,6 +18,7 @@ const ChevronLink = /*#__PURE__*/forwardRef((_ref, ref) => {
     tokens = {},
     variant,
     dataSet,
+    onPress,
     ...otherlinkProps
   } = _ref;
   const getChevronTokens = useThemeTokensCallback('ChevronLink', tokens, variant);
@@ -46,6 +47,7 @@ const ChevronLink = /*#__PURE__*/forwardRef((_ref, ref) => {
     tokens: getTokens,
     dataSet: dataSet,
     ref: ref,
+    onPress: onPress,
     children: children
   });
 });

package/lib-module/Link/InlinePressable.js

@@ -1,6 +1,7 @@
-import React, { forwardRef } from 'react';
+import React, { forwardRef, useCallback } from 'react';
 import Pressable from "react-native-web/dist/exports/Pressable";
 import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Platform from "react-native-web/dist/exports/Platform";
 /**
  * @typedef {import('react-native').PressableProps} PressableProps
  */
@@ -13,18 +14,31 @@ import StyleSheet from "react-native-web/dist/exports/StyleSheet";
  * @param {PressableProps} PressableProps
  */
 // React Native exports prop Types but not propTypes, use JSDoc types here rather than duplicate RN
-// eslint-disable-next-line react/prop-types
+/* eslint-disable react/prop-types */
 import { jsx as _jsx } from "react/jsx-runtime";
 const InlinePressable = /*#__PURE__*/forwardRef((_ref, ref) => {
   let {
     children,
     inlineFlex = true,
     style,
+    onPress,
     ...props
   } = _ref;
+  const handlePress = useCallback(() => {
+    if (onPress) {
+      onPress();
+    }
+  }, [onPress]);
+  const handleKeyPress = useCallback(e => {
+    if (e.key === 'Enter' || e.key === ' ') {
+      handlePress();
+    }
+  }, [handlePress]);
   return /*#__PURE__*/_jsx(Pressable, {
     ref: ref,
     style: pressState => [typeof style === 'function' ? style(pressState) : style, staticStyles[inlineFlex ? 'inlineFlex' : 'inline']],
+    onPress: handlePress,
+    onKeyDown: Platform.OS === 'web' ? handleKeyPress : undefined,
     ...props,
     children: pressState => typeof children === 'function' ? children(pressState) : children
   });

package/lib-module/Link/LinkBase.js

@@ -178,6 +178,7 @@ const LinkBase = /*#__PURE__*/forwardRef((_ref6, ref) => {
     // assuming links without icons should be inline (even if they are long)
     ,
     ref: ref,
+    keyboardShouldPersistTaps: "handled",
     style: linkState => {
       const themeTokens = resolveLinkTokens(linkState);
       const outerBorderStyles = selectOuterBorderStyles(themeTokens);

package/lib-module/OrderedList/OrderedList.js

@@ -5,25 +5,6 @@ import OrderedListBase from './OrderedListBase';
 import Item from './Item';
 import { jsx as _jsx } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropsTypes] = selectSystemProps([htmlAttrs, viewProps]);
-const getChildrenWithParentVariants = (variant, children, start) => {
-  if (variant) return children.map((child, i) => {
-    var _child$props;
-    const existingChildVariants = ((_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.variant) ?? {};
-    return {
-      ...child,
-      props: {
-        ...child.props,
-        index: start + i,
-        isLastChild: i === children.length - 1,
-        variant: {
-          ...existingChildVariants,
-          ...variant
-        }
-      }
-    };
-  });
-  return children;
-};
 const OrderedList = /*#__PURE__*/forwardRef((_ref, ref) => {
   let {
     children,
@@ -31,7 +12,27 @@ const OrderedList = /*#__PURE__*/forwardRef((_ref, ref) => {
     variant,
     ...rest
   } = _ref;
-  const childrenWithParentVariants = useMemo(() => getChildrenWithParentVariants(variant, children, start), [children, variant, start]);
+  const childrenWithParentVariants = useMemo(() => {
+    const addVariantToProps = (child, i, isLastChild) => {
+      var _child$props;
+      const existingChildVariants = ((_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.variant) ?? {};
+      return /*#__PURE__*/React.cloneElement(child, {
+        index: start + i,
+        isLastChild,
+        variant: {
+          ...existingChildVariants,
+          ...variant
+        }
+      });
+    };
+    if (variant) {
+      if (Array.isArray(children)) {
+        return children.map((child, i) => addVariantToProps(child, i, i === children.length - 1));
+      }
+      return [addVariantToProps(children, 0, true)];
+    }
+    return children;
+  }, [children, variant, start]);
   return /*#__PURE__*/_jsx(OrderedListBase, {
     ref: ref,
     ...selectProps(rest),

package/lib-module/PriceLockup/PriceLockup.js

@@ -0,0 +1,214 @@
+import React from 'react';
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import View from "react-native-web/dist/exports/View";
+import PropTypes from 'prop-types';
+import Divider from '../Divider';
+import { useViewport } from '../ViewportProvider';
+import { useThemeTokens } from '../ThemeProvider';
+import { selectSystemProps, getTokensPropType, htmlAttrs, viewProps } from '../utils';
+import renderFootnoteContent from './utils/renderFootnoteContent';
+import renderPrice from './utils/renderPrice';
+import renderTypography from './utils/renderTypography';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs, viewProps]);
+const selectTopTextTypographyTokens = _ref => {
+  let {
+    topTextFontSize,
+    topTextLineHeight
+  } = _ref;
+  return {
+    fontSize: topTextFontSize,
+    lineHeight: topTextLineHeight
+  };
+};
+const selectCurrencySymbolTypographyTokens = _ref2 => {
+  let {
+    currencySymbolFontSize,
+    currencySymbolLineHeight,
+    currencySymbolFontWeight
+  } = _ref2;
+  return {
+    fontSize: currencySymbolFontSize,
+    lineHeight: currencySymbolLineHeight,
+    fontWeight: currencySymbolFontWeight
+  };
+};
+const selectAmountTypographyTokens = _ref3 => {
+  let {
+    amountFontSize,
+    amountLineHeight,
+    amountLetterSpacing,
+    amountFontWeight,
+    fontColor
+  } = _ref3;
+  // This is used to apply the proper line height to the amount
+  const lineHeightMultiplier = 1.18;
+  return {
+    color: fontColor,
+    fontSize: amountFontSize,
+    lineHeight: amountLineHeight * lineHeightMultiplier,
+    letterSpacing: amountLetterSpacing,
+    fontWeight: amountFontWeight
+  };
+};
+const selectCentsTypographyTokens = _ref4 => {
+  let {
+    centsFontSize,
+    centsLineHeight,
+    centsFontWeight
+  } = _ref4;
+  return {
+    fontSize: centsFontSize,
+    lineHeight: centsLineHeight,
+    fontWeight: centsFontWeight
+  };
+};
+const selectRateTypographyTokens = _ref5 => {
+  let {
+    rateFontSize,
+    rateLineHeight,
+    rateFontWeight
+  } = _ref5;
+  return {
+    fontSize: rateFontSize,
+    lineHeight: rateLineHeight,
+    fontWeight: rateFontWeight
+  };
+};
+const selectBottomTextTypographyTokens = _ref6 => {
+  let {
+    bottomTextFontSize,
+    bottomTextLineHeight
+  } = _ref6;
+  return {
+    fontSize: bottomTextFontSize,
+    lineHeight: bottomTextLineHeight
+  };
+};
+const PriceLockup = _ref7 => {
+  let {
+    size = 'medium',
+    signDirection = 'left',
+    footnoteLinks,
+    topText,
+    price,
+    currencySymbol = '$',
+    rateText,
+    ratePosition = 'right',
+    bottomText,
+    onClickFootnote,
+    strikeThrough,
+    a11yText,
+    tokens: priceLockupTokens,
+    variant = {},
+    ...rest
+  } = _ref7;
+  const viewport = useViewport();
+  const {
+    footnoteMarginTop,
+    footnoteGap,
+    bottomTextMarginTop,
+    priceMarginBottom,
+    bottomLinksMarginLeft,
+    topTextMarginBottom,
+    fontColor,
+    dividerColor,
+    ...themeTokens
+  } = useThemeTokens('PriceLockup', priceLockupTokens, {
+    ...variant,
+    size
+  }, {
+    viewport,
+    strikeThrough
+  });
+  const currencySymbolTypographyTokens = selectCurrencySymbolTypographyTokens(themeTokens);
+  const amountTypographyTokens = selectAmountTypographyTokens(themeTokens);
+  const centsTypographyTokens = selectCentsTypographyTokens(themeTokens);
+  const rateTypographyTokens = selectRateTypographyTokens(themeTokens);
+  const topTextTypographyTokens = selectTopTextTypographyTokens(themeTokens);
+  const bottomTextTypographyTokens = selectBottomTextTypographyTokens(themeTokens);
+  return /*#__PURE__*/_jsxs(View, {
+    style: [staticStyles.priceLockupContainer, {
+      ...selectProps(rest)
+    }],
+    children: [topText ? /*#__PURE__*/_jsx(View, {
+      children: renderTypography(topText, topTextTypographyTokens)
+    }) : null, renderPrice(price, rateText, ratePosition, signDirection, currencySymbol, currencySymbolTypographyTokens, amountTypographyTokens, centsTypographyTokens, rateTypographyTokens, fontColor, strikeThrough, a11yText, bottomText, bottomLinksMarginLeft, footnoteLinks, onClickFootnote, themeTokens), bottomText ? /*#__PURE__*/_jsxs(_Fragment, {
+      children: [/*#__PURE__*/_jsx(Divider, {
+        testID: "price-lockup-divider",
+        role: "separator",
+        tokens: {
+          color: dividerColor
+        }
+      }), renderFootnoteContent(footnoteMarginTop, bottomTextMarginTop, bottomText, bottomTextTypographyTokens, fontColor, footnoteLinks, bottomLinksMarginLeft, onClickFootnote, themeTokens)]
+    }) : null]
+  });
+};
+PriceLockup.displayName = 'PriceLockup';
+PriceLockup.propTypes = {
+  ...selectedSystemPropTypes,
+  /**
+   * Size of the component
+   *
+   * Small for pricing in product catalogue pages, medium for pricing in product comparison cards.
+   */
+  size: PropTypes.oneOf(['small', 'medium']),
+  /**
+   * If currency symbol other than `$` to be used
+   */
+  currencySymbol: PropTypes.string,
+  /**
+   * Shows additional info above the price
+   */
+  topText: PropTypes.string,
+  /**
+   * Monetary value (including decimals separated by ".")
+   */
+  price: PropTypes.string.isRequired,
+  /**
+   * Shows month/year unit
+   */
+  rateText: PropTypes.string,
+  /**
+   * Shows additional info below the price with a `Divider`
+   */
+  bottomText: PropTypes.string,
+  /**
+   * Displays which side the currency should appear (left, right)
+   */
+  signDirection: PropTypes.oneOf(['right', 'left']),
+  /**
+   * Displays where the rate should appear (bottom, right)
+   */
+  ratePosition: PropTypes.oneOf(['right', 'bottom']),
+  /**
+   * Shows additional link for context
+   */
+  footnoteLinks: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.number, PropTypes.string])),
+  /**
+   * Function to be called when a footnote link is clicked
+   */
+  onClickFootnote: PropTypes.func,
+  /**
+   * To show price savings comparison
+   */
+  strikeThrough: PropTypes.bool,
+  /**
+   * To provide a11y text for `PriceLockup` component
+   *
+   * **Note:** a11yText will override strikethrough price, so it must include price (ie. "was 50 dollars per month")
+   */
+  a11yText: PropTypes.string,
+  /**
+   * `PriceLockup` tokens
+   */
+  tokens: getTokensPropType('PriceLockup')
+};
+export default PriceLockup;
+const staticStyles = StyleSheet.create({
+  priceLockupContainer: {
+    alignSelf: 'flex-start'
+  }
+});

package/lib-module/PriceLockup/index.js

@@ -0,0 +1,2 @@
+import PriceLockup from './PriceLockup';
+export default PriceLockup;