@telus-uds/components-base 1.93.0 → 1.95.0

package/lib/TabBar/TabBar.js

@@ -0,0 +1,133 @@
+"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 _TabBarItem = _interopRequireDefault(require("./TabBarItem"));
+var _ThemeProvider = require("../ThemeProvider");
+var _utils = require("../utils");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const selectTabBarContainerStyles = _ref => {
+  let {
+    paddingTop,
+    paddingBottom,
+    borderTopWidth,
+    borderTopColor,
+    backgroundColor
+  } = _ref;
+  return {
+    paddingTop,
+    paddingBottom,
+    borderTopWidth,
+    borderTopColor,
+    backgroundColor
+  };
+};
+const selectTabBarItemContainerStyles = _ref2 => {
+  let {
+    paddingLeft,
+    paddingRight,
+    gap
+  } = _ref2;
+  return {
+    paddingLeft,
+    paddingRight,
+    gap
+  };
+};
+const [selectProps, selectedSystemPropTypes] = (0, _utils.selectSystemProps)([_utils.a11yProps, _utils.viewProps]);
+
+/**
+ * TabBar component renders a navigation bar with multiple TabBarItems.
+ * It allows users to switch between different views or sections.
+ *
+ * @component
+ * @example
+ * const items = [
+ *   { id: '1', label: 'Home', icon: <HomeIcon />, iconActive: <HomeActiveIcon /> },
+ *   { id: '2', label: 'Profile', icon: <ProfileIcon />, iconActive: <ProfileActiveIcon /> },
+ * ]
+ * return (
+ *   <TabBar
+ *     items={items}
+ *     initiallySelectedItem="1"
+ *     onChange={(itemId) => console.log(itemId)}
+ *   />
+ * )
+ */
+
+const TabBar = /*#__PURE__*/_react.default.forwardRef((_ref3, ref) => {
+  let {
+    items = [],
+    initiallySelectedItem = '0',
+    onChange,
+    variant,
+    tokens,
+    ...rest
+  } = _ref3;
+  const [isSelected, setIsSelected] = _react.default.useState(initiallySelectedItem);
+  const themeTokens = (0, _ThemeProvider.useThemeTokens)('TabBar', tokens, variant);
+  const handlePress = itemId => {
+    setIsSelected(itemId);
+    onChange === null || onChange === void 0 ? void 0 : onChange(itemId);
+  };
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+    ref: ref,
+    style: [styles.tabBar, selectTabBarContainerStyles(themeTokens)],
+    ...selectProps(rest),
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+      style: [styles.tabBarItem, selectTabBarItemContainerStyles(themeTokens)],
+      children: items.map((item, index) => /*#__PURE__*/(0, _jsxRuntime.jsx)(_TabBarItem.default, {
+        label: item.label,
+        href: item.href,
+        isSelected: isSelected === item.id,
+        icon: item.icon,
+        iconActive: item.iconActive,
+        onPress: () => handlePress(item.id),
+        id: `tab-item-${index}`,
+        accessibilityRole: "tablist"
+      }, item.id))
+    })
+  });
+});
+TabBar.displayName = 'TabBar';
+TabBar.propTypes = {
+  ...selectedSystemPropTypes,
+  /** Array of TabBarItems to be displayed in TabBar */
+  items: _propTypes.default.arrayOf(_propTypes.default.shape({
+    id: _propTypes.default.string.isRequired,
+    icon: _propTypes.default.node,
+    iconActive: _propTypes.default.node,
+    label: _propTypes.default.string.isRequired,
+    href: _propTypes.default.string
+  })).isRequired,
+  /** Id of the initially selected item. */
+  initiallySelectedItem: _propTypes.default.number,
+  /** Callback function to handle item selection change. */
+  onChange: _propTypes.default.func,
+  /** Variant of TabBar for styling purposes. */
+  variant: _utils.variantProp.propType,
+  /** Tokens for theming and styling. */
+  tokens: (0, _utils.getTokensPropType)('TabBar')
+};
+const styles = _StyleSheet.default.create({
+  tabBar: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center'
+  },
+  tabBarItem: {
+    flex: 1,
+    flexDirection: 'row',
+    justifyContent: 'space-between',
+    width: '100%'
+  }
+});
+var _default = TabBar;
+exports.default = _default;

package/lib/TabBar/TabBarItem.js

