react-native-swiper README

The project's README from github.com/leecade/react-native-swiper. As one markdown file: README.md.

react-native-swiper

The best Swiper component for React Native.

JavaScript Style Guide npm version npm version PR Stats Issue Stats Join the chat

react-native-swiper

Roadmap

see: ROADMAP.md

Changelogs

see more: CHANGELOG.md

Show Cases

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

examples/components/Basic

examples/components/Swiper

examples/components/SwiperNumber

examples/components/Phone

examples/components/LoadMinimal

Getting Started

Installation

v1.5.14

$ npm i react-native-swiper --save

v1.6.0-rc

npm i --save react-native-swiper@next

Basic Usage

$ npm i react-native-cli -g

$ react-native init myproject

import React, { Component } from 'react'
import { AppRegistry, StyleSheet, Text, View } from 'react-native'

import Swiper from 'react-native-swiper'

const 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'
  }
})

export default class SwiperComponent extends Component {
  render() {
    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('myproject', () => SwiperComponent)

Properties

Basic

Prop Default Type Description
horizontal true bool If true, the scroll view's children are arranged horizontally in a row instead of vertically in a column.
loop true bool Set to false to disable continuous loop mode.
index 0 number Index number of initial slide.
showsButtons false bool Set to true make control buttons visible.
autoplay false bool Set to true enable auto play mode.
onIndexChanged (index) => null func Called with the new index when the user swiped

Custom basic style & content

Prop Default Type Description
width - number If no specify default enable fullscreen mode by flex: 1.
height - number If no specify default fullscreen mode by flex: 1.
style {...} style See default style in source.
containerStyle {...} style See default container style in source.
loadMinimal false bool Only load current index slide , loadMinimalSize slides before and after.
loadMinimalSize 1 number see loadMinimal
loadMinimalLoader <ActivityIndicator /> element Custom loader to display when slides aren't loaded

Pagination

Prop Default Type Description
showsPagination true bool Set to true make pagination visible.
paginationStyle {...} style Custom styles will merge with the default styles.
renderPagination - function Complete 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,}} /> element Allow custom the dot element.
activeDot <View style={{backgroundColor: '#007aff', width: 8, height: 8, borderRadius: 4, marginLeft: 3, marginRight: 3, marginTop: 3, marginBottom: 3,}} /> element Allow custom the active-dot element.
dotStyle - object Allow custom the dot element.
dotColor - string Allow custom the dot element.
activeDotColor - string Allow custom the active-dot element.
activeDotStyle - object Allow custom the active-dot element.

Autoplay

Prop Default Type Description
autoplay true bool Set to true enable auto play mode.
autoplayTimeout 2.5 number Delay between auto play transitions (in second).
autoplayDirection true bool Cycle direction control.

Control buttons

Prop Default Type Description
showsButtons true bool Set 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'} style Custom styles.
nextButton <Text style={styles.buttonText}>›</Text> element Allow custom the next button.
prevButton <Text style={styles.buttonText}>‹</Text> element Allow custom the prev button.

Props of Children

Prop Default Type Description
style {...} style Custom styles will merge with the default styles.
title {...} element If this parameter is not specified, will not render the title.

Basic props of <ScrollView />

Prop Default Type Description
horizontal true bool If true, the scroll view's children are arranged horizontally in a row instead of vertically in a column.
pagingEnabled true bool If true, the scroll view stops on multiples of the scroll view's size when scrolling. This can be used for horizontal pagination.
showsHorizontalScrollIndicator false bool Set to true if you want to show horizontal scroll bar.
showsVerticalScrollIndicator false bool Set to true if you want to show vertical scroll bar.
bounces false bool If 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.
scrollsToTop false bool If true, the scroll view scrolls to top when the status bar is tapped.
removeClippedSubviews true bool If 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.
automaticallyAdjustContentInsets false bool Set to true if you need adjust content insets automation.
scrollEnabled true bool Enables/Disables swiping

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

Supported ScrollResponder

Prop Params Type Description
onScrollBeginDrag e / state / context function When animation begins after letting up
onMomentumScrollEnd e / state / context function Makes no sense why this occurs first during bounce
onTouchStartCapture e / state / context function Immediately after onMomentumScrollEnd
onTouchStart e / state / context function Same, but bubble phase
onTouchEnd e / state / context function You could hold the touch start for a long time
onResponderRelease e / state / context function When 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

