@telus-uds/components-base 1.92.0 → 1.94.0

package/src/Card/Card.jsx

@@ -9,7 +9,7 @@ import {
 } 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'
@@ -100,7 +100,10 @@ const getInputProps = ({
  * depending on what you are trying to achieve.
  */
 const Card = React.forwardRef(
-  ({ children, tokens, variant, dataSet, onPress, id, interactiveCard, ...rest }, ref) => {
+  (
+    { children, tokens, variant, dataSet, onPress, id, interactiveCard, backgroundImage, ...rest },
+    ref
+  ) => {
     const viewport = useViewport()
     const { themeOptions } = useTheme()
 
@@ -213,6 +216,7 @@ const Card = React.forwardRef(
         <CardBase
           ref={ref}
           tokens={interactiveCard?.body ? restOfTokens : cardStyles}
+          backgroundImage={backgroundImage}
           dataSet={mediaIds && { media: mediaIds }}
           {...selectProps(rest)}
         >
@@ -310,6 +314,18 @@ 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'])
+    )
   })
 }
 

package/src/Card/CardBase.jsx

@@ -1,9 +1,9 @@
 import React from 'react'
 import PropTypes from 'prop-types'
-import { View, Platform } from 'react-native'
+import { View, Platform, ImageBackground, StyleSheet } from 'react-native'
 
 import { applyShadowToken } from '../ThemeProvider'
-import { getTokensPropType } from '../utils'
+import { getTokensPropType, responsiveProps, useResponsiveProp, formatImageSource } from '../utils'
 import { a11yProps, viewProps, selectSystemProps } from '../utils/props'
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
@@ -50,21 +50,56 @@ const selectStyles = ({
  * A themeless base component for Card which components can apply theme tokens to. Not
  * intended to be used in apps or sites directly: build themed components on top of this.
  */
-const CardBase = React.forwardRef(({ children, tokens, dataSet, ...rest }, ref) => {
-  const cardStyle = selectStyles(typeof tokens === 'function' ? tokens() : tokens)
-  const props = selectProps(rest)
-  return (
-    <View style={cardStyle} dataSet={dataSet} ref={ref} {...props}>
-      {children}
-    </View>
-  )
-})
+const CardBase = React.forwardRef(
+  ({ children, tokens, dataSet, backgroundImage, ...rest }, ref) => {
+    const cardStyle = selectStyles(typeof tokens === 'function' ? tokens() : tokens)
+    const props = selectProps(rest)
+
+    const { src = '', alt = '', resizeMode = '' } = backgroundImage || {}
+    const backgroundImageResizeMode = useResponsiveProp(resizeMode, 'cover')
+    const imageSourceViewport = formatImageSource(useResponsiveProp(src))
+
+    return (
+      <View style={cardStyle} dataSet={dataSet} ref={ref} {...props}>
+        {src ? (
+          <ImageBackground
+            alt={alt}
+            source={imageSourceViewport}
+            imageStyle={{ borderRadius: cardStyle?.borderRadius - cardStyle?.borderWidth }}
+            resizeMode={backgroundImageResizeMode}
+            style={styles.imageBackground}
+          >
+            {children}
+          </ImageBackground>
+        ) : (
+          children
+        )}
+      </View>
+    )
+  }
+)
 CardBase.displayName = 'CardBase'
 
+const styles = StyleSheet.create({
+  imageBackground: { width: '100%', height: '100%' }
+})
+
 CardBase.propTypes = {
   ...selectedSystemPropTypes,
   children: PropTypes.node,
-  tokens: getTokensPropType('Card')
+  tokens: getTokensPropType('Card'),
+  /**
+   * 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 CardBase

package/src/Carousel/Carousel.jsx

@@ -55,9 +55,9 @@ const selectContainerStyles = (width) => ({
   width
 })
 
-const selectSwipeAreaStyles = (count, width) => ({
+const selectSwipeAreaStyles = (count, width, enablePeeking) => ({
   width: width * count,
-  justifyContent: 'space-between',
+  justifyContent: enablePeeking ? 'flex-start' : 'space-between',
   flexDirection: 'row'
 })
 
@@ -68,7 +68,8 @@ const selectControlButtonPositionStyles = ({
   positionVariant,
   buttonWidth,
   positionProperty = getDynamicPositionProperty(),
-  spaceBetweenSlideAndButton
+  spaceBetweenSlideAndButton,
+  enablePeeking
 }) => {
   const styles = {}
   if (positionVariant === 'edge') {
@@ -76,7 +77,11 @@ const selectControlButtonPositionStyles = ({
   } else if (positionVariant === 'inside') {
     styles[positionProperty] = 0
   } else if (positionVariant === 'outside') {
-    styles[positionProperty] = -1 * (spaceBetweenSlideAndButton + buttonWidth)
+    if (enablePeeking) {
+      styles[positionProperty] = 0
+    } else {
+      styles[positionProperty] = -1 * (spaceBetweenSlideAndButton + buttonWidth)
+    }
   }
   return styles
 }
@@ -87,7 +92,8 @@ const selectPreviousNextNavigationButtonStyles = (
   spaceBetweenSlideAndPreviousNextNavigation,
   isFirstSlide,
   isLastSlide,
-  areStylesAppliedOnPreviousButton
+  areStylesAppliedOnPreviousButton,
+  enablePeeking
 ) => {
   const styles = {
     zIndex: 1,
@@ -107,11 +113,33 @@ const selectPreviousNextNavigationButtonStyles = (
       positionVariant: previousNextNavigationPosition,
       buttonWidth: previousNextNavigationButtonWidth,
       positionProperty: getDynamicPositionProperty(areStylesAppliedOnPreviousButton),
-      spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation
+      spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation,
+      enablePeeking
     })
   }
 }
 
+const getPeekingProps = (viewport) => {
+  if (viewport === 'xs' || viewport === 'sm') {
+    return {
+      peekingFirstSpace: 48,
+      peekingGap: 16,
+      peekingLastSpace: 48,
+      peekingMarginLeft: 24,
+      peekingMarginRight: 24,
+      peekingMiddleSpace: 28
+    }
+  }
+  return {
+    peekingFirstSpace: 48,
+    peekingGap: 16,
+    peekingLastSpace: 48,
+    peekingMarginLeft: 16,
+    peekingMarginRight: 16,
+    peekingMiddleSpace: 24
+  }
+}
+
 const selectIconStyles = ({ iconBackgroundColor }) => ({ backgroundColor: iconBackgroundColor })
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
@@ -204,6 +232,7 @@ const Carousel = React.forwardRef(
       slideDuration = 0,
       transitionDuration = 0,
       autoPlay = false,
+      enablePeeking = false,
       ...rest
     },
     ref
@@ -301,6 +330,13 @@ const Carousel = React.forwardRef(
             useNativeDriver: false,
             duration: transitionDuration * 1000
           }).start(handleAnimationEndToIndex)
+        } else if (enablePeeking) {
+          Animated.timing(pan, {
+            ...springConfig,
+            toValue,
+            useNativeDriver: false,
+            duration: transitionDuration ? transitionDuration * 1000 : 1000
+          }).start(handleAnimationEndToIndex)
         } else {
           Animated.spring(pan, {
             ...springConfig,
@@ -309,7 +345,7 @@ const Carousel = React.forwardRef(
           }).start(handleAnimationEndToIndex)
         }
       },
-      [pan, springConfig, handleAnimationEnd, transitionDuration, isAutoPlayEnabled]
+      [pan, springConfig, handleAnimationEnd, transitionDuration, isAutoPlayEnabled, enablePeeking]
     )
 
     const stopAutoplay = React.useCallback(() => {
@@ -676,7 +712,8 @@ const Carousel = React.forwardRef(
                   positionVariant: previousNextNavigationPosition,
                   buttonWidth: previousNextNavigationButtonWidth,
                   positionProperty: getDynamicPositionProperty(),
-                  spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation
+                  spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation,
+                  enablePeeking
                 })
               ]}
             >
@@ -698,7 +735,8 @@ const Carousel = React.forwardRef(
                 spaceBetweenSlideAndPreviousNextNavigation,
                 isFirstSlide,
                 isLastSlide,
-                true
+                true,
+                enablePeeking
               )}
               testID="previous-button-container"
             >
@@ -731,7 +769,7 @@ const Carousel = React.forwardRef(
           <View style={selectContainerStyles(containerLayout.width)}>
             <Animated.View
               style={StyleSheet.flatten([
-                selectSwipeAreaStyles(childrenArray.length, containerLayout.width),
+                selectSwipeAreaStyles(childrenArray.length, containerLayout.width, enablePeeking),
                 {
                   transform: [{ translateX: pan.x }, { translateY: pan.y }]
                 }
@@ -746,7 +784,9 @@ const Carousel = React.forwardRef(
                 const hidden = !isAnimating && index !== activeIndex
                 const clonedElement = React.cloneElement(element, {
                   elementIndex: index,
-                  hidden
+                  hidden: enablePeeking ? false : hidden,
+                  enablePeeking,
+                  peekingProps: getPeekingProps(viewport)
                 })
                 return <React.Fragment key={index.toFixed(2)}>{clonedElement}</React.Fragment>
               })}
@@ -760,7 +800,8 @@ const Carousel = React.forwardRef(
                 spaceBetweenSlideAndPreviousNextNavigation,
                 isFirstSlide,
                 isLastSlide,
-                false
+                false,
+                enablePeeking
               )}
               testID="next-button-container"
             >
@@ -962,7 +1003,12 @@ Carousel.propTypes = {
    * - Default value is `0`
    * - `autoPlay` and `slideDuration` are required to be set for this to work
    */
-  transitionDuration: PropTypes.number
+  transitionDuration: PropTypes.number,
+  /**
+   * If set to `true`, the Carousel will show the previous and next slides
+   * - Default value is `false`
+   */
+  enablePeeking: PropTypes.bool
 }
 
 Carousel.Item = CarouselItem

package/src/Carousel/CarouselItem/CarouselItem.jsx

@@ -13,13 +13,73 @@ import { useCarousel } from '../CarouselContext'
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
 
+const selectContainerStyle = ({
+  width,
+  activeIndex,
+  elementIndex,
+  totalItems,
+  enablePeeking,
+  peekingMarginLeft,
+  peekingMarginRight,
+  peekingFirstSpace,
+  peekingLastSpace,
+  peekingMiddleSpace,
+  peekingGap,
+  hidden
+}) => {
+  const isFirst = elementIndex === 0
+  const isLast = elementIndex === totalItems - 1
+  const isMiddle = !isFirst && !isLast
+  const isActive = activeIndex === elementIndex
+
+  let adjustedWidth = width
+  let marginLeft = 0
+  let marginRight = 0
+
+  if (enablePeeking) {
+    if (isActive) {
+      adjustedWidth = width - (peekingMarginLeft + peekingGap + peekingFirstSpace)
+    } else if (isMiddle) {
+      adjustedWidth = width - peekingGap
+    }
+
+    if (isFirst) {
+      if (isActive) {
+        marginLeft = peekingMarginLeft
+      } else if (activeIndex === totalItems - 1) {
+        marginLeft = peekingLastSpace
+      } else {
+        marginLeft = peekingMiddleSpace
+      }
+    }
+
+    if (isLast && isActive) {
+      marginRight = peekingMarginRight
+    } else {
+      marginRight = peekingGap
+    }
+  }
+
+  const style = {
+    width: adjustedWidth,
+    marginLeft,
+    marginRight
+  }
+
+  if (hidden && Platform.OS === 'web') {
+    style.visibility = 'hidden'
+  }
+
+  return style
+}
+
 /**
  * `Carousel.Item` is used to wrap the content of an individual slide and is suppsoed to be the
  * only top-level component passed to the `Carousel`
  */
 const CarouselItem = React.forwardRef(
-  ({ children, elementIndex, tag = 'li', hidden, ...rest }, ref) => {
-    const { width, activeIndex } = useCarousel()
+  ({ children, elementIndex, tag = 'li', hidden, enablePeeking, peekingProps, ...rest }, ref) => {
+    const { width, activeIndex, totalItems, height } = useCarousel()
 
     const selectedProps = selectProps({
       ...rest,
@@ -27,13 +87,23 @@ const CarouselItem = React.forwardRef(
     })
 
     const focusabilityProps = activeIndex === elementIndex ? {} : a11yProps.nonFocusableProps
-    const style = { width }
-    if (hidden && Platform.OS === 'web') {
-      // On web, visibility: hidden makes all children non-focusable. It doesn't exist on native.
-      style.visibility = 'hidden'
-    }
+
     return (
-      <View style={style} {...selectedProps} {...focusabilityProps} ref={ref}>
+      <View
+        style={selectContainerStyle({
+          width,
+          activeIndex,
+          elementIndex,
+          totalItems,
+          hidden,
+          height,
+          enablePeeking,
+          ...peekingProps
+        })}
+        {...selectedProps}
+        {...focusabilityProps}
+        ref={ref}
+      >
         {children}
       </View>
     )
@@ -67,7 +137,22 @@ CarouselItem.propTypes = {
   /**
    * Function to set carousel content background color when slide is being display
    */
-  setContentBackgroundColor: PropTypes.func
+  setContentBackgroundColor: PropTypes.func,
+  /**
+   * Boolean to enable peeking effect on the first and last slide
+   */
+  enablePeeking: PropTypes.bool,
+  /**
+   * Object to configure the peeking effect
+   */
+  peekingProps: PropTypes.shape({
+    peekingMarginLeft: PropTypes.number,
+    peekingMarginRight: PropTypes.number,
+    peekingFirstSpace: PropTypes.number,
+    peekingLastSpace: PropTypes.number,
+    peekingMiddleSpace: PropTypes.number,
+    peekingGap: PropTypes.number
+  })
 }
 
 CarouselItem.displayName = 'Carousel.Item'

package/src/Fieldset/FieldsetContainer.jsx

@@ -19,18 +19,18 @@ const FieldsetContainer = React.forwardRef(
       name: fieldsetName,
       showBorderStyle = false,
       borderStyle,
+      style,
       ...rest
     },
     ref
   ) => {
     // If needs border for error design or reset the component style
     const styleContainer = showBorderStyle && borderStyle ? borderStyle : cssReset
-
     return (
       <fieldset
         ref={ref}
         disabled={inactive}
-        style={styleContainer}
+        style={{ ...styleContainer, ...style }}
         role={accessibilityRole}
         name={fieldsetName}
         {...selectProps(rest)}
@@ -49,7 +49,8 @@ FieldsetContainer.propTypes = {
   inactive: PropTypes.bool,
   name: PropTypes.string,
   showBorderStyle: PropTypes.bool,
-  borderStyle: PropTypes.object
+  borderStyle: PropTypes.object,
+  style: PropTypes.object
 }
 
 export default FieldsetContainer

package/src/Fieldset/FieldsetContainer.native.jsx

@@ -8,17 +8,20 @@ const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, vie
 
 // No equivalent of `<fieldset>` on native, so just apply accessibility role to container.
 // If a11y testing finds any additional handling is needed at the container level, add it here.
-const FieldsetContainer = React.forwardRef(({ children, accessibilityRole, ...rest }, ref) => (
-  <View ref={ref} accessibilityRole={accessibilityRole} {...selectProps(rest)}>
-    {children}
-  </View>
-))
+const FieldsetContainer = React.forwardRef(
+  ({ children, accessibilityRole, style, ...rest }, ref) => (
+    <View ref={ref} accessibilityRole={accessibilityRole} {...selectProps(rest)} style={style}>
+      {children}
+    </View>
+  )
+)
 FieldsetContainer.displayName = 'FieldsetContainer'
 
 FieldsetContainer.propTypes = {
   ...selectedSystemPropTypes,
   children: PropTypes.node,
-  accessibilityRole: PropTypes.string
+  accessibilityRole: PropTypes.string,
+  style: PropTypes.object
 }
 
 export default FieldsetContainer