@@ -0,0 +1,184 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _Pressable = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Pressable"));
+var _View = _interopRequireDefault(require("react-native-web/dist/cjs/exports/View"));
+var _StyleSheet = _interopRequireDefault(require("react-native-web/dist/cjs/exports/StyleSheet"));
+var _utils = require("../utils");
+var _ThemeProvider = require("../ThemeProvider");
+var _Typography = _interopRequireDefault(require("../Typography"));
+var _Spacer = _interopRequireDefault(require("../Spacer"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const selectTypographyStyles = (_ref, isSelected) => {
+  let {
+    fontWeight,
+    color,
+    lineHeight,
+    fontName,
+    activeColor
+  } = _ref;
+  return {
+    fontWeight,
+    color: isSelected ? activeColor : color,
+    lineHeight,
+    fontName
+  };
+};
+const selectIconContainerStyles = _ref2 => {
+  let {
+    paddingTop,
+    paddingBottom
+  } = _ref2;
+  return {
+    paddingTop,
+    paddingBottom,
+    alignItems: 'center'
+  };
+};
+const selectIconStyles = (_ref3, isSelected) => {
+  let {
+    iconSize,
+    iconColor,
+    activeColor
+  } = _ref3;
+  return {
+    size: iconSize,
+    color: isSelected ? activeColor : iconColor
+  };
+};
+const selectContainerStyles = _ref4 => {
+  let {
+    borderRadius,
+    backgroundColor
+  } = _ref4;
+  return {
+    borderRadius,
+    backgroundColor,
+    alignSelf: 'center',
+    alignItems: 'center'
+  };
+};
+const TabBarItem = /*#__PURE__*/_react.default.forwardRef((_ref5, ref) => {
+  let {
+    href,
+    variant,
+    tokens,
+    label,
+    isSelected,
+    id,
+    onPress,
+    icon: IconComponent,
+    iconActive: IconActiveComponent,
+    accessibilityRole = 'tab'
+  } = _ref5;
+  const getTokens = (0, _ThemeProvider.useThemeTokensCallback)('TabBarItem', tokens, variant);
+  const getPressableStyle = _ref6 => {
+    let {
+      pressed,
+      focused,
+      hovered
+    } = _ref6;
+    const resolvedTokens = (0, _utils.resolvePressableTokens)(getTokens, {
+      pressed,
+      focused,
+      hovered
+    }, {
+      isSelected
+    });
+    return {
+      ...resolvedTokens,
+      outline: 'none' // removes the default browser :focus outline
+    };
+  };
+
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Pressable.default, {
+    ref: ref,
+    href: href,
+    nativeID: id,
+    onPress: onPress,
+    style: _ref7 => {
+      let {
+        pressed,
+        focused,
+        hovered
+      } = _ref7;
+      return [styles.flexContainer, getPressableStyle({
+        pressed,
+        focused,
+        hovered
+      })];
+    },
+    accessibilityRole: accessibilityRole,
+    testID: id,
+    children: pressableState => {
+      const resolvedTokens = getPressableStyle(pressableState);
+      return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_View.default, {
+        style: selectContainerStyles(resolvedTokens),
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_View.default, {
+          style: [selectIconContainerStyles(resolvedTokens), styles.iconContainer],
+          children: isSelected ? IconActiveComponent && /*#__PURE__*/(0, _jsxRuntime.jsx)(IconActiveComponent, {
+            ...selectIconStyles(resolvedTokens, isSelected)
+          }) : IconComponent && /*#__PURE__*/(0, _jsxRuntime.jsx)(IconComponent, {
+            ...selectIconStyles(resolvedTokens)
+          })
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Spacer.default, {
+          space: 1
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Typography.default, {
+          variant: {
+            size: 'micro'
+          },
+          tokens: selectTypographyStyles(resolvedTokens, isSelected),
+          align: "center",
+          children: label
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Spacer.default, {
+          space: 1
+        })]
+      });
+    }
+  });
+});
+TabBarItem.displayName = 'TabBarItem';
+TabBarItem.propTypes = {
+  /** The icon to be displayed when the item is not selected. */
+  icon: _propTypes.default.elementType,
+  /** The icon to be displayed when the item is selected. */
+  iconActive: _propTypes.default.elementType,
+  /** Tokens for theming and styling the TabBarItem. */
+  tokens: (0, _utils.getTokensPropType)('TabBarItem'),
+  /** Variant of the TabBarItem for styling purposes. */
+  variant: _utils.variantProp.propType,
+  /** Callback function to handle press events. */
+  onPress: _propTypes.default.func,
+  /** URL to navigate to when the item is pressed. */
+  href: _propTypes.default.string,
+  /** Indicates whether the item is selected. */
+  isSelected: _propTypes.default.bool,
+  /** Unique identifier for the item. */
+  id: _propTypes.default.string,
+  /** Label text for the item. */
+  label: _propTypes.default.string.isRequired,
+  /** Accessibility role for the item. */
+  accessibilityRole: _propTypes.default.string
+};
+const styles = _StyleSheet.default.create({
+  flexContainer: {
+    flex: 1,
+    alignItems: 'center'
+  },
+  iconContainer: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center',
+    minWidth: 44,
+    minHeight: 40,
+    aspectRatio: 1.1
+  }
+});
+var _default = TabBarItem;
+exports.default = _default;

