3.1.31 • Published 6 years ago

react-blake-carousel v3.1.31

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

React Responsive Carousel

Help wanted - please read: https://github.com/leandrowd/react-responsive-carousel/issues/160

npm version Build Status FOSSA Status

Powerful, lightweight and fully customizable carousel component for React apps.

Features

  • Responsive
  • Mobile friendly
  • Swipe to slide
  • Mouse emulating touch
  • Server side rendering
  • Keyboard navigation
  • Custom animation duration
  • Auto play
  • Custom auto play interval
  • Infinite loop
  • Horizontal or Vertical directions
  • Supports images, videos, text content or anything you want. Each direct child represents one slide!
  • Supports any flux library (use selectedItem prop to set from the app state, and onChange callback to get the new position)
  • Show/hide anything (thumbs, indicators, arrows, status)

Demo

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

Check it out these cool demos created using storybook. The source code for each example is available here

Customize it yourself:

Installing as a package

npm install react-responsive-carousel --save

Usage

import React, { Component } from 'react';
import ReactDOM from 'react-dom';
import { Carousel } from 'react-responsive-carousel';

class DemoCarousel extends Component {
    render() {
        return (
            <Carousel>
                <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

// Using webpack
// import styles from 'react-responsive-carousel/lib/styles/carousel.min.css';

// Using html tag:
// <link rel="stylesheet" href="<NODE_MODULES_FOLDER>/react-responsive-carousel/lib/styles/carousel.min.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
thumbWidthnumberundefinedoptionally specify pixel width (as an integer) of a thumbnail (including any padding) to avoid calculating values (helps with server-side renders or page cache issues)
infiniteLoopbooleanfalseinfinite loop sliding
selectedItemnumber0selects an item though props / defines the initial selected item
axisstringhorizontalchanges orientation - accepts horizontal and vertical
verticalSwipestringstandardchanges vertical swipe scroll direction - accepts standard and natural
onChangefunction-Fired when changing positions
onClickItemfunction-Fired when an item is clicked
onClickThumbfunction-Fired when a thumb it clicked
widthstring-Allows to set a fixed width
useKeyboardArrowsbooleanfalseAdds support to next and prev through keyboard arrows
autoPlaybooleanfalseAuto play
stopOnHoverbooleantrueStop auto play while mouse is over the carousel
intervalnumber5000Interval of auto play
transitionTimenumber350Duration of slide transitions (in miliseconds)
swipeScrollTolerancenumber5Allows scroll when the swipe movement occurs in a different direction than the carousel axis and within the tolerance - Increase for loose - Decrease for strict
dynamicHeightbooleanfalseAdjusts the carousel height if required. -- Do not work with vertical axis --
emulateTouchbooleanfalseAllows mouse to simulate swipe
statusFormatterfunc(current, total) => ${current} of ${total}Allows custom formatting of the status indicator
centerModebooleanfalseEnables centered view with partial prev/next slides. Only works with horizontal axis.
centerSlidePercentagenumber80optionally specify percentage width (as an integer) of the slides in centerMode

=======================

Contributing

Check the contributing guide

=======================

Raising issues

When raising an issue, please add as much details as possible. Screenshots, video recordings, or anything else that can make it easier to reproduce the bug you are reporting.

  • A new option is to create a code pen with the code that causes the bug. Fork this base pen and add your code there. Don't forget to save and add the link for the pen to the issue.

=======================

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 and tests will run on each change

The fastest dev environment is on node 6. If you have nvm installed, just run nvm use 6. Tests in travis will run on node 4 and 6

Running only tests

  • npm test

Running storybook

  • npm run storybook

=======================

Only after merged back to master

Publish to npm

  • npm run publish-to-npm

Pubish to gh-pages

  • npm run publish-to-gh-pages

=======================

Examples

webpack + es6 setup

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

Storybook

http://react-responsive-carousel.js.org/storybook/

Codepen

https://codepen.io/leandrowd/pen/xLvOPd

=======================

Quick reads:

License

FOSSA Status