1.0.4 • Published 6 years ago

wheely v1.0.4

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

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

PropDefaultDescription
autoplayfalseEnable autoplay
autoplayTimeout3000Autoplay timeout
infinitefalseInfinite loop sliding
startIndex0Slide to start
slidesToScroll1Slides to scroll
speed300Animation speed
updateIndexCb(index) => nullCallback fired after scrolling
variableSizefalseVariable slide size
verticalfalseVertical

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