package/lib/TabBar/index.js

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

package/lib/TextInput/TextInputBase.js

@@ -48,7 +48,8 @@ const selectInputStyles = function (_ref, themeOptions, inactive, type) {
   // jump around if the border width changes (avoiding NaN and negative padding)
   const offsetBorder = value => typeof value === 'number' ? Math.max(0, value - borderWidth) : value;
   const textStyles = (0, _ThemeProvider.applyTextStyles)({
-    fontName,
+    fontName: isPassword ? undefined : fontName,
+    // In this case, we don't want to apply the fontName to the input if it's a password because Monotype don't have support for the masked characters in mobile.
     fontSize,
     lineHeight,
     fontWeight,

package/lib/Tooltip/getTooltipPosition.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-function normalizePosition(position) {
+function getAbsolutePosition(position) {
   const {
     left,
     right,
@@ -15,7 +15,7 @@ function normalizePosition(position) {
   } = position;
 
   // adjust the coordinates so that it fits within the window
-  const normalized = {
+  const finalPosition = {
     left: Math.max(0, left),
     right: Math.max(0, right),
     top: Math.max(0, top),
@@ -25,15 +25,14 @@ function normalizePosition(position) {
   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;
+  finalPosition.width = width - Math.abs(getAbsoluteDiff(left, finalPosition.left) - getAbsoluteDiff(right, finalPosition.right));
+  if (finalPosition.top !== top) {
+    finalPosition.bottom += finalPosition.top - top;
   }
-  const isNormalized = normalized.right !== right || normalized.left !== left || normalized.top !== top;
   return {
-    ...normalized,
+    ...finalPosition,
     ...rest,
-    isNormalized
+    isNormalized: false
   };
 }
 function invertPosition(position) {
@@ -172,7 +171,7 @@ function getTooltipPosition(position, _ref2) {
 
   // 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);
+  return getAbsolutePosition(leastOverflowing.position === 'above' ? findRectByPosition('below', boundingRects) : leastOverflowing);
 }
 var _default = getTooltipPosition;
 exports.default = _default;

package/lib/index.js

@@ -13,11 +13,13 @@ var _exportNames = {
   Card: true,
   PressableCardBase: true,
   CardGroup: true,
+  FileUpload: true,
   Listbox: true,
   Checkbox: true,
   CheckboxCard: true,
   CheckboxCardGroup: true,
   ColourToggle: true,
+  DownloadApp: true,
   Divider: true,
   ExpandCollapse: true,
   Accordion: true,
@@ -57,6 +59,7 @@ var _exportNames = {
   Status: true,
   StepTracker: true,
   Tabs: true,
+  TabBar: true,
   Tags: true,
   Timeline: true,
   Tooltip: true,
@@ -177,6 +180,12 @@ Object.defineProperty(exports, "Divider", {
     return _Divider.default;
   }
 });
+Object.defineProperty(exports, "DownloadApp", {
+  enumerable: true,
+  get: function () {
+    return _DownloadApp.default;
+  }
+});
 Object.defineProperty(exports, "ExpandCollapse", {
   enumerable: true,
   get: function () {
@@ -195,6 +204,12 @@ Object.defineProperty(exports, "Fieldset", {
     return _Fieldset.default;
   }
 });
+Object.defineProperty(exports, "FileUpload", {
+  enumerable: true,
+  get: function () {
+    return _FileUpload.default;
+  }
+});
 Object.defineProperty(exports, "FlexGrid", {
   enumerable: true,
   get: function () {
@@ -411,6 +426,12 @@ Object.defineProperty(exports, "StepTracker", {
     return _StepTracker.default;
   }
 });
+Object.defineProperty(exports, "TabBar", {
+  enumerable: true,
+  get: function () {
+    return _TabBar.default;
+  }
+});
 Object.defineProperty(exports, "Tabs", {
   enumerable: true,
   get: function () {
@@ -569,6 +590,7 @@ Object.keys(_Carousel).forEach(function (key) {
     }
   });
 });
+var _FileUpload = _interopRequireDefault(require("./FileUpload"));
 var _Listbox = _interopRequireDefault(require("./Listbox"));
 var _Checkbox = _interopRequireWildcard(require("./Checkbox"));
 Object.keys(_Checkbox).forEach(function (key) {
@@ -585,6 +607,7 @@ Object.keys(_Checkbox).forEach(function (key) {
 var _CheckboxCard = _interopRequireDefault(require("./CheckboxCard"));
 var _CheckboxCardGroup = _interopRequireDefault(require("./CheckboxCardGroup"));
 var _ColourToggle = _interopRequireDefault(require("./ColourToggle"));
+var _DownloadApp = _interopRequireDefault(require("./DownloadApp"));
 var _Divider = _interopRequireDefault(require("./Divider"));
 var _ExpandCollapse = _interopRequireWildcard(require("./ExpandCollapse"));
 var _Feedback = _interopRequireDefault(require("./Feedback"));
@@ -688,6 +711,7 @@ Object.keys(_StackView).forEach(function (key) {
 var _Status = _interopRequireDefault(require("./Status"));
 var _StepTracker = _interopRequireDefault(require("./StepTracker"));
 var _Tabs = _interopRequireDefault(require("./Tabs"));
+var _TabBar = _interopRequireDefault(require("./TabBar"));
 var _Tags = _interopRequireDefault(require("./Tags"));
 var _TextInput = require("./TextInput");
 Object.keys(_TextInput).forEach(function (key) {

package/lib/utils/convertFromMegaByteToByte.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = convertFromMegaByteToByte;
+/**
+ * Converts a value from megabytes to bytes.
+ *
+ * @param {number} megaByte - The value in megabytes to be converted.
+ * @returns {number} The converted value in bytes.
+ */
+const BYTES_IN_A_MEGABYTE = 1024 * 1024;
+function convertFromMegaByteToByte(megaByte) {
+  return megaByte * BYTES_IN_A_MEGABYTE;
+}

package/lib/utils/formatImageSource.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+// react native source for Image and ImageBackground needs proper formatting to work
+// remote sources that start with 'http' and base64 encoded sources that start with 'data:' need be wrapped in uri when passing source prop for Image and ImageBackground ie. source={ uri: image }
+// local source for image can be passed normally without wrapping in uri ie. source={ image }
+
+/**
+ *  example code from react native docs: https://reactnative.dev/docs/imagebackground
+ *
+ *  const image = {uri: 'https://legacy.reactjs.org/logo-og.png'}
+ *
+ *  const App = () => (
+ *    <View style={styles.container}>
+ *      <ImageBackground source={image} resizeMode="cover" style={styles.image}>
+ *        <Text style={styles.text}>Inside</Text>
+ *      </ImageBackground>
+ *    </View>
+ *  )
+ */
+
+/**
+ * Formats the image source for React Native Image and ImageBackground components.
+ * @param {string|number} source - The image source, either a URI string or a number (when a local image source is bundled in IOS or Android app).
+ * @returns {object|string} - The formatted image source.
+ */
+const formatImageSource = source => typeof source === 'string' && (source.startsWith('http') || source.startsWith('data:')) ? {
+  uri: source
+} : source;
+var _default = formatImageSource;
+exports.default = _default;

package/lib/utils/index.js

@@ -17,7 +17,9 @@ var _exportNames = {
   containUniqueFields: true,
   BaseView: true,
   htmlAttrs: true,
-  transformGradient: true
+  transformGradient: true,
+  convertFromMegaByteToByte: true,
+  formatImageSource: true
 };
 Object.defineProperty(exports, "BaseView", {
   enumerable: true,
@@ -31,6 +33,18 @@ Object.defineProperty(exports, "containUniqueFields", {
     return _containUniqueFields.default;
   }
 });
+Object.defineProperty(exports, "convertFromMegaByteToByte", {
+  enumerable: true,
+  get: function () {
+    return _convertFromMegaByteToByte.default;
+  }
+});
+Object.defineProperty(exports, "formatImageSource", {
+  enumerable: true,
+  get: function () {
+    return _formatImageSource.default;
+  }
+});
 Object.defineProperty(exports, "htmlAttrs", {
   enumerable: true,
   get: function () {
@@ -224,6 +238,8 @@ var _containUniqueFields = _interopRequireDefault(require("./containUniqueFields
 var _BaseView = _interopRequireDefault(require("./BaseView"));
 var _htmlAttrs = _interopRequireDefault(require("./htmlAttrs"));
 var _transformGradient = require("./transformGradient");
+var _convertFromMegaByteToByte = _interopRequireDefault(require("./convertFromMegaByteToByte"));
+var _formatImageSource = _interopRequireDefault(require("./formatImageSource"));
 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; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib-module/Autocomplete/Autocomplete.js

@@ -106,6 +106,7 @@ const Autocomplete = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     validation,
     value,
     helpText = '',
+    loadingLabel,
     ...rest
   } = _ref2;
   const {
@@ -341,7 +342,7 @@ const Autocomplete = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
         onLayout: handleMeasure,
         ref: openOverlayRef,
         children: isLoading ? /*#__PURE__*/_jsx(Loading, {
-          label: getCopy('loading')
+          label: loadingLabel ?? getCopy('loading')
         }) : /*#__PURE__*/_jsx(Suggestions, {
           hasResults: getCopy('hasResults'),
           id: "autocomplete",

package/lib-module/Button/ButtonGroup.js

@@ -48,7 +48,11 @@ const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   const {
     direction,
     space,
-    fieldSpace
+    fieldSpace,
+    borderRadius,
+    backgroundColor,
+    padding,
+    gap
   } = themeTokens;
   const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant);
   const {
@@ -87,12 +91,24 @@ const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     inactive: inactive,
     validation: validation,
     accessibilityRole: accessibilityRole,
+    style: {
+      borderRadius,
+      backgroundColor,
+      padding,
+      ...(Platform.OS === 'web' ? {
+        gap,
+        width: 'fit-content'
+      } : {
+        alignSelf: 'flex-start'
+      })
+    },
     ...selectProps(rest),
     children: /*#__PURE__*/_jsx(StackWrap, {
       accessibilityRole: innerRole,
       space: space,
       direction: direction,
       tokens: stackTokens,
+      gap: gap,
       ref: ref,
       children: items.map((_ref2, index) => {
         let {

package/lib-module/Card/Card.js

@@ -4,7 +4,7 @@ import View from "react-native-web/dist/exports/View";
 import { useThemeTokens, useThemeTokensCallback, useResponsiveThemeTokens, useTheme } from '../ThemeProvider';
 import { getTokensPropType, variantProp, StyleSheet, createMediaQueryStyles } from '../utils';
 import { useViewport } from '../ViewportProvider';
-import { a11yProps, linkProps, selectSystemProps, viewProps } from '../utils/props';
+import { a11yProps, linkProps, selectSystemProps, viewProps, responsiveProps } from '../utils/props';
 import CardBase from './CardBase';
 import PressableCardBase from './PressableCardBase';
 import CheckboxButton from '../Checkbox/CheckboxButton';
@@ -112,6 +112,7 @@ const Card = /*#__PURE__*/React.forwardRef((_ref3, ref) => {
     onPress,
     id,
     interactiveCard,
+    backgroundImage,
     ...rest
   } = _ref3;
   const viewport = useViewport();
@@ -235,6 +236,7 @@ const Card = /*#__PURE__*/React.forwardRef((_ref3, ref) => {
     children: /*#__PURE__*/_jsx(CardBase, {
       ref: ref,
       tokens: interactiveCard !== null && interactiveCard !== void 0 && interactiveCard.body ? restOfTokens : cardStyles,
+      backgroundImage: backgroundImage,
       dataSet: mediaIds && {
         media: mediaIds
       },
@@ -313,6 +315,16 @@ Card.propTypes = {
     tokens: getTokensPropType('Card'),
     selectionType: PropTypes.oneOf(Object.values(SelectionType)),
     variant: variantProp.propType
+  }),
+  /**
+   * Apply background image to the card.
+   */
+  backgroundImage: PropTypes.shape({
+    // The image src is either a URI string or a number (when a local image src is bundled in IOS or Android app)
+    // src is an object when used responsively to provide different image sources for different screen sizes
+    src: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.object]).isRequired,
+    alt: PropTypes.string,
+    resizeMode: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['cover', 'contain', 'stretch', 'repeat', 'center']))
   })
 };
 export default Card;