Scroll to the Top or Bottom of the ListView in React Native
Here is an example to Scroll to the Top or Bottom of the ListView in React Native on the Click of Button. We have often seen this type of things in websites where you scroll towards the button and suddenly a button pop up to take you at the top of the page. It provides a very good user experience. So here is the same example with the React Native FlatList.
In this example, We will make two buttons
1. To take you to the Top of the ListView by using :
1 | this.ListView_Ref.scrollTo({ x: 0, y: 0, animated: true }); |
2. To take you to the Bottom of the ListView by using :
1 | this.ListView_Ref.scrollToEnd({ animated: true }); |
We are using a simple React Native FlatList for this example. So let’s get started.
To Make a React Native App
Getting started with React Native will help you to know more about the way you can make a React Native project. We are going to use react-native init to make our React Native App.
Assuming that you have node installed, you can use npm to install the react-native-cli command line utility.
Open the terminal and go to the workspace and run
Run the following commands to create a new React Native projectnpm install -g react-native-cli
This will make a project structure with an index file named App.js in your project directory.react-native init ProjectName
Open App.js in any code editor and replace the code with the following code.
App.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | //This is an example code to Scroll Up or Down ListView on Button Click// import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Alert, FlatList, Text, TouchableOpacity, Image, } from 'react-native'; //import all the components we are going to use. export default class Mynewproject extends Component { constructor(props) { super(props); //Preparing the data for the ListView this.state = { dataSource: [ 'Chinkara', 'MotorsForce', 'MotorsIPMLHindustan', 'Mahindra', 'Reva', 'Electric', 'VehiclesMaruti', 'Suzuki', 'IndiaOpel', 'IndiaPremier', 'LtdSan', 'StormSML', 'IsuzuStandardTara', 'InternationalTata', 'Motor', 'Chinkara', 'MotorsForce', 'MotorsIPMLHindustan', 'Mahindra', 'Reva', 'Electric', 'VehiclesMaruti', 'Suzuki', 'IndiaOpel', 'IndiaPremier', 'LtdSan', 'StormSML', 'IsuzuStandardTara', 'InternationalTata', 'Motor', ] }; } ListViewItemSeparator = () => { return ( <View style={{ height: 0.5, width: '100%', backgroundColor: '#000', }} /> ); }; GetListViewItem(rowData) { Alert.alert(rowData); } upButtonHandler = () => { //OnCLick of Up button we scrolled the list to top this.ListView_Ref.scrollToOffset({ offset: 0, animated: true }); }; downButtonHandler = () => { //OnCLick of down button we scrolled the list to bottom this.ListView_Ref.scrollToEnd({ animated: true }); }; render() { return ( <View style={styles.MainContainer}> <FlatList data={this.state.dataSource} ItemSeparatorComponent={this.ListViewItemSeparator} ref={(ref) => { this.ListView_Ref = ref; }} renderItem={({ item }) => ( <Text style={styles.rowViewContainer} onPress={this.GetListViewItem.bind(this, item)}> {item} </Text> )} /> <TouchableOpacity activeOpacity={0.5} onPress={this.downButtonHandler} style={styles.downButton}> <Image source={{ uri: 'http://aboutreact.com/wp-content/uploads/2018/08/arrow_down.png', }} style={styles.downButtonImage} /> </TouchableOpacity> <TouchableOpacity activeOpacity={0.5} onPress={this.upButtonHandler} style={styles.upButton}> <Image source={{ uri: 'http://aboutreact.com/wp-content/uploads/2018/08/arrow_up.png', }} style={styles.upButtonImage} /> </TouchableOpacity> </View> ); } } const styles = StyleSheet.create({ MainContainer: { justifyContent: 'center', flex: 1, margin: 10, paddingTop: 40, }, rowViewContainer: { fontSize: 18, paddingRight: 10, paddingTop: 10, paddingBottom: 10, }, upButton: { position: 'absolute', width: 50, height: 50, alignItems: 'center', justifyContent: 'center', right: 30, bottom: 70, }, upButtonImage: { resizeMode: 'contain', width: 30, height: 30, }, downButton: { position: 'absolute', width: 50, height: 50, alignItems: 'center', justifyContent: 'center', right: 30, top: 70, }, downButtonImage: { resizeMode: 'contain', width: 30, height: 30, }, }); |
To Run the React Native App
Open the terminal again and jump into your project using.cd ProjectNamereact-native run-androidreact-native run-ios (macOS only).
This is how you can Scroll to the Top or Bottom of the ListView in React Native. If you have any doubt or you want to share something about the topic you can comment below or contact us here. There will be more posts coming soon. Stay tuned!
Hope you liked it. 🙂
How useful was this post?
Click on a star to rate us!
Average rating / 5. Vote count:
We are sorry that this post was not useful for you!
Let us improve this post!
Thanks for your feedback!
Leave a Reply
Want to join the discussion? Feel free to contribute!