React Alice Carousel


React Alice Carousel is a React component for building content galleries, content rotators and any React carousels.

!demo gif

!demo gif

Features of react-alice-carousel

- Infinite loop
- FadeOut animation
- AutoPlay mode
- Mobile friendly
- Responsive design
- Stage padding
- Swipe to slide
- Start index
- Slide to index
- RTL
- Auto Height
- Keyboard navigation
- Touch and Drag support
- Custom rendered slides
- Custom animation duration
- Multiple items in the slide
- Show / hide anything (indicators, arrows, slides indexes)
- TypeScript type definitions

How to use

``apacheconfig
npm install react-alice-carousel
`

$3

`

SCSS

@import "react-alice-carousel/lib/scss/alice-carousel.scss";
`

`

CSS

@import "react-alice-carousel/lib/alice-carousel.css";
`

`

Webpack

import "react-alice-carousel/lib/alice-carousel.css";
`

#### Quick start

`javascript
import React from 'react'
import AliceCarousel from 'react-alice-carousel'
import 'react-alice-carousel/lib/alice-carousel.css'

const Gallery = () => {
const handleOnDragStart = (e) => e.preventDefault()
return (







)
}
`

$3

#### Props

- items : Array, default [] - gallery items, preferable to use this property instead of children

- duration : Number, default 250 - Duration of slides transition (milliseconds)

- responsive : Object, default {} - Number of items in the slide. The key is the breakpoint (default is the result of: () => window.innerWidth) for the resize event

`js
{
0: {
items: 1,
},
1024: {
items: 3
}
}
`

- stagePadding : Object, default {} - Padding left and right on the stage

`js
{
paddingLeft: 0, // in pixels
paddingRight: 0
}
`

- buttonsDisabled : Boolean, false - Disable buttons control

- dotsDisabled : Boolean, false - Disable dots navigation

- startIndex : Number, 0 - The starting index of the carousel

- slideToIndex : Number, 0 - Sets the carousel at the specified position

- swipeDisabled : Boolean, default false - Disable swipe handlers

- touchTrackingEnabled : Boolean, default true - Enable touch move animation

- mouseTrackingEnabled : Boolean, default false - Enable mouse drag animation

- mouseDragEnabled : Deprecated from version 1.16.0 (use "mouseTrackingEnabled" instead) Boolean, default false - Enable mouse drag animation

_To Avoid unexpected behavior you should handle drag event independently, something like in an example_

- infinite : Boolean, default true - Disable infinite mode

- fadeOutAnimation : Boolean, default false - Enable fadeout animation. Fired when 1 item is in the slide

- controlsStrategy : String (default | responsive), default default - If responsive is specified, dots navigation will be hidden if the number of gallery items is equal to the number of items on the slide

- keysControlDisabled : Boolean, default false - Disable keys controls (left, right, space)

- playButtonEnabled : Boolean, default false - Disable play/pause button

- autoPlay : Boolean, default false - Set auto play mode

- autoHeight : Boolean, default false - Set auto height mode

- autoPlayInterval : Number, default 250 - Interval of auto play animation (milliseconds). If specified, a larger value will be taken from comparing this property and the duration one

- autoPlayDirection : String, default ltr - To run auto play in the left direction specify rtl value

- disableAutoPlayOnAction : Boolean, default false - If this property is identified as true auto play animation will be stopped after clicking user on any gallery button

- stopAutoPlayOnHover : Boolean, default true - If this property is identified as false auto play animation won't stopped on hover

- showSlideInfo : Boolean, default false - Show slide info

- preventEventOnTouchMove : Boolean, default false - Prevent the browser's touchmove event when carousel is swiping

- onSlideChange : Function - Fired when the event object is changing / returns event object

- onSlideChanged : Function - Fired when the event object was changed / returns event object

- onInitialized : Function - Fired when the gallery was initialized / returns event object

- onResized : Function - Fired when the gallery was resized / returns event object

_Event object example_

`js
{
item: index, // index of the current items position
slide: index, // index of the current slides position
itemsInSlide: number, // number of elements in the slide
isPrevSlideDisabled, // indicator to control the visibility of navigation dots
isNextSlideDisabled,
}
`

- shouldHandleResizeEvent : Function - Fired during resize event to determine whether the event handler should be called / returns boolean

#### Methods

- slideTo(index: number) : Go to the specified slide

- slidePrev() : Go to the prev slide

- slideNext() : Go to the next slide

$3

`javascript
import React from 'react'
import AliceCarousel from 'react-alice-carousel'
import 'react-alice-carousel/lib/alice-carousel.css'

