react-carousel

A pure extendable React carousel, powered by Brainhub (craftsmen who ❤️ JS)

Live code demo |
v1 migration guide |
Hire us

![CircleCI](https://circleci.com/gh/brainhubeu/react-carousel)
![Last commit](https://github.com/brainhubeu/react-carousel/commits/master)
![license](https://github.com/brainhubeu/react-carousel/blob/master/LICENSE.md)
![PRs Welcome](http://makeapullrequest.com)
![Renovate enabled](https://renovatebot.com/)

![Coveralls github](https://coveralls.io/github/brainhubeu/react-carousel?branch=master)
![Downloads](https://www.npmjs.com/package/@brainhubeu/react-carousel)
![Activity](https://github.com/brainhubeu/react-carousel/commits/master)
![Minified](https://www.npmjs.com/package/@brainhubeu/react-carousel)
![npm](https://www.npmjs.com/package/@brainhubeu/react-carousel)
![Contributors](https://github.com/brainhubeu/react-carousel/graphs/contributors)

- 🔌 Installation
- 🐥 Usage
- 🔨 Props
- 🎠 Carousel Props
- 🐾 Dots Props
- 😻 Contributing
- 💁 Setting up local development
- 🐞 Tests
- 🏋️‍ Workflow
- 🏷 Labels
- 📝 Decision Log

Why?

There are some great carousels (like slick) that do not have real React implementations. This library provides you with carousel that is not merely a wrapper for some jQuery solution, can be used as controlled or uncontrolled element (similar to inputs), and has tons of useful features.

Installation

$3


npm i @brainhubeu/react-carousel

$3


npm i @types/brainhubeu__react-carousel -D


$3

If you don't use any bundler like Webpack, you can add these scripts to your HTML file,

body

 section:

html


Make sure to use a version ending with

-cdn.

Then, you can use the following global variables: -BrainhubeuReactCarousel-BrainhubeuReactCarouselDots-BrainhubeuReactCarouselItem-BrainhubeuReactCarouselWrapper

`$3`


When using

@brainhubeu/react-carousel with SSR (Server-side Rendering), we recommend Next.js as @brainhubeu/react-carousel

 currently doesn't work on the server side so it must be rendered on the client side (maybe we'll provide server-side working in the future).

js
import dynamic from 'next/dynamic';

const { default: Carousel, Dots } = dynamic( () => require('@brainhubeu/react-carousel'), { ssr: false }, );`

`Usage`


By default, the component does not need anything except children to render a simple carousel.
Remember that styles do not have to be imported every time you use carousel, you can do it once in an entry point of your bundle.

javascript
import React from 'react';
import Carousel from '@brainhubeu/react-carousel';
import '@brainhubeu/react-carousel/lib/style.css';
const MyCarousel = () => (
  
    
    
    
  
);

export default MyCarousel;`

![gif](https://brainhubeu.github.io/react-carousel/docs/examples/simpleUsage)

`$3`


There is a separate Dots component that can be used to fully control navigation dots or add thumbnails.

javascript
import Carousel, { Dots } from '@brainhubeu/react-carousel';
import '@brainhubeu/react-carousel/lib/style.css'; import { useState } from 'react';
const MyCarouselWithDots = () => {
  const [value, setValue] = useState(0);
  const onChange = value => {
  setValue(value);
  }
  return (
    

              value={value}
        onChange={onChange}
      >
        
        ...
        
      
              value={this.state.value}
        onChange={this.onChange}
        thumbnails={[
          (),
          ...
          (),
        ]}
      />
    

  );
};

export default MyCarouselWithDots;`

![gif](https://brainhubeu.github.io/react-carousel/docs/examples/thumbnails)

`Props`


You can access a clickable demo with many examples and a live code editor by clicking on a Prop name.
$3

| Prop | Type | Default | Description | | --- | --- | --- | --- | | value | Number |undefined| Current slide's index (zero based, depends on the elements order) | | onChange | Function |undefined| Handler triggered when current slide is about to change (e.g. on arrow click or on swipe) | | slides | Array |undefined| Alternative way to pass slides. This prop expects an array of JSX elements | | itemWidth | Number |undefined| Determines custom width for every slide in the carousel | | offset | Number |0| Padding between items | | animationSpeed | Number |500| Determines transition duration in milliseconds | | draggable | Boolean |true| Makes it possible to drag to the next slide with mouse cursor | | breakpoints | Object |undefined | All props can be set to different values on different screen resolutions |

`$3`


You can extend react-carousel default behavior by applying plugins shipped within carousel or by creating and applying your own ones
Plugins documentation
$3

| Prop | Type | Default | Description | | --- | --- | --- | --- | | value | Number | slide position in the slides Array | CurrentCarouselvalue | | onChange | Function |undefined | onChange callback (works the same way as onChange in Carouselcomponent) | | number | Number | Amount of slides | Number of slides in the carousel you want to control | | thumbnails | Array of ReactElements |undefined| Array of thumbnails to show. If not provided, default dots will be shown | | rtl | Boolean |false | Indicating if the dots should have direction from Right to Left |

`$3`

git clone https://github.com/brainhubeu/react-carousel

cd react-carousel

yarn

yarn start-demo


- open http://localhost:8000/
$3

Each test command should be run from the root directory.

#### Unit tests`yarn test:unit:coverage`

#### E2E tests`yarn test:e2e``

License

About

react-carousel is maintained by the Brainhub development team. It is funded by Brainhub and the names and logos for Brainhub are trademarks of Brainhub Sp. z o.o.. You can check other open-source projects supported/developed by our teammates here.

![Brainhub](https://brainhub.eu/?utm_source=github)

We love open-source JavaScript software! See our other projects or hire us to build your next web, desktop and mobile application with JavaScript.

react-carousel

A pure extendable React carousel, powered by Brainhub (craftsmen who ❤️ JS)

Live code demo |
v1 migration guide |
Hire us

Why?

Installation

$3


npm i @brainhubeu/react-carousel

$3


npm i @types/brainhubeu__react-carousel -D


$3

If you don't use any bundler like Webpack, you can add these scripts to your HTML file,

body

 section:

html


Make sure to use a version ending with

-cdn.

Then, you can use the following global variables: -BrainhubeuReactCarousel-BrainhubeuReactCarouselDots-BrainhubeuReactCarouselItem-BrainhubeuReactCarouselWrapper

`$3`


When using

@brainhubeu/react-carousel with SSR (Server-side Rendering), we recommend Next.js as @brainhubeu/react-carousel

 currently doesn't work on the server side so it must be rendered on the client side (maybe we'll provide server-side working in the future).

js
import dynamic from 'next/dynamic';

const { default: Carousel, Dots } = dynamic( () => require('@brainhubeu/react-carousel'), { ssr: false }, );`

`Usage`


By default, the component does not need anything except children to render a simple carousel.
Remember that styles do not have to be imported every time you use carousel, you can do it once in an entry point of your bundle.

javascript
import React from 'react';
import Carousel from '@brainhubeu/react-carousel';
import '@brainhubeu/react-carousel/lib/style.css';
const MyCarousel = () => (
  
    
    
    
  
);

export default MyCarousel;`

![gif](https://brainhubeu.github.io/react-carousel/docs/examples/simpleUsage)

`$3`


There is a separate Dots component that can be used to fully control navigation dots or add thumbnails.

javascript
import Carousel, { Dots } from '@brainhubeu/react-carousel';
import '@brainhubeu/react-carousel/lib/style.css'; import { useState } from 'react';
const MyCarouselWithDots = () => {
  const [value, setValue] = useState(0);
  const onChange = value => {
  setValue(value);
  }
  return (
    

              value={value}
        onChange={onChange}
      >
        
        ...
        
      
              value={this.state.value}
        onChange={this.onChange}
        thumbnails={[
          (),
          ...
          (),
        ]}
      />
    

  );
};

export default MyCarouselWithDots;`

![gif](https://brainhubeu.github.io/react-carousel/docs/examples/thumbnails)

`Props`


You can access a clickable demo with many examples and a live code editor by clicking on a Prop name.
$3

`$3`


You can extend react-carousel default behavior by applying plugins shipped within carousel or by creating and applying your own ones
Plugins documentation
$3

`$3`

git clone https://github.com/brainhubeu/react-carousel

cd react-carousel

yarn

yarn start-demo


- open http://localhost:8000/
$3

Each test command should be run from the root directory.

#### Unit tests`yarn test:unit:coverage`

#### E2E tests`yarn test:e2e``

$3

See the Workflow subsection in our docs

$3

See the Labels subsection in our docs

$3

See the Decision log subsection in our docs

License

About

![Brainhub](https://brainhub.eu/?utm_source=github)

We love open-source JavaScript software! See our other projects or hire us to build your next web, desktop and mobile application with JavaScript.

@brainhubeu/react-carousel

react-carousel

Table of Contents

Why?

Installation

$3

$3

$3

$3

Usage

$3

Props

$3

$3

$3

$3

$3

$3

$3

$3

License

About

@brainhubeu/react-carousel

react-carousel

Table of Contents

Why?

Installation

$3

$3

$3

$3

Usage

$3

Props

$3

$3

$3

$3

$3

$3

$3

$3

License

About

Dist Tags

`$3`

`Usage`

`$3`

`Props`

`$3`

`$3`

`$3`

`Usage`

`$3`

`Props`

`$3`

`$3`