@cnbritain/wc-card
Version:
Card component - Portrait, landscape and switcher
67 lines (47 loc) • 1.56 kB
Markdown
# wc-card
Card component - Portrait, landscape and switcher
# Macro Settings:
| Key | Optional | Default | Description |
|------------------|----------|---------|-------------------------------------|
| article | false | | The article model |
| card_type | true | 'portrait' | The layour of the card |
| brand | true | '' | Name of the brand |
| theme | true | 'light' | Colour scheme of the card |
| hide_author | true | True | Hides the author from the meta |
| hide_duration | true | True | Hides the duration from the meta |
| hide_image_icon | true | True | Hides the image icon from the image |
| hide_description | true | True | Hides the description from the card |
# JS Documentation
<a name="module_Card"></a>
## Card
<a name="module_Card.init"></a>
### Card.init()
Initialises the lazyload of images
**Kind**: static method of <code>[Card](#module_Card)</code>
#Current themes:
- Wired
# 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
```
Python the pythons:
```bash
cd demo
virtualenv .
source bin/activate
pip install -r requirements.txt
```
Start the demo server:
```bash
python demo.py
```