React carousel component
npm install wheely
[![Coveralls][coveralls-badge]][coveralls]
React carousel component.
Install
-npm install wheely --save
Example usage
-------------
``js
import React from 'react';
import Carousel from 'wheely';
const CarouselTest = () => {
const settings = {
pageLength: 1,
infinite: true,
};
return (
1
2
3
);
};
``
Props
-
Prop | Default | Description
-----|---------|------------
autoplay|false| Enable autoplay
autoplayTimeout|3000| Autoplay timeout
infinite|false|Infinite loop sliding
startIndex|0| Slide to start
slidesToScroll|1| Slides to scroll
speed|300| Animation speed
updateIndexCb|(index) => null| Callback fired after scrolling
variableSize|false| Variable slide size
vertical|false| Vertical
Contributing
-
Thank you for considering contributing!
Please use GitHub issues and Pull Requests for Contributing.
License
-
The MIT License (MIT). Please see License File for more information.
Todo
-
- [ ] Write tests
[npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square
[npm]: https://www.npmjs.org/package/wheely
[coveralls-badge]: https://img.shields.io/coveralls/cisac/wheely/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/cisac/wheely