fortwo / react-carouselize

Transform everything in a simple and customizable carousel

React-Carouselize

The simplest carousel component you can find in the React ecosystem.

Getting Started

1. Install the package with yarn add react-carouselize or npm install --save react-carouselize

2. Import the component

import Carouselize from 'react-carouselize';

3. Wrap whatever you want to be a carousel

<Carouselize>
  ....
</Carouselize>

Properties

Name	Type	Default value	Required	Description
duration	number	5000	no	Animation duration in milliseconds
animation	string	v-scroll	no	One of v-scroll (vertical scroll), h-scroll (horizontal scroll) or fade
navigation	string	left	no	Position of bullets, between top, right, bottom, left
enableNavigation	boolean	true	no	Enable/disable click on bullets
enableKeys	boolean	true	no	Enable/disable scrolling with left or right keys

Contibuting

Check the related file CONTRIBUTING