JSPM

  • Created
  • Published
  • Downloads 205977
  • Score
    100M100P100Q154924F
  • License MIT

A React component for swipeable views

Package Exports

  • react-swipeable-views

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-swipeable-views) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React swipeable views

A React component for swipeable views

npm version npm downloads Build Status

Check out the demos from a mobile device (real or emulated). It is tiny (<4kB) and quickly render the first slide then lasy-load the other.

Installation

npm install --save react-swipeable-views

Usage

alt tag

const React = require('react');
const SwipeableViews = require('react-swipeable-views');

const MyComponent = React.createClass({
    render() {
        return (
          <SwipeableViews>
            <div style={Object.assign({}, styles.slide, styles.slide1)}>
              slide n°1
            </div>
            <div style={Object.assign({}, styles.slide, styles.slide2)}>
              slide n°2
            </div>
            <div style={Object.assign({}, styles.slide, styles.slide3)}>
              slide n°3
            </div>
          </SwipeableViews>
        );
    },
});

const styles = {
  slide: {
    padding: 15,
    minHeight: 100,
    color: '#fff',
  },
  slide1: {
    background: '#FEA900',
  },
  slide2: {
    background: '#B3DC4A',
  },
  slide3: {
    background: '#6AC0FF',
  },
};

module.exports = MyComponent;

Props

  • disabled Boolean, default=false - If true, it will disable touch events. This is useful when you want to prohibit the user from changing slides.

  • index Integer, default=0 - This is the index of the slide to show. This is useful when you want to change the default slide shown. Or when you have tabs linked to each slide.

  • onChangeIndex Function(index) - This is callback prop. It's call by the component when the shown slide change after a swipe made by the user. This is useful when you have tabs linked to each slide.

  • resitance Boolean, default=false - If true, it will add bounds effect on the edges.

  • style Object, default={} - This is the inlined style that will be applied to each slide container.

  • threshold Integer, default=5 - This is the threshold used for detectinga quick swipe. If the computed speed is above this value, the index change.

License

MIT