# @cnbritain/wc-show-item-carousel

> A carousel that display a list of items

Latest version **1.1.2** (published 2017-02-01) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @cnbritain/wc-show-item-carousel
pnpm add @cnbritain/wc-show-item-carousel
yarn add @cnbritain/wc-show-item-carousel
bun add @cnbritain/wc-show-item-carousel
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-02-01 |
| First published | 2016-07-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | https://github.com/cnduk/ |
| Maintainers | danelliottpalmer, onlinedevtemp, rtt, samtiffin, stefanpiazza |

## Links

- npm: https://www.npmjs.com/package/@cnbritain/wc-show-item-carousel
- Repository: https://github.com/cnduk/wc-show-item-carousel
- Homepage: https://github.com/cnduk/wc-show-item-carousel#readme
- Issues: https://github.com/cnduk/wc-show-item-carousel/issues
- npm.io page: https://npm.io/package/@cnbritain/wc-show-item-carousel

## Dependencies (6)

- [@cnbritain/wc-assets](https://npm.io/package/@cnbritain/wc-assets.md) ^1.38.8
- [@cnbritain/wc-variables](https://npm.io/package/@cnbritain/wc-variables.md) ^1.23.3
- [@cnbritain/wc-sass-fonts](https://npm.io/package/@cnbritain/wc-sass-fonts.md) ^1.4.5
- [@cnbritain/wc-sass-mixins](https://npm.io/package/@cnbritain/wc-sass-mixins.md) ^1.7.1
- [@cnbritain/merlin-frontend-utils-js](https://npm.io/package/@cnbritain/merlin-frontend-utils-js.md) ^1.5.0
- [@cnbritain/merlin-frontend-elementscroll-js](https://npm.io/package/@cnbritain/merlin-frontend-elementscroll-js.md) ^1.2.2

## Recent versions

- 1.1.2 (latest) — 2017-02-01
- 1.1.1 — 2017-02-01
- 1.1.0 — 2016-09-22
- 1.0.12 — 2016-09-19
- 1.0.11 — 2016-09-19
- 1.0.10 — 2016-09-05
- 1.0.9 — 2016-09-02
- 1.0.8 — 2016-08-23
- 1.0.7 — 2016-08-23
- 1.0.6 — 2016-08-18
- 1.0.5 — 2016-08-05
- 1.0.4 — 2016-07-22
- 1.0.3 — 2016-07-12
- 1.0.2 — 2016-07-12
- 1.0.1 — 2016-07-12
- … 1 more at https://npm.io/package/@cnbritain/wc-show-item-carousel/versions

## README

# 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

<a name="ShowItemCarousel"></a>

## ShowItemCarousel
**Kind**: global class  

* [ShowItemCarousel](#ShowItemCarousel)
    * [new ShowItemCarousel(el, _options)](#new_ShowItemCarousel_new)
    * [.nextItems()](#ShowItemCarousel+nextItems)
    * [.previousItems()](#ShowItemCarousel+previousItems)
    * [.scrollTo(x)](#ShowItemCarousel+scrollTo)

<a name="new_ShowItemCarousel_new"></a>

### new ShowItemCarousel(el, _options)
Show Item carousel


| Param | Type |
| --- | --- |
| el | <code>HTMLElement</code> | 
| _options | <code>Object</code> | 

<a name="ShowItemCarousel+nextItems"></a>

### showItemCarousel.nextItems()
Display the next items in the list

**Kind**: instance method of <code>[ShowItemCarousel](#ShowItemCarousel)</code>  
<a name="ShowItemCarousel+previousItems"></a>

### showItemCarousel.previousItems()
Displays the previous items in the list

**Kind**: instance method of <code>[ShowItemCarousel](#ShowItemCarousel)</code>  
<a name="ShowItemCarousel+scrollTo"></a>

### showItemCarousel.scrollTo(x)
Scrolls the element to x position

**Kind**: instance method of <code>[ShowItemCarousel](#ShowItemCarousel)</code>  

| Param | Type |
| --- | --- |
| x | <code>Number</code> | 


# Themes

- Vogue

# Prerequisites:

- [Node.js](https://nodejs.org/) — `brew install node`
- [Grunt](http://gruntjs.com/) - `npm install -g grunt-cli`
- Other prereqs? Python? Virtualenv?

# Demo:

Install dependencies:

```bash
npm install
```

Build the things:

```bash
npm run sass
npm run js
npm run docs
```

Hint your JS

```bash
npm run jshint
```

Python the pythons:

```bash
npm run demo-install
```

Start the demo server:

```bash
python demo.py
```

---
_Source: https://npm.io/package/@cnbritain/wc-show-item-carousel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._