react-carouselize
v1.0.9
Published
react-carouselize React component
Downloads
5
Maintainers
Readme
React-Carouselize
The simplest carousel component you can find in the React ecosystem.
Getting Started
Install the package with
yarn add react-carouselize
ornpm install --save react-carouselize
Import the component
import Carouselize from 'react-carouselize';
- 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