Skip to content

product-assortment-carousel-block 0.1.1-arc-themes-release-version-2.0.1.4488

Install from the command line:
Learn more about npm packages
$ npm install @wpmedia/product-assortment-carousel-block@0.1.1-arc-themes-release-version-2.0.1.4488
Install via package.json:
"@wpmedia/product-assortment-carousel-block": "0.1.1-arc-themes-release-version-2.0.1.4488"

About this version

@wpmedia/product-assortment-carousel-block

A carousel block to display product assortments (rules) from Algolia.

The block is dependent on the PageBuilder Product Assortment integration to enable selecting the assortment to display within the block.

Props

Prop Required Type Description
customFields yes PropTypes.shape Pagebuilder Custom Fields

customFields

Prop Required Type Description
carouselLabel no PropTypes.string Label to apply to the Carousel for assistive technologies
headerText no PropTypes.string Carousel Header text
itemsToDisplay no PropTypes.number Number of items to show in Carousel, Min: 4, Max: 12

Algolia Data

The block relies on Algolia data to render the products in the carousel. The fields the block uses is

  • Name
  • Image
  • Attributes - array of objects
    • name = product_url
  • Prices - array of object
    • type = List
    • type = Sale
    • For each price
      • currencyLocale
      • currencyCode
      • amount
      • type

Internationalization fields

Phrase key Default (English)
product-assortment-carousel.aria-label Stories
product-assortment-carousel.right-arrow-label Next
product-assortment-carousel.left-arrow-label Previous
product-assortment-carousel.slide-indicator Slide %{current} of %{maximum}

Event Listening

This block does not emit any events.