apeman-react-slideshow

apeman-react-slideshow
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-react-labo/apeman-react-slideshow
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-slideshow
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-slideshow.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-slideshow
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-slideshow.svg?token=
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-slideshow/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-slideshow
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-slideshow.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-slideshow.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-slideshow
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-slideshow.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-slideshow
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-slideshow.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

apeman react package for slideshow components.

Installation
-----

``bash
$ npm install apeman-react-slideshow --save
`

Demo
-----

[Live demo][demo_url] is hosted on GitHub Pages.

[demo_url]: http://apeman-react-labo.github.io/apeman-react-slideshow/demo/demo.html

Usage
---------

`jsx
'use strict'

import React from 'react'
import {ApSlideshow, ApSlideshowStyle} from 'apeman-react-slideshow'

const ExampleComponent = React.createClass({
render () {
return (


``

Components
-----

$3

Props

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| style | object | {} | | |

$3

Props

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| images | array | [] | | Image URLs |
| repeat | bool | false | | Repeat flipping |
| width | number | 420 | | Component width |
| height | number | 280 | | Component height |
| interval | number | 20000 | | Flip interval |
| effect | enum | 'fadeAndScale' | | Flip effect |

License
-------
This software is released under the MIT License.

Links
------

+ [apeman][apeman_url]
+ [apeman-react-labo][apeman_react_labo_url]
+ [React][react_url]

[apeman_url]: https://github.com/apeman-labo/apeman
[apeman_react_labo_url]: https://github.com/apeman-react-labo
[react_url]: https://facebook.github.io/react/