react-native-lazy-swiper

A swiper for React Native (0.26+) with lazy-loaded contents. This component is currently support for iOS. It still runs on Android but without swipe feature.

Usage no npm install needed!

<script type="module">
  import reactNativeLazySwiper from 'https://cdn.skypack.dev/react-native-lazy-swiper';
</script>

README

React Native Lazy Swiper

A swiper for React Native (0.26+) with lazy-loaded contents. This component is currently support for iOS. It still runs on Android but without swipe feature.

Installation

npm install react-native-lazy-swiper --save

Usage

  • Define onSwipeEnd props: in this function, set nextIndex of component's state to currentIndex prop then pass the rerender callback function to setState method as second argument.
  • Define renderItem props: use this function to render each content for the swiper
  • [Optional] Define width for child views. Default width is screen width.
  • To swipe next manually: lazySwiper.swipeNext()
  • To swipe back manually: lazySwiper.swipeBack()
  • To go to specific item (no animation supported): set currentIndex of component's state to specific index.

Example:

[...]
import LazySwiper from 'react-native-lazy-swiper'

class App extends React.Component{
    constructor(props){
        super(props)
        this.state = {
            currentIndex: 0,
            data: []
        }
    }
    componentDidMount(){
        //Fetch data array
        fetch(...).done((result) => {
            this.setState({data: result})
        })
    }
    onSwipeEnd(nextIndex, rerender){
        this.setState({
            currentIndex: nextIndex
        }, rerender)
    }
    /**
     *  Bind this to previous button to manually swipe to the previous content.
     *  This should work on Android but without animation
     */
    prev(){
        this._lazySwiper.swipeBack()
    }
    /**
     *  Manually go to a specific content by reset new currentIndex to component's state
     */
    goTo(index){
        this.setState({
            currentIndex: index
        })
    }
    /**
     *  Bind this to next button to manually swipe to the next content.
     *  This should work on Android but without animation
     */
    next(){
        this._lazySwiper.swipeNext()
    }
    /**
     *  Render each content of the Swiper for each item in data array.
     */
    renderItem(item, index){
        return <View>
            <Text>No {index}: {item.name}</Text>
        </View>
    }
    render(){
        const {currentIndex, data} = this.state
        return <LazySwiper 
            ref={ (lazySwiper) => {this._lazySwiper = lazySwiper} }
            currentIndex={currentIndex}
            data={data}
            renderItem={(item, index) => this.renderItem(item, index)}
            onSwipeEnd={(nextIndex, rerender) => this.onSwipeEnd(nextIndex, rerender)}
        />
    }
}

Props

  • currentIndex: (number, isRequired) to set specific displayed content of the swiper.
  • data: (array, isRequired) list of items to show swiper contents.
  • renderItem: (function(item, index), isRequired) to render each swiper content. Parameters:
    • item: item of data array
    • index: index of the item in data array
  • onSwipeEnd: (function(nextIndex, rerender), isRequired) to set to new currentIndex and rerender the swiper. Define this will help the swiper render new content and swipe out unnessessary content. Parameters:
    • nextIndex: (number) set this to currentIndex of the state of the component which render the swiper.
    • rerender: (function()) pass this to setState method from above as second argument (sorry for this mysterious callback function but I found no other way).

LICENSE

MIT