Need private packages and team management tools?Check out npm Teams »

@aprilmintacpineda/react-carousel

1.2.5 • Public • Published

react-carousel

Carousel component for reactJS.

See Demo.

install

npm i -s react-carousel js-carousel

Usage

On your main entry file:

import 'js-carousel';

Then, whenever you want to use the component.

import ReactCarousel from 'react-carousel';

Then:

<ReactCarousel animationSpeed={500} itemDuration={5000} swipeThreshold={150}>
  <img src="path-to-image" />
  <img src="path-to-image" />
  <img src="path-to-image" />
  <img src="path-to-image" />
  <img src="path-to-image" />
</ReactCarousel>

You can also specify a className for the container of the carousel by providing a className prop to it.

  • animationSpeed is the speed (in terms of milliseconds) of the transition animation.
  • itemDuration is the amount of time (in terms of milliseconds) it has to wait before transitioning to the next item.
  • swipeThreshold is the sensitivity of swipe, the lower the number the more sensitive the swipe will be, you don't want it to be very high otherwise the users would have a hard time navigating around using swipe. You don't want it to be very low, otherwise a click might become enough to navigate around using swipe. I suggest starting at 150 and tweaking it from there according to how you like it.

If you expect your images to change (you can see this on the demo), you should provide a key to the component and make sure that the key is different for every changes like so:

<ReactCarousel
  key={this.state.carouselImages.key}
  animationSpeed={500}
  itemDuration={5000}
  swipeThreshold={150}>
  {this.state.carouselImages.srcs.map(src => {
    <img key={src} src={src} />;
  })}
</ReactCarousel>
// upon updating
this.setState({
  carouselImages: {
    // the key would be different from the last one
    key: this.state.carouselImages.key + 1,
    src
  }
});

react-carousel uses js-carousel.

Install

npm i @aprilmintacpineda/react-carousel

DownloadsWeekly Downloads

0

Version

1.2.5

License

MIT

Unpacked Size

7.34 kB

Total Files

5

Last publish

Collaborators

  • avatar