Methods

scrollBy(index, animated)

Scroll by relative index.

Parameters:

Name Type default Description
index number undefined offset index
animated bool true offset index

Examples

$ cd examples
$ npm i
$ react-native run-ios

Quick start with examples.

Development

$ cd examples
$ yarn
$ yarn start
$ react-native run-ios

Then launch simulator to preview. Note that you just need to edit the source file src/index.js, the change will auto sync to examples.

After development, you should add test for your modification and make all tests passed to prevent other contributors break the feature in the future accidentally. We use detox + jest for e2e test now, you can read Detox for more detail.

Contribution

Questions

Feel free to contact me or create an issue

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

💖 Sponsors

react-native-swiper (leecade/react-native-swiper)

Searching Database…

10.5K ·GitHub
React-native-swiper
Что это такое?Компонент-карусель (swiper) для приложений на React Native: заверните в него любое количество экранов, и пользователь сможет листать их свайпами. Встроены зацикливание, автопрокрутка, точки-индикаторы страниц и кнопки «вперёд/назад».
Это готовое приложение или библиотека, которую я добавлю в свой проект?Это npm-библиотека, а не приложение: вы устанавливаете react-native-swiper в существующий проект на React Native и используете компонент там, где нужен слайдер.
Как добавить его в своё приложение на React Native?Создайте проект на React Native, установите react-native-swiper из npm (стабильную версию v1.5.14 или v1.6.0-rc), импортируйте Swiper и передайте свои слайды как дочерние элементы, например: ... . В репозитории есть готовые рабочие примеры, которые можно открыть в Xcode.
Он тянет за собой много зависимостей?Нет — единственная npm-зависимость это prop-types, а в релиз-кандидате 1.6.0 даже убрали ViewPagerAndroid в пользу встроенного в React Native компонента ScrollView, так что библиотека остаётся очень лёгкой.
Стабильная версия совместима с современным React Native?Текущая стабильная версия — v1.5.14; поддержка react-native 0.60.x, исправленные примеры и поправленные типы для TypeScript появились только в 1.6.0-rc, так что для актуального проекта на RN скорее всего подойдёт релиз-кандидат.
Он работает и на iOS, и на Android?Да — это JavaScript-компонент для React Native, поэтому работает на обеих платформах: в списке изменений упоминаются исправления для iOS и Android-компонент ViewPagerAndroid, который в 1.6.0-rc заменили на ScrollView.
Умеет ли он листать слайды сам и крутиться по кругу бесконечно?Да. Зацикливание включено по умолчанию, а автопрокрутка — это один проп: по умолчанию слайд меняется каждые 2,5 секунды, а с помощью autoplayTimeout и autoplayDirection можно настроить задержку и направление цикла.
Можно ли настроить точки-индикаторы страниц?Да — быстрые правки через dotColor, activeDotColor, dotStyle и activeDotStyle, полностью свои элементы dot/activeDot или полный контроль через renderPagination(index, total, context), например, чтобы вместо точек показывать номера слайдов.
Как переключать слайды из кода?Вызовите scrollBy(index, animated), чтобы сдвинуться на относительный индекс; в 1.6.0-rc добавлен и scrollTo. Также доступны колбэки ScrollResponder, такие как onScrollBeginDrag и onMomentumScrollEnd.
Он отрисовывает все слайды сразу?Не обязательно: при включённом loadMinimal монтируются только текущий слайд плюс loadMinimalSize слайдов до и после него (по умолчанию 1), а для остальных показывается свой элемент loadMinimalLoader — удобно для тяжёлых страниц.
What are similar projects?react-native-calendars, react-native-snap-carousel, react-native-elements, react-native-ui-kitten, morphlet, expo-backdrop, swiper, styled-components
Which topics is it in?carousel, scroll, react-native, mobile-development, component-library, javascript-library, mobile-app, ui-components, mobile, ui, ios, android
Creator
leecade
Size
8.8 MB
Stars
10.5K
Updated
CommitFeb 01Releasev1.6.0Jul 09
Age
11y
Commits · 90 Days