Home

Awesome

react-native-swiper2

npm version

logo

react-native-swiper is now active again, so swiper2 will stop maintaining.

Changelogs

Show Cases

Try these cases by yourself very easy, Just open examples/swiper.xcodeproj with Xcode, then press Cmd + R; you may edit examples/index.ios.js for switch cases.

examples/basic.js

![](http://i.imgur.com/zrsazAG.gif =300x)

examples/swiper.js

![](http://i.imgur.com/hP3f3oO.gif =300x)

examples/swiper_number.js

![](http://i.imgur.com/0rqESVb.gif =300x)

examples/phone.js

![](http://i.imgur.com/c1BhjZm.gif =300x)

Getting Started

Installation

$ npm i react-native-swiper2 --save

Basic Usage

$ npm i react-native-cli -g

$ react-native init myproject

var Swiper = require('react-native-swiper2')
// es6
// import Swiper from 'react-native-swiper2'

var React = require('react-native');
var {
  AppRegistry,
  StyleSheet,
  Text,
  View,
} = React;

var styles = StyleSheet.create({
  wrapper: {
  },
  slide1: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#9DD6EB',
  },
  slide2: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#97CAE5',
  },
  slide3: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#92BBD9',
  },
  text: {
    color: '#fff',
    fontSize: 30,
    fontWeight: 'bold',
  }
})

var swiper = React.createClass({
  render: function() {
    return (
      <Swiper style={styles.wrapper} showsButtons={true}>
        <View style={styles.slide1}>
          <Text style={styles.text}>Hello Swiper</Text>
        </View>
        <View style={styles.slide2}>
          <Text style={styles.text}>Beautiful</Text>
        </View>
        <View style={styles.slide3}>
          <Text style={styles.text}>And simple</Text>
        </View>
      </Swiper>
    )
  }
})

AppRegistry.registerComponent('swiper', () => swiper)

Properties

Basic

PropDefaultTypeDescription
horizontaltrueboolIf true, the scroll view's children are arranged horizontally in a row instead of vertically in a column.
looptrueboolSet to true to enable continuous loop mode.
index0numberIndex number of initial slide.
showsButtonsfalseboolSet to true make control buttons visible.
autoplayfalseboolSet to true enable auto play mode.

Custom basic style & content

PropDefaultTypeDescription
width-numberIf no specify default enable fullscreen mode by flex: 1.
height-numberIf no specify default fullscreen mode by flex: 1.
style{...}styleSee default style in source.

Pagination

PropDefaultTypeDescription
showsPaginationtrueboolSet to true make pagination visible.
paginationStyle{...}styleCustom styles will merge with the default styles.
renderPagination-functionComplete control how to render pagination with three params (index, total, context) ref to this.state.index / this.state.total / this, For example: show numbers instead of dots.
dot<View style={{backgroundColor:'rgba(0,0,0,.2)', width: 8, height: 8,borderRadius: 4, marginLeft: 3, marginRight: 3, marginTop: 3, marginBottom: 3,}} />elementAllow custom the dot element.
activeDot<View style={{backgroundColor: '#007aff', width: 8, height: 8, borderRadius: 4, marginLeft: 3, marginRight: 3, marginTop: 3, marginBottom: 3,}} />elementAllow custom the active-dot element.

Autoplay

PropDefaultTypeDescription
autoplaytrueboolSet to true enable auto play mode.
autoplayTimeout2.5numberDelay between auto play transitions (in second).
autoplayDirectiontrueboolCycle direction control.

Control buttons

PropDefaultTypeDescription
showsButtonstrueboolSet to true make control buttons visible.
buttonWrapperStyle{backgroundColor: 'transparent', flexDirection: 'row', position: 'absolute', top: 0, left: 0, flex: 1, paddingHorizontal: 10, paddingVertical: 10, justifyContent: 'space-between', alignItems: 'center'}styleCustom styles.
nextButton<Text style={styles.buttonText}>›</Text>elementAllow custom the next button.
prevButton<Text style={styles.buttonText}>‹</Text>elementAllow custom the prev button.

Props of Children

PropDefaultTypeDescription
style{...}styleCustom styles will merge with the default styles.
title{<Text numberOfLines={1}>...</Text>}elementIf this parameter is not specified, will not render the title.

Basic props of <ScrollView />

PropDefaultTypeDescription
horizontaltrueboolIf true, the scroll view's children are arranged horizontally in a row instead of vertically in a column.
pagingEnabledtrueboolIf true, the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination.
showsHorizontalScrollIndicatorfalseboolSet to true if you want to show horizontal scroll bar.
showsVerticalScrollIndicatorfalseboolSet to true if you want to show vertical scroll bar.
bouncesfalseboolIf true, the scroll view bounces when it reaches the end of the content if the content is larger then the scroll view along the axis of the scroll direction. If false, it disables all bouncing even if the alwaysBounce* props are true.
scrollsToTopfalseboolIf true, the scroll view scrolls to top when the status bar is tapped.
removeClippedSubviewstrueboolIf true, offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This canimprove scrolling performance on long lists.
automaticallyAdjustContentInsetsfalseboolSet to true if you need adjust content insets automation.

@see: http://facebook.github.io/react-native/docs/scrollview.html

Supported ScrollResponder

PropParamsTypeDescription
onMomentumScrollBegine / state / contextfunctionWhen animation begins after letting up
onMomentumScrollEnde / state / contextfunctionMakes no sense why this occurs first during bounce
onTouchStartCapturee / state / contextfunctionImmediately after onMomentumScrollEnd
onTouchStarte / state / contextfunctionSame, but bubble phase
onTouchEnde / state / contextfunctionYou could hold the touch start for a long time
onResponderReleasee / state / contextfunctionWhen lifting up - you could pause forever before * lifting

Note: each ScrollResponder be injected with two params: state and context, you can get state and context(ref to swiper's this) from params, for example:

var swiper = React.createClass({
  _onMomentumScrollEnd: function (e, state, context) {
    console.log(state, context.state)
  },
  render: function() {
    return (
      <Swiper style={styles.wrapper}
      onMomentumScrollEnd ={this._onMomentumScrollEnd}
     ...
      </Swiper>
    )
  }
})

More ScrollResponder info, see: https://github.com/facebook/react-native/blob/master/Libraries/Components/ScrollResponder.js

Examples

@TODO, see code in examples first.

Development

$ npm start

Contribution

Questions

Feel free to create an issue

Inspired by nolimits4web/Swiper & Design material from Dribbble & made with ♥.