Socket
Socket
Sign inDemoInstall

react-responsive-carousel

Package Overview
Dependencies
2
Maintainers
1
Versions
121
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-responsive-carousel


Version published
Maintainers
1
Created

Package description

What is react-responsive-carousel?

The react-responsive-carousel package is a flexible and responsive carousel component for React applications. It allows developers to create image sliders, carousels, and galleries with ease, providing a variety of customization options and features.

What are react-responsive-carousel's main functionalities?

Basic Carousel

This code demonstrates a basic carousel with three images. Each image has an associated legend. The carousel is responsive and will adjust to the size of its container.

import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';

function BasicCarousel() {
  return (
    <Carousel>
      <div>
        <img src="image1.jpg" alt="Image 1" />
        <p className="legend">Legend 1</p>
      </div>
      <div>
        <img src="image2.jpg" alt="Image 2" />
        <p className="legend">Legend 2</p>
      </div>
      <div>
        <img src="image3.jpg" alt="Image 3" />
        <p className="legend">Legend 3</p>
      </div>
    </Carousel>
  );
}

Custom Controls

This code demonstrates a carousel with custom controls. The carousel will autoplay, loop infinitely, and respond to keyboard arrows and touch gestures. It also includes indicators and arrows for navigation.

import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';

function CustomControlsCarousel() {
  return (
    <Carousel
      showArrows={true}
      showStatus={false}
      showIndicators={true}
      infiniteLoop={true}
      useKeyboardArrows={true}
      autoPlay={true}
      stopOnHover={true}
      swipeable={true}
      dynamicHeight={true}
      emulateTouch={true}
    >
      <div>
        <img src="image1.jpg" alt="Image 1" />
        <p className="legend">Legend 1</p>
      </div>
      <div>
        <img src="image2.jpg" alt="Image 2" />
        <p className="legend">Legend 2</p>
      </div>
      <div>
        <img src="image3.jpg" alt="Image 3" />
        <p className="legend">Legend 3</p>
      </div>
    </Carousel>
  );
}

Thumbnail Navigation

This code demonstrates a carousel with thumbnail navigation. Thumbnails of the images are displayed below the main carousel, allowing users to navigate to specific images by clicking on the thumbnails.

import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';

function ThumbnailCarousel() {
  return (
    <Carousel showThumbs={true}>
      <div>
        <img src="image1.jpg" alt="Image 1" />
        <p className="legend">Legend 1</p>
      </div>
      <div>
        <img src="image2.jpg" alt="Image 2" />
        <p className="legend">Legend 2</p>
      </div>
      <div>
        <img src="image3.jpg" alt="Image 3" />
        <p className="legend">Legend 3</p>
      </div>
    </Carousel>
  );
}

Other packages similar to react-responsive-carousel

Changelog

Source

v3.0.15 - 2016-09-07

Commits

  • Updating package task to include the fonts f10a739
  • Updating docs with example 6feaeb4
  • Removing release branch from publish step c10616d

Readme

Source

npm version Build Status

Demo

http://leandrowd.github.io/react-responsive-carousel/

Installing as a package

npm install react-responsive-carousel --save

Usage
var React = require('react');
var ReactDOM = require('react-dom');
var Carousel = require('react-responsive-carousel').Carousel;

var DemoCarousel = React.createClass({
    render() {
        return (
            <Carousel axis="horizontal|vertical" showThumbs={true|false} showArrows={true|false} onChange={onChange} onClickItem={onClickItem} onClickThumb={onClickThumb}>
                <div>
                    <img src="assets/1.jpeg" />
                    <p className="legend">Legend 1</p>
                </div>
                <div>
                    <img src="assets/2.jpeg" />
                    <p className="legend">Legend 2</p>
                </div>
                <div>
                    <img src="assets/3.jpeg" />
                    <p className="legend">Legend 3</p>
                </div>
            </Carousel>
        );
    }
});
ReactDOM.render(<DemoCarousel />, document.querySelector('.demo-carousel'));

// Don't forget to include the css in your page
// <link rel="stylesheet" href="carousel.css"/>
AttributesTypeDefaultDescription
showArrowsbooleantrueshow prev and next arrows
showStatusbooleantrueshow index of the current item. i.e: (1/8)
showIndicatorsbooleantrueshow little dots at the bottom with links for changing the item
showThumbsbooleantrueshow thumbnails of the images
selectedItemnumber0selects an item though props / defines the initial selected item
axisstringhorizontalchanges orientation - accepts horizontal and vertical
onChangefunction-Fired when changing positions
onClickItemfunction-Fired when an item is clicked
onClickThumbfunction-Fired when a thumb it clicked
Contributing

Please, feel free to contribute. You may file an issue or submit a pull request!

Setting up development environment
  • git clone git@github.com:leandrowd/react-responsive-carousel.git
  • npm install
  • npm start
  • Open your favourite browser on localhost:8000 - livereload will be enabled
Running tests
  • npm test
Publishing to npm
  • npm run publish-to-npm
Pubishing to gh-pages
  • npm run publish-to-gh-pages

Examples

webpack + es6 setup

https://github.com/leandrowd/demo-react-responsive-carousel-es6

Keywords

FAQs

Last updated on 07 Sep 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc