@telus-uds/components-base 1.83.0 → 1.84.0

package/lib-module/Carousel/Carousel.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState, useRef, useEffect, useCallback, useMemo, forwardRef } from 'react';
 import View from "react-native-web/dist/exports/View";
 import Animated from "react-native-web/dist/exports/Animated";
 import PanResponder from "react-native-web/dist/exports/PanResponder";
@@ -22,6 +22,11 @@ import CarouselTabsPanelItem from './CarouselTabs/CarouselTabsPanelItem';
 import dictionary from './dictionary';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
+const TRANSITION_MODES = {
+  MANUAL: 'manual',
+  AUTOMATIC: 'automatic',
+  SWIPE: 'swipe'
+};
 const staticStyles = StyleSheet.create({
   root: {
     backgroundColor: 'transparent',
@@ -30,6 +35,12 @@ const staticStyles = StyleSheet.create({
     position: 'relative',
     top: 0,
     left: 0
+  },
+  animationControlButton: {
+    position: 'absolute',
+    zIndex: 1,
+    right: Platform.OS === 'web' ? undefined : 40,
+    top: 40
   }
 });
 const selectContainerStyles = width => ({
@@ -42,12 +53,29 @@ const selectSwipeAreaStyles = (count, width) => ({
   justifyContent: 'space-between',
   flexDirection: 'row'
 });
+const getDynamicPositionProperty = areStylesAppliedOnPreviousButton => areStylesAppliedOnPreviousButton ? 'left' : 'right';
+const selectControlButtonPositionStyles = _ref => {
+  let {
+    positionVariant,
+    buttonWidth,
+    positionProperty = getDynamicPositionProperty(),
+    spaceBetweenSlideAndButton
+  } = _ref;
+  const styles = {};
+  if (positionVariant === 'edge') {
+    styles[positionProperty] = -1 * (buttonWidth / 2);
+  } else if (positionVariant === 'inside') {
+    styles[positionProperty] = 0;
+  } else if (positionVariant === 'outside') {
+    styles[positionProperty] = -1 * (spaceBetweenSlideAndButton + buttonWidth);
+  }
+  return styles;
+};
 const selectPreviousNextNavigationButtonStyles = (previousNextNavigationButtonWidth, previousNextNavigationPosition, spaceBetweenSlideAndPreviousNextNavigation, isFirstSlide, isLastSlide, areStylesAppliedOnPreviousButton) => {
   const styles = {
     zIndex: 1,
     position: 'absolute'
   };
-  const dynamicPositionProperty = areStylesAppliedOnPreviousButton ? 'left' : 'right';
   if (isFirstSlide) {
     styles.visibility = areStylesAppliedOnPreviousButton ? 'hidden' : 'visible';
   } else if (isLastSlide) {
@@ -55,19 +83,20 @@ const selectPreviousNextNavigationButtonStyles = (previousNextNavigationButtonWi
   } else {
     styles.visibility = 'visible';
   }
-  if (previousNextNavigationPosition === 'edge') {
-    styles[dynamicPositionProperty] = -1 * (previousNextNavigationButtonWidth / 2);
-  } else if (previousNextNavigationPosition === 'inside') {
-    styles[dynamicPositionProperty] = 0;
-  } else if (previousNextNavigationPosition === 'outside') {
-    styles[dynamicPositionProperty] = -1 * (spaceBetweenSlideAndPreviousNextNavigation + previousNextNavigationButtonWidth);
-  }
-  return styles;
+  return {
+    ...styles,
+    ...selectControlButtonPositionStyles({
+      positionVariant: previousNextNavigationPosition,
+      buttonWidth: previousNextNavigationButtonWidth,
+      positionProperty: getDynamicPositionProperty(areStylesAppliedOnPreviousButton),
+      spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation
+    })
+  };
 };
-const selectIconStyles = _ref => {
+const selectIconStyles = _ref2 => {
   let {
     iconBackgroundColor
-  } = _ref;
+  } = _ref2;
   return {
     backgroundColor: iconBackgroundColor
   };
@@ -128,7 +157,7 @@ const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, vie
   - `spaceBetweenSlideAndPreviousNextNavigation` - Horizontal space between slide and previous/next navigational buttons
   - `spaceBetweenSlideAndPanelNavigation` - Vertical space between slide area and panel navigation area
  */
-const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
+const Carousel = /*#__PURE__*/forwardRef((_ref3, ref) => {
   let {
     tokens,
     variant,
@@ -158,8 +187,21 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     accessibilityLabel,
     accessibilityLiveRegion = 'polite',
     copy,
+    slideDuration = 0,
+    transitionDuration = 0,
+    autoPlay = false,
     ...rest
-  } = _ref2;
+  } = _ref3;
+  let childrenArray = unpackFragment(children);
+  const autoPlayFeatureEnabled = autoPlay && slideDuration > 0 && transitionDuration > 0 && childrenArray.length > 1;
+  // if `Carousel` only has one `Carousel.Item`, convert this to a single-item array
+  if (!Array.isArray(childrenArray)) {
+    childrenArray = [childrenArray];
+  }
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
   const viewport = useViewport();
   const themeTokens = useThemeTokens('Carousel', tokens, variant, {
     viewport
@@ -167,84 +209,53 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
   const {
     previousIcon,
     nextIcon,
+    playIcon,
+    pauseIcon,
     showPreviousNextNavigation,
     showPanelNavigation,
     showPanelTabs,
     spaceBetweenSlideAndPreviousNextNavigation
   } = themeTokens;
-  const [activeIndex, setActiveIndex] = React.useState(0);
-  const [isAnimating, setIsAnimating] = React.useState(false);
-  const handleAnimationStart = React.useCallback(function () {
-    if (typeof onAnimationStart === 'function') onAnimationStart(...arguments);
-    setIsAnimating(true);
-  }, [onAnimationStart]);
-  const handleAnimationEnd = React.useCallback(function () {
-    if (typeof onAnimationEnd === 'function') onAnimationEnd(...arguments);
-    setIsAnimating(false);
-  }, [onAnimationEnd]);
-  const getCopy = useCopy({
-    dictionary,
-    copy
-  });
-  let childrenArray = unpackFragment(children);
-  // if `Carousel` only has one `Carousel.Item`, convert this to a single-item array
-  if (!Array.isArray(childrenArray)) {
-    childrenArray = [childrenArray];
-  }
-  const systemProps = selectProps({
-    ...rest,
-    accessibilityRole,
-    accessibilityLabel,
-    accessibilityValue: {
-      min: 1,
-      max: childrenArray.length,
-      now: activeIndex + 1
-    }
-  });
+  const [activeIndex, setActiveIndex] = useState(0);
+  const activeIndexRef = useRef(activeIndex);
   const {
     reduceMotionEnabled
   } = useA11yInfo();
+  const reduceMotionRef = useRef(reduceMotionEnabled);
   const [containerLayout, setContainerLayout] = React.useState({
     x: 0,
     y: 0,
     width: 0
   });
-  const [previousNextNavigationButtonWidth, setPreviousNextNavigationButtonWidth] = React.useState(0);
-  const firstFocusRef = React.useRef(null);
-  const pan = React.useRef(new Animated.ValueXY()).current;
-  const animatedX = React.useRef(0);
-  const animatedY = React.useRef(0);
+  const containerLayoutRef = useRef(containerLayout);
+  const [previousNextNavigationButtonWidth, setPreviousNextNavigationButtonWidth] = useState(0);
+  const firstFocusRef = useRef(null);
+  const pan = useRef(new Animated.ValueXY()).current;
+  const animatedX = useRef(0);
+  const animatedY = useRef(0);
+  const [isAnimating, setIsAnimating] = useState(false);
+  /**
+   * While having the same starting point, `isAutoPlayEnabled` and `isCarouselPlaying` are different states
+   *
+   * `isAutoPlayEnabled` is a state to determine if the autoplay feature is enabled or disabled
+   * `isCarouselPlaying` is a state to determine if the carousel is currently playing or paused
+   */
+  const [isAutoPlayEnabled, setIsAutoPlayEnabled] = useState(autoPlayFeatureEnabled);
+  const [isCarouselPlaying, setisCarouselPlaying] = useState(autoPlayFeatureEnabled);
+  const isSwiping = useRef(false);
+  const autoPlayRef = useRef(null);
   const isFirstSlide = !activeIndex;
-  const isLastSlide = activeIndex + 1 >= children.length;
-  const onContainerLayout = _ref3 => {
-    let {
-      nativeEvent: {
-        layout: {
-          x,
-          y,
-          width
-        }
-      }
-    } = _ref3;
-    return setContainerLayout(prevState => ({
-      ...prevState,
-      x,
-      y,
-      width
-    }));
-  };
-  const onPreviousNextNavigationButtonLayout = _ref4 => {
-    let {
-      nativeEvent: {
-        layout: {
-          width
-        }
-      }
-    } = _ref4;
-    return setPreviousNextNavigationButtonWidth(width);
-  };
-  const updateOffset = React.useCallback(() => {
-    animatedX.current = containerLayout.width * activeIndex * -1;
+  const isLastSlide = activeIndex + 1 >= childrenArray.length;
+  const handleAnimationStart = useCallback(function () {
+    if (typeof onAnimationStart === 'function') onAnimationStart(...arguments);
+    setIsAnimating(true);
+  }, [onAnimationStart]);
+  const handleAnimationEnd = useCallback(function () {
+    if (typeof onAnimationEnd === 'function') onAnimationEnd(...arguments);
+    setIsAnimating(false);
+  }, [onAnimationEnd]);
+  const updateOffset = useCallback(() => {
+    animatedX.current = containerLayoutRef.current.width * activeIndexRef.current * -1;
     animatedY.current = 0;
     pan.setOffset({
       x: animatedX.current,
@@ -254,20 +265,27 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       x: 0,
       y: 0
     });
-  }, [activeIndex, containerLayout.width, pan, animatedX]);
-  const animate = React.useCallback((toValue, toIndex) => {
+  }, [pan, animatedX]);
+  const animate = useCallback((toValue, toIndex) => {
     const handleAnimationEndToIndex = function () {
       for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
         args[_key] = arguments[_key];
       }
       return handleAnimationEnd(toIndex, ...args);
     };
-    if (reduceMotionEnabled) {
+    if (reduceMotionRef.current || isSwiping.current) {
       Animated.timing(pan, {
         toValue,
         duration: 1,
         useNativeDriver: false
       }).start(handleAnimationEndToIndex);
+    } else if (isAutoPlayEnabled) {
+      Animated.timing(pan, {
+        ...springConfig,
+        toValue,
+        useNativeDriver: false,
+        duration: transitionDuration * 1000
+      }).start(handleAnimationEndToIndex);
     } else {
       Animated.spring(pan, {
         ...springConfig,
@@ -275,45 +293,157 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
         useNativeDriver: false
       }).start(handleAnimationEndToIndex);
     }
-  }, [pan, springConfig, reduceMotionEnabled, handleAnimationEnd]);
-  const updateIndex = React.useCallback(function () {
+  }, [pan, springConfig, handleAnimationEnd, transitionDuration, isAutoPlayEnabled]);
+  const stopAutoplay = useCallback(() => {
+    if (autoPlayRef !== null && autoPlayRef !== void 0 && autoPlayRef.current) {
+      clearTimeout(autoPlayRef === null || autoPlayRef === void 0 ? void 0 : autoPlayRef.current);
+    }
+  }, []);
+  const updateIndex = useCallback(function () {
     let delta = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+    let transitionMode = arguments.length > 1 ? arguments[1] : undefined;
     const toValue = {
       x: 0,
       y: 0
     };
     let skipChanges = !delta;
     let calcDelta = delta;
-    if (activeIndex <= 0 && delta < 0) {
-      skipChanges = true;
-      calcDelta = children.length + delta;
-    } else if (activeIndex + 1 >= children.length && delta > 0) {
-      skipChanges = true;
-      calcDelta = -1 * activeIndex + delta - 1;
+    if (activeIndexRef.current <= 0 && delta < 0) {
+      skipChanges = transitionMode !== TRANSITION_MODES.AUTOMATIC;
+      calcDelta = childrenArray.length + delta;
+    } else if (activeIndexRef.current + 1 >= childrenArray.length && delta > 0) {
+      skipChanges = transitionMode !== TRANSITION_MODES.AUTOMATIC;
+      calcDelta = -1 * activeIndexRef.current + delta - 1;
     }
-    const index = activeIndex + calcDelta;
+    const index = activeIndexRef.current + calcDelta;
     if (skipChanges) {
       animate(toValue, index);
       return calcDelta;
     }
+    stopAutoplay();
     setActiveIndex(index);
-    toValue.x = containerLayout.width * -1 * calcDelta;
+    toValue.x = containerLayoutRef.current.width * -1 * calcDelta;
     animate(toValue, index);
+    if (isCarouselPlaying) {
+      stopAutoplay();
+      if (index === 0 && activeIndexRef.current + 1 === childrenArray.length && transitionMode === TRANSITION_MODES.AUTOMATIC) {
+        setisCarouselPlaying(false);
+      } else if (isAutoPlayEnabled) {
+        autoPlayRef.current = setTimeout(() => {
+          var _firstFocusRef$curren;
+          updateOffset();
+          handleAnimationStart(activeIndexRef.current);
+          updateIndex(slideDuration < 0 ? -1 : 1, TRANSITION_MODES.AUTOMATIC);
+          if (refocus) (_firstFocusRef$curren = firstFocusRef.current) === null || _firstFocusRef$curren === void 0 ? void 0 : _firstFocusRef$curren.focus();
+        }, Math.abs(slideDuration) * 1000);
+      }
+    }
     if (onIndexChanged) onIndexChanged(calcDelta, index);
     return calcDelta;
-  }, [containerLayout.width, activeIndex, animate, children.length, onIndexChanged]);
-  const fixOffsetAndGo = React.useCallback(delta => {
-    var _firstFocusRef$curren;
+  }, [handleAnimationStart, refocus, slideDuration, updateOffset, animate, childrenArray.length, onIndexChanged, isCarouselPlaying, stopAutoplay, isAutoPlayEnabled]);
+  const startAutoplay = useCallback(() => {
+    stopAutoplay();
+    if (isAutoPlayEnabled) {
+      autoPlayRef.current = setTimeout(() => {
+        var _firstFocusRef$curren2;
+        updateOffset();
+        handleAnimationStart(activeIndexRef.current);
+        updateIndex(slideDuration < 0 ? -1 : 1, TRANSITION_MODES.AUTOMATIC);
+        if (refocus && Platform.OS === 'web') (_firstFocusRef$curren2 = firstFocusRef.current) === null || _firstFocusRef$curren2 === void 0 ? void 0 : _firstFocusRef$curren2.focus();
+      }, Math.abs(slideDuration) * 1000);
+    }
+  }, [handleAnimationStart, refocus, updateIndex, updateOffset, slideDuration, stopAutoplay, isAutoPlayEnabled]);
+  const fixOffsetAndGo = useCallback((delta, transitionMode) => {
+    var _firstFocusRef$curren3;
     updateOffset();
-    handleAnimationStart(activeIndex);
-    updateIndex(delta);
-    if (refocus) (_firstFocusRef$curren = firstFocusRef.current) === null || _firstFocusRef$curren === void 0 ? void 0 : _firstFocusRef$curren.focus();
-  }, [updateIndex, updateOffset, activeIndex, handleAnimationStart, refocus]);
-  const goToNeighboring = React.useCallback(function () {
+    handleAnimationStart(activeIndexRef.current);
+    updateIndex(delta, transitionMode);
+    if (refocus && Platform.OS === 'web') (_firstFocusRef$curren3 = firstFocusRef.current) === null || _firstFocusRef$curren3 === void 0 ? void 0 : _firstFocusRef$curren3.focus();
+  }, [updateIndex, updateOffset, handleAnimationStart, refocus]);
+  const goToNeighboring = useCallback(function () {
     let toPrev = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-    fixOffsetAndGo(toPrev ? -1 : 1);
+    let transitionMode = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : TRANSITION_MODES.MANUAL;
+    fixOffsetAndGo(toPrev ? -1 : 1, transitionMode);
   }, [fixOffsetAndGo]);
-  const isSwipeAllowed = React.useCallback(() => {
+  useEffect(() => {
+    activeIndexRef.current = activeIndex;
+  }, [activeIndex]);
+  useEffect(() => {
+    reduceMotionRef.current = reduceMotionEnabled;
+  }, [reduceMotionEnabled]);
+  useEffect(() => {
+    containerLayoutRef.current = containerLayout;
+  }, [containerLayout]);
+  useEffect(() => {
+    pan.x.addListener(_ref4 => {
+      let {
+        value
+      } = _ref4;
+      animatedX.current = value;
+    });
+    pan.y.addListener(_ref5 => {
+      let {
+        value
+      } = _ref5;
+      animatedY.current = value;
+    });
+    if (isCarouselPlaying) {
+      startAutoplay();
+    }
+    return () => {
+      stopAutoplay();
+      pan.x.removeAllListeners();
+      pan.y.removeAllListeners();
+    };
+  }, [pan.x, pan.y, startAutoplay, stopAutoplay, isCarouselPlaying]);
+  useEffect(() => {
+    const subscription = Dimensions.addEventListener('change', () => {
+      updateOffset();
+    });
+    return () => {
+      if (subscription.remove) {
+        subscription.remove();
+      } else {
+        Dimensions.removeEventListener('change', updateOffset);
+      }
+    };
+  }, [updateOffset]);
+  useEffect(() => {
+    setIsAutoPlayEnabled(autoPlay && slideDuration > 0 && transitionDuration > 0 && childrenArray.length > 1);
+  }, [autoPlay, slideDuration, transitionDuration, childrenArray.length]);
+  useEffect(() => {
+    return () => {
+      stopAutoplay();
+    };
+  }, [stopAutoplay]);
+  const onContainerLayout = _ref6 => {
+    let {
+      nativeEvent: {
+        layout: {
+          x,
+          y,
+          width
+        }
+      }
+    } = _ref6;
+    return setContainerLayout(prevState => ({
+      ...prevState,
+      x,
+      y,
+      width
+    }));
+  };
+  const onPreviousNextNavigationButtonLayout = _ref7 => {
+    let {
+      nativeEvent: {
+        layout: {
+          width
+        }
+      }
+    } = _ref7;
+    return setPreviousNextNavigationButtonWidth(width);
+  };
+  const isSwipeAllowed = useCallback(() => {
     if (childrenArray.length === 1) {
       return false;
     }
@@ -322,72 +452,59 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     }
     return true;
   }, [viewport, childrenArray.length]);
-  const panResponder = React.useMemo(() => PanResponder.create({
+  const panResponder = useMemo(() => PanResponder.create({
     onPanResponderTerminationRequest: () => false,
     onMoveShouldSetResponderCapture: () => true,
     onMoveShouldSetPanResponderCapture: (_, gestureState) => {
       if (!isSwipeAllowed()) {
         return false;
       }
-      handleAnimationStart(activeIndex);
-      return Math.abs(gestureState.dx) > minDistanceToCapture;
+      handleAnimationStart(activeIndexRef.current);
+      const allow = Math.abs(gestureState.dx) > minDistanceToCapture;
+      if (allow) {
+        isSwiping.current = true;
+        stopAutoplay();
+      }
+      return allow;
+    },
+    onPanResponderGrant: () => {
+      updateOffset();
     },
-    onPanResponderGrant: () => updateOffset(),
     onPanResponderMove: Animated.event([null, {
       dx: pan.x
     }], {
       useNativeDriver: false
     }),
     onPanResponderRelease: (_, gesture) => {
+      if (isCarouselPlaying) {
+        startAutoplay();
+      }
       const correction = gesture.moveX - gesture.x0;
-      if (Math.abs(correction) < containerLayout.width * minDistanceForAction) {
+      if (Math.abs(correction) < containerLayoutRef.current.width * minDistanceForAction) {
         animate({
           x: 0,
           y: 0
         }, 0);
       } else {
         const delta = correction > 0 ? -1 : 1;
-        updateIndex(delta);
+        updateIndex(delta, TRANSITION_MODES.SWIPE);
       }
+      isSwiping.current = false;
     }
-  }), [containerLayout.width, updateIndex, updateOffset, animate, isSwipeAllowed, activeIndex, minDistanceForAction, handleAnimationStart, minDistanceToCapture, pan.x]);
-  React.useEffect(() => {
-    pan.x.addListener(_ref5 => {
-      let {
-        value
-      } = _ref5;
-      animatedX.current = value;
-    });
-    pan.y.addListener(_ref6 => {
-      let {
-        value
-      } = _ref6;
-      animatedY.current = value;
-    });
-    return () => {
-      pan.x.removeAllListeners();
-      pan.y.removeAllListeners();
-    };
-  }, [pan.x, pan.y]);
-  React.useEffect(() => {
-    const subscription = Dimensions.addEventListener('change', () => {
-      updateOffset();
-    });
-    return () => subscription === null || subscription === void 0 ? void 0 : subscription.remove();
-  });
-  const goToNext = React.useCallback(() => {
+  }), [updateIndex, updateOffset, animate, isSwipeAllowed, minDistanceForAction, handleAnimationStart, minDistanceToCapture, pan.x, startAutoplay, stopAutoplay, isCarouselPlaying]);
+  const goToNext = useCallback(() => {
     goToNeighboring();
   }, [goToNeighboring]);
-  const goToPrev = React.useCallback(() => {
+  const goToPrev = useCallback(() => {
     goToNeighboring(true);
   }, [goToNeighboring]);
-  const goTo = React.useCallback(function () {
+  const goTo = useCallback(function () {
     let index = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    const delta = index - activeIndex;
+    const delta = index - activeIndexRef.current;
     if (delta) {
-      fixOffsetAndGo(delta);
+      fixOffsetAndGo(delta, TRANSITION_MODES.MANUAL);
     }
-  }, [fixOffsetAndGo, activeIndex]);
+  }, [fixOffsetAndGo]);
 
   // @TODO: - these are Allium-theme variants and won't have any effect in themes that don't implement them.
   // Normally we avoid setting variants of subcomponents, however this could be re-considered.
@@ -397,7 +514,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
     raised: !(variant !== null && variant !== void 0 && variant.inverse) && true,
     inverse: variant === null || variant === void 0 ? void 0 : variant.inverse
   };
-  const getCopyWithPlaceholders = React.useCallback(copyKey => {
+  const getCopyWithPlaceholders = useCallback(copyKey => {
     const copyText = getCopy(copyKey).replace(/%\{title\}/g, title).replace(/%\{itemLabel\}/g, itemLabel).replace(/%\{stepNumber\}/g, activeIndex + 1).replace(/%\{stepCount\}/g, childrenArray.length);
 
     // First word might be a lowercase placeholder: capitalize the first letter
@@ -420,6 +537,17 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       }
     }
   };
+  const systemProps = selectProps({
+    ...rest,
+    accessibilityRole,
+    accessibilityLabel,
+    accessibilityValue: {
+      min: 1,
+      max: childrenArray.length,
+      now: activeIndex + 1
+    }
+  });
+
   // If container isn't used for focus, give it a label of title if none is passed in,
   // otherwise read the current position on focus
   const containerAccessibilityLabel = systemProps.accessibilityLabel ?? isFirstFocusContainer ? `${title ? `${title} ` : ''}${getCopyWithPlaceholders('stepTrackerLabel')}` : title;
@@ -431,6 +559,14 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       focusable: true
     })
   };
+  const onAnimationControlButtonPress = useCallback(() => {
+    if (isCarouselPlaying) {
+      stopAutoplay();
+    } else {
+      startAutoplay();
+    }
+    setisCarouselPlaying(prevState => !prevState);
+  }, [isCarouselPlaying, stopAutoplay, startAutoplay]);
   return /*#__PURE__*/_jsxs(CarouselProvider, {
     activeIndex: activeIndex,
     goTo: goTo,
@@ -447,7 +583,19 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       ref: ref,
       ...systemProps,
       ...containerProps,
-      children: [showPreviousNextNavigation && childrenArray.length > 1 ? /*#__PURE__*/_jsx(View, {
+      children: [isAutoPlayEnabled ? /*#__PURE__*/_jsx(View, {
+        style: [staticStyles.animationControlButton, selectControlButtonPositionStyles({
+          positionVariant: previousNextNavigationPosition,
+          buttonWidth: previousNextNavigationButtonWidth,
+          positionProperty: getDynamicPositionProperty(),
+          spaceBetweenSlideAndButton: spaceBetweenSlideAndPreviousNextNavigation
+        })],
+        children: /*#__PURE__*/_jsx(IconButton, {
+          icon: isCarouselPlaying ? pauseIcon : playIcon,
+          variant: previousNextIconButtonVariants,
+          onPress: onAnimationControlButtonPress
+        })
+      }) : null, showPreviousNextNavigation && childrenArray.length > 1 ? /*#__PURE__*/_jsx(View, {
         style: selectPreviousNextNavigationButtonStyles(previousNextNavigationButtonWidth, previousNextNavigationPosition, spaceBetweenSlideAndPreviousNextNavigation, isFirstSlide, isLastSlide, true),
         testID: "previous-button-container",
         children: /*#__PURE__*/_jsx(IconButton, {
@@ -471,7 +619,7 @@ const Carousel = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
       }), /*#__PURE__*/_jsx(View, {
         style: selectContainerStyles(containerLayout.width),
         children: /*#__PURE__*/_jsx(Animated.View, {
-          style: StyleSheet.flatten([selectSwipeAreaStyles(children.length, containerLayout.width), {
+          style: StyleSheet.flatten([selectSwipeAreaStyles(childrenArray.length, containerLayout.width), {
             transform: [{
               translateX: pan.x
             }, {
@@ -564,7 +712,7 @@ Carousel.propTypes = {
    * This function is also provided with a parameter indicating changed index (either 1, or -1)
    * Use it as follows:
    * ```js
-   *    const onIndexChangedCallback = React.useCallback((changedIndex, currentActiveIndex) => {
+   *    const onIndexChangedCallback = useCallback((changedIndex, currentActiveIndex) => {
    *      console.log(changedIndex)
    *    }, [])  // pass local dependencies as per your component
    *    <Carousel
@@ -615,7 +763,7 @@ Carousel.propTypes = {
    * This function is also provided with a parameter indicating the current slide index before animation starts
    * Use it as follows:
    * ```js
-   *    const onAnimationStartCallback = React.useCallback((currentIndex) => {
+   *    const onAnimationStartCallback = useCallback((currentIndex) => {
    *      console.log(currentIndex)
    *    }, [])  // pass local dependencies as per your component
    *    <Carousel
@@ -632,7 +780,7 @@ Carousel.propTypes = {
    * This function is also provided with a parameter indicating the updated slide index after animation ends
    * Use it as follows:
    * ```js
-   *    const onAnimationEndCallback = React.useCallback((changedIndex) => {
+   *    const onAnimationEndCallback = useCallback((changedIndex) => {
    *      console.log(changedIndex)
    *    }, [])  // pass local dependencies as per your component
    *    <Carousel
@@ -670,7 +818,26 @@ Carousel.propTypes = {
    * Note that if the immediate Carousel children do not all render as `'li'` elements,
    * this should be changed (e.g. pass tag="div") because only 'li' is a valid child of 'ul'.
    */
-  tag: PropTypes.oneOf(layoutTags)
+  tag: PropTypes.oneOf(layoutTags),
+  /**
+   * If set to `true`, the Carousel will automatically transition between slides
+   * and show the play/pause button
+   * - Default value is `false`
+   * - `slideDuration` and `transitionDuration` are required to be set for this to work
+   */
+  autoPlay: PropTypes.bool,
+  /**
+   * Duration of the time in seconds spent on each slide
+   * - Default value is `0`
+   * - `autoPlay` and `transitionDuration` are required to be set for this to work
+   */
+  slideDuration: PropTypes.number,
+  /**
+   * Duration of the time in seconds between each slide transition
+   * - Default value is `0`
+   * - `autoPlay` and `slideDuration` are required to be set for this to work
+   */
+  transitionDuration: PropTypes.number
 };
 Carousel.Item = CarouselItem;
 Carousel.displayName = 'Carousel';