class Gallery extends React.Component {
state = {
galleryItems: [1, 2, 3].map((i) =>

{i}

),
}

responsive = {
0: { items: 1 },
1024: { items: 2 },
}

onSlideChange(e) {
console.debug('Items position during a change: ', e.item)
console.debug('Slides position during a change: ', e.slide)
}

onSlideChanged(e) {
console.debug('Items position after changes: ', e.item)
console.debug('Slides position after changes: ', e.slide)
}

render() {
return (
items={this.state.galleryItems}
responsive={this.responsive}
autoPlayInterval={2000}
autoPlayDirection="rtl"
autoPlay={true}
fadeOutAnimation={true}
mouseTrackingEnabled={true}
playButtonEnabled={true}
disableAutoPlayOnAction={true}
onSlideChange={this.onSlideChange}
onSlideChanged={this.onSlideChanged}
/>
)
}
}
`

#### Custom Prev / Next buttons, dots / thumbs navigation:

- Using - _refs_.

`javascript
import React from 'react'
import AliceCarousel from 'react-alice-carousel'
import 'react-alice-carousel/lib/alice-carousel.css'

class Gallery extends React.Component {
items = [1, 2, 3, 4, 5]

state = {
galleryItems: this.items.map((i) =>

{i}

),
}

thumbItem = (item, i) => (
this.Carousel.slideTo(i)}>
*{' '}

)

render() {
return (

dotsDisabled={true}
buttonsDisabled={true}
items={this.state.galleryItems}
ref={(el) => (this.Carousel = el)}
/>


this.Carousel.slidePrev()}>Prev button
this.Carousel.slideNext()}>Next button

)
}
}
`

- Using _props_

`javascript
import React from 'react'
import AliceCarousel from 'react-alice-carousel'
import 'react-alice-carousel/lib/alice-carousel.css'

class Gallery extends React.Component {
items = [1, 2, 3, 4, 5]

state = {
currentIndex: 0,
responsive: { 1024: { items: 3 } },
galleryItems: this.galleryItems(),
}

slideTo = (i) => this.setState({ currentIndex: i })

onSlideChanged = (e) => this.setState({ currentIndex: e.item })

slideNext = () => this.setState({ currentIndex: this.state.currentIndex + 1 })

slidePrev = () => this.setState({ currentIndex: this.state.currentIndex - 1 })

thumbItem = (item, i) => this.slideTo(i)}>*

galleryItems() {
return this.items.map((i) =>

{i}

)
}

render() {
const { galleryItems, responsive, currentIndex } = this.state
return (

dotsDisabled={true}
buttonsDisabled={true}
items={galleryItems}
responsive={responsive}
slideToIndex={currentIndex}
onSlideChanged={this.onSlideChanged}
/>

{this.items.map(this.thumbItem)}

this.slidePrev()}>Prev button
this.slideNext()}>Next button

)
}
}
`

###### Example for _slidePrev/slideNext_ page

`javascript
import React from 'react'
import AliceCarousel from 'react-alice-carousel'
import 'react-alice-carousel/lib/alice-carousel.css'

class Gallery extends React.Component {
state = {
currentIndex: 0,
itemsInSlide: 1,
responsive: { 0: { items: 3 } },
galleryItems: this.galleryItems(),
}

galleryItems() {
return Array(7)
.fill()
.map((item, i) =>

{i + 1}

)
}

slidePrevPage = () => {
const currentIndex = this.state.currentIndex - this.state.itemsInSlide
this.setState({ currentIndex })
}

slideNextPage = () => {
const {
itemsInSlide,
galleryItems: { length },
} = this.state
let currentIndex = this.state.currentIndex + itemsInSlide
if (currentIndex > length) currentIndex = length

this.setState({ currentIndex })
}

handleOnSlideChange = (event) => {
const { itemsInSlide, item } = event
this.setState({ itemsInSlide, currentIndex: item })
}

render() {
const { currentIndex, galleryItems, responsive } = this.state

return (

items={galleryItems}
slideToIndex={currentIndex}
responsive={responsive}
onInitialized={this.handleOnSlideChange}
onSlideChanged={this.handleOnSlideChange}
onResized={this.handleOnSlideChange}
/>
Prev Page
Next Page

)
}
}
`

$3

#### Clone

`apacheconfig
git clone https://github.com/maxmarinich/react-alice-carousel
cd react-alice-carousel
`

#### Run

`apacheconfig
npm i
npm start
`

#### Test

`apacheconfig
npm test
``

#### License

MIT