@cnbritain/wc-show-item-carousel

wc-show-item-carousel

A carousel that display a list of items

Macro settings

show_item_carousel

Key	Optional	Default	Description
items	false		The list of items to display in the carousel
title	true	None	Can be a string or a list of strings
brand	true	'default'	The brand displaying the component
item_cls	true	''	Additional classes to put on the list item

show_item_carousel_item

Key	Optional	Default	Description
item	false		The item to display
cls	true	''	Additional class for the list item
brand	true	'default'	The brand displaying the component

show_item_carousel_card

Key	Optional	Default	Description
show	false		The show to display in a card
brand	true	'default'	The brand displaying the component

JS Documentation

ShowItemCarousel

Kind: global class

• ShowItemCarousel
  • new ShowItemCarousel(el, _options)
  • .nextItems()
  • .previousItems()
  • .scrollTo(x)

new ShowItemCarousel(el, _options)

Show Item carousel

Param	Type
el	HTMLElement
_options	Object

showItemCarousel.nextItems()

Display the next items in the list

Kind: instance method of ShowItemCarousel

showItemCarousel.previousItems()

Displays the previous items in the list

Kind: instance method of ShowItemCarousel

showItemCarousel.scrollTo(x)

Scrolls the element to x position

Kind: instance method of ShowItemCarousel

Param	Type
x	Number

Themes

• Vogue

Prerequisites:

• Node.js — brew install node
• Grunt - npm install -g grunt-cli
• Other prereqs? Python? Virtualenv?

Demo:

Install dependencies:

npm install

Build the things:

npm run sass
npm run js
npm run docs

Hint your JS

npm run jshint

Python the pythons:

npm run demo-install

Start the demo server:

python demo.py