Typedefs
[props]
Props for ProductImageCarousel
Carousel component for product images Carousel - Component that holds number of images where typically one image visible, and other images can be navigated through previous and next buttons
Returns: React.Element — React carousel component that displays a product image
Parameters
Name
Type
props
propsProps for ProductImageCarousel
Properties
Name
Type
Description
classes
ObjectAn object containing the class names for the ProductImageCarousel component
classes.currentImage
stringclasses for visible image
classes.imageContainer
stringclasses for image container
classes.nextButton
stringclasses for next button
classes.previousButton
stringclasses for previous button
classes.root
stringclasses for root container
images
Array.<Object>Product images input for Carousel
images[].disabled
boolIs image disabled
images[].file
stringfilePath of image
images[].uid
stringthe id of the image
images[].label
stringlabel for image
images[].position
stringPosition of image in Carousel
Source Code: pwa-studio/packages/venia-ui/lib/components/ProductImageCarousel/carousel.js