wc-digitaleditions-bbcode-gallery

digital editions gallery

Macro settings

| Key | Optional | Default | Description |
|------------------|----------|---------|-------------------------------------|
| Example arg | false | | |

JS Documentation

@cnbritain/wc-digitaleditions-bbcode-gallery

Digital Editions BBCode gallery

* @cnbritain/wc-digitaleditions-bbcode-gallery
* _static_
* .mapImagesToPswp(imgTuple, i, arr) ⇒ Object
* _inner_
* ~GalleryManager
* new GalleryManager()
* ~init(selectorGalleryThumbs, options) ⇒ void
* ~displayGallery(e) ⇒ void

$3

map function to transform Merlin list of image 2-tuples to Photoswipe array of images (only takes the 2nd value in the tuple)

Kind: static method of @cnbritain/wc-digitaleditions-bbcode-gallery
Returns: Object - item object (http://photoswipe.com/documentation/getting-started.html)

| Param | Type | Description |
| --- | --- | --- |
| imgTuple | Array | 2-tuple containing images |
| i | Number | array index |
| arr | Array | array |

$3

Kind: inner class of @cnbritain/wc-digitaleditions-bbcode-gallery

#### new GalleryManager()
Interface for Photoswipe gallery implementation

$3

initialise

Kind: inner method of @cnbritain/wc-digitaleditions-bbcode-gallery

| Param | Type | Description |
| --- | --- | --- |
| selectorGalleryThumbs | String | selector |
| options | Object | Photoswipe options (http://photoswipe.com/documentation/options.html) |

$3

display the PhotoSwipe gallery

Kind: inner method of @cnbritain/wc-digitaleditions-bbcode-gallery

| Param | Type | Description |
| --- | --- | --- |
| e | Object | display event |

Themes

Prerequisites:

- Node.js — brew install node
- Grunt - 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
``