react-animated-slider

A Slider/Carousel component for React supporting custom css animations.

Demo - Codesandbox Playground

Features

• Ready to use slider component with animations
• Easy customization
• Horizontal or vertical navigation
• Swipe navigation on touch devices
• Infinite slider
• Autoplay
• Supports any element as children
• Clean DOM without dirty manipulations
• Support for CSS modules
• Works with SSR
• Works on IE11

Install

npm install react-animated-slider

Note: this component relies on getDerivedStateFromProps and requires react@16.4 or newer. For older react versions please install react-animated-slider version 1:

npm install react-animated-slider@^1

Most Simple Use

import Slider from 'react-animated-slider';
import 'react-animated-slider/build/horizontal.css';

const slides = [
  { title: 'First item', description: 'Lorem ipsum'}
  { title: 'Second item', description: 'Lorem ipsum'}
];

<Slider>
  {slides.map((slide, index) => <div key={index}>
    <h2>{slide.title}</h2>
    <div>{slide.description}</div>
  </div>)}
</Slider>

Properties

| property | type | default | description | |-|-|-|-|-| | slideIndex | number | 0 | Index of the slide that will be initially displayed. | | duration | number | 2000(ms) | Duration of the animation in milliseconds. It is used to remove the animateIn and animateOut classNames and assign current after the transition has completed. | | disabled | boolean | false | Disable slider navigation | | infinite | boolean | true | Enable or disable infinite loop through slides. Sliders with only 2 children will have this option set to false | | autoplay | number | undefined | Autoplay interval in miliseconds. If undefined the slider will not play automatically. The timer will be paused and reset during user interactions such as mouse over or touch, to avoid sliding away the elements when the user wants to click them. | | touchDisabled | boolean | false | Disable slider navigation through touch events | | minSwipeOffset | number | 15(px) | Minimum distance in pixels to swipe for triggering a navigation event | | previousButton | ReactElement | arrow svg | Will be rendered inside the previous button | | nextButton | ReactElement | arrow svg | Will be rendered inside the next button | | classNames | object | see below | Object representing the CSS classNames that will be apllied to the slides. |

{
  slider: 'slider',
  previousButton: 'previousButton',
  nextButton: 'nextButton',
  buttonDisabled: 'disabled',
  track: 'track',
  slide: 'slide',
  hidden: 'hidden',
  previous: 'previous',
  current: 'current',
  next: 'next',
  animateIn: 'animateIn',
  animateOut: 'animateOut',
}

Classnames

Events