wheely

1.0.4 • Public • Published

Wheely

Build Status Coveralls

React carousel component.

Install

npm install wheely --save

Example usage

import React from 'react';
import Carousel from 'wheely';

const CarouselTest = () => {
  const settings = {
    pageLength: 1,
    infinite: true,
  };

  return (
    <Carousel {...settings}>
      <div>1</div>
      <div>2</div>
      <div>3</div>
    </Carousel>
  );
};

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

Package Sidebar

Install

npm i wheely

Weekly Downloads

6

Version

1.0.4

License

MIT

Unpacked Size

256 kB

Total Files

18

Last publish

Collaborators

  • cisac