README.md

react-native-snap-carousel

---

---

✨ Some great news for you, fellow plugin user!

💡 Head over there now to learn more about all the goodness that's coming your way.

---

---

Table of contents

1. Showcase
2. Usage
3. Example
4. Props, methods and getters
5. Layouts and custom interpolations
6. ParallaxImage component
7. Pagination component
8. Tips and tricks
9. Known issues
10. Important note regarding Android
11. Important note regarding iOS
12. Roadmap
13. Credits

Showcase

🙌 New feature: layouts

Do you want to find out more?

Real-world examples

These are live apps we've created that make heavy use of the plugin. Don't be shy, share yours if you've done something awesome with it!

---

🤝 Maintainers wanted

Hey there,

Creating and maintaining this plugin has been a fun ride that started in 2016. We thank you all for your appreciation and for making the most out of it! You've motivated us to spend countless hours improving the plugin, and made us happy to give back to the Open Source community.

Put simply, we love this project. However we currently aren't able to give it the love it deserves and the care it requires. If you have enough time and knowledge, and want to become a maintainer, please let us know.

💡 Just head there if you're interested.

We're not abandoning the ship, but we need more people to help us keep it alive and well!

---

Usage

$ npm install --save react-native-snap-carousel

If you're using Typescript you should also install type definitions:

$ npm install --save @types/react-native-snap-carousel

import Carousel from 'react-native-snap-carousel';

export class MyCarousel extends Component {

    _renderItem = ({item, index}) => {
        return (
            <View style={styles.slide}>
                <Text style={styles.title}>{ item.title }</Text>
            </View>
        );
    }

    render () {
        return (
            <Carousel
              ref={(c) => { this._carousel = c; }}
              data={this.state.entries}
              renderItem={this._renderItem}
              sliderWidth={sliderWidth}
              itemWidth={itemWidth}
            />
        );
    }
}

Example

Here are simple examples that can be edited in real time in your browser:

• https://snack.expo.io/@vitkor/carousel-simple-example
• https://snack.expo.io/@bd-arc/react-native-snap-carousel-%7C-example-with-custom-interpolations

You can also find a more in-depth (read "complex") one in the /example folder.

Props, methods and getters

In order to let you to create mighty carousels and to keep up with your requests, we add new features on a regular basis. Consequently, the list of available props has become really huge and deserves a documentation of its own.

📚 Documentation for "Props, methods and getters"

Layouts and custom interpolations

Built-in layouts

In version 3.6.0, we've added two new layouts on top of the original one: the first one is called 'stack' since it mimics a stack of cards, and the other one is called 'tinder' since it provides a Tinder-like animation.

You can choose between the three of them using the new prop layout and you can modify the default card offset in the 'stack' and 'tinder' layouts with prop layoutCardOffset.

<Carousel layout={'default'} />

<Carousel layout={'stack'} layoutCardOffset={`18`} />

<Carousel layout={'tinder'} layoutCardOffset={`9`} />

A few things worth noting:

• As you can see, the effect had to be inverted on Android. This has to do with a really annoying Android-specific bug.
• Even though the new layouts have been created with horizontal carousels in mind, they will also work with vertical ones \o/
• ⚠️ You should NOT use stack or tinder layouts if you have a large data set to display. In order to avoid rendering issues, the carousel will use a ScrollView component rather than a FlatList one for those layouts (see prop useScrollView). The tradeof is that you won't benefit from any of FlatList's advanced optimizations. See this issue for workarounds; or you may want to implement your own custom interpolation.

Custom interpolations

On top of the new layouts, we've exposed the logic we used so that users can create their own awesome layouts! If you're interested, take a deep breath and dive into the dedicated documentation.

📚 Documentation for "Custom interpolations"

Here are a few examples of what can easily be achieved (you can explore the source code and try it live in the provided example):

ParallaxImage component

Version 3.0.0 introduced a <ParallaxImage /> component, an image component aware of carousel's current scroll position and therefore able to display a nice parallax effect (powered by the native driver to ensure top-notch performance).

📚 Documentation for "ParallaxImage component"

Pagination component

Starting with version 2.4.0, a customizable <Pagination /> component has been added. You can see below how it looks like with its default configuration.

📚 Documentation for "Pagination component"

Tips and tricks

We've gathered together all the useful tips and tricks. There is a bunch of them, which makes this section a must-read!

📚 Documentation for "Tips and tricks"

Known issues

Make sure to read about the known issues before opening a new one; you may find something useful.

📚 Documentation for "Known issues"

Important note regarding Android

Android's debug mode is a mess: timeouts regularly desynchronize and scroll events are fired with some lag, which completely alters the inner logic of the carousel. On Android, you will experience issues with carousel's behavior when JS Dev Mode is enabled, and you might have trouble with unreliable callbacks and loop mode when it isn't. This is unfortunate, but it's rooted in various flaws of ScrollView/FlatList's implementation and the miscellaneous workarounds we had to implement to compensate for it.

⚠️ Therefore you should always check if the issue you experience also happens in a production environment. This is, sadly, the only way to test the real performance and behavior of the carousel.

For more information, you can read the following notes: "Android performance" and "Unreliable callbacks".

Important note regarding iOS

⚠️ When debugging with the iOS simulator, you're only one "Cmd + T" away from toggling "Slow Animations". If carousel's animations seem painfully slow, make sure that you haven't enabled this setting by mistake.

Roadmap

• Add more examples
• Base the plugin on a component less buggy than FlatList
• Implement different layouts and allow using custom interpolations
• Implement both FlatList and ScrollView handling
• Add the ability to provide custom items animation
• Implement 'loop' mode
• Improve Android's behavior
• Add parallax image component
• Base the plugin on FlatList instead of ScrollView
• Add alignment option
• Add pagination component
• Add vertical implementation
• Handle device orientation event (see this note)
• Add RTL support
• Improve momemtum handling
• Improve snap on Android
• Handle passing 1 item only
• Fix centering

Credits

Written by Benoît Delmaire (bd-arc) and Maxime Bertonnier (Exilz) at Meliorence.