Gathering detailed insights and metrics for react-native-swiper-flatlist
Gathering detailed insights and metrics for react-native-swiper-flatlist
Gathering detailed insights and metrics for react-native-swiper-flatlist
Gathering detailed insights and metrics for react-native-swiper-flatlist
react-native-swiper-flatlist-speedbox
React native swiper flatlist component
react-native-draggable-flatlist
A drag-and-drop-enabled FlatList component for React Native
swiper
Most modern mobile touch slider and framework with hardware accelerated transitions
react-native-swiper
Swiper component for React Native.
npm install react-native-swiper-flatlist
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
554 Stars
131 Commits
98 Forks
11 Watching
7 Branches
20 Contributors
Updated on 25 Nov 2024
TypeScript (43.74%)
JavaScript (26.43%)
Java (17.06%)
Ruby (5.97%)
Objective-C++ (4.09%)
Objective-C (2.59%)
Swift (0.11%)
Cumulative downloads
Total Downloads
Last day
-16.4%
2,388
Compared to previous day
Last week
8.5%
15,896
Compared to previous week
Last month
-1.2%
64,264
Compared to previous month
Last year
25%
724,018
Compared to previous year
1
19
yarn add react-native-swiper-flatlist
or
npm install react-native-swiper-flatlist --save
Version 2.x was re-implemented using React Hooks so it only works with version 0.59 or above
Version 3.x was re-implemented using Typescript and it works with react-native-web
react-native-swiper-flatlist | react-native | Detox tests |
---|---|---|
1.x | <= 0.58 | X |
2.x | >= 0.59 | X |
3.x | >= 0.59 |
Note: we are using the feature export type
available in babel v7.9.0
https://github.com/babel/babel/pull/11171, you might have this issue with React Native between 0.60 and 0.63, please update babel
to at least to v7.9.0
Expo example with renderItems, children and more
React Native example with renderItems and custom pagination
React Native example with children
1import React from 'react'; 2import { Text, Dimensions, StyleSheet, View } from 'react-native'; 3import { SwiperFlatList } from 'react-native-swiper-flatlist'; 4 5const colors = ['tomato', 'thistle', 'skyblue', 'teal']; 6 7const App = () => ( 8 <View style={styles.container}> 9 <SwiperFlatList 10 autoplay 11 autoplayDelay={2} 12 autoplayLoop 13 index={2} 14 showPagination 15 data={colors} 16 renderItem={({ item }) => ( 17 <View style={[styles.child, { backgroundColor: item }]}> 18 <Text style={styles.text}>{item}</Text> 19 </View> 20 )} 21 /> 22 </View> 23); 24 25const { width } = Dimensions.get('window'); 26const styles = StyleSheet.create({ 27 container: { flex: 1, backgroundColor: 'white' }, 28 child: { width, justifyContent: 'center' }, 29 text: { fontSize: width * 0.5, textAlign: 'center' }, 30}); 31 32export default App;
1import React from 'react'; 2import { Text, Dimensions, StyleSheet, View } from 'react-native'; 3import { SwiperFlatList } from 'react-native-swiper-flatlist'; 4 5const App = () => ( 6 <View style={styles.container}> 7 <SwiperFlatList autoplay autoplayDelay={2} autoplayLoop index={2} showPagination> 8 <View style={[styles.child, { backgroundColor: 'tomato' }]}> 9 <Text style={styles.text}>1</Text> 10 </View> 11 <View style={[styles.child, { backgroundColor: 'thistle' }]}> 12 <Text style={styles.text}>2</Text> 13 </View> 14 <View style={[styles.child, { backgroundColor: 'skyblue' }]}> 15 <Text style={styles.text}>3</Text> 16 </View> 17 <View style={[styles.child, { backgroundColor: 'teal' }]}> 18 <Text style={styles.text}>4</Text> 19 </View> 20 </SwiperFlatList> 21 </View> 22); 23 24const { width } = Dimensions.get('window'); 25 26const styles = StyleSheet.create({ 27 container: { flex: 1, backgroundColor: 'white' }, 28 child: { width, justifyContent: 'center' }, 29 text: { fontSize: width * 0.5, textAlign: 'center' }, 30}); 31 32export default App;
To use react-native-gesture-handler
instead of FlatList import the library like:
1import { SwiperFlatListWithGestureHandler } from 'react-native-swiper-flatlist/WithGestureHandler';
Prop | Default | Type | Description |
---|---|---|---|
data | not required if children is used | array | Data to use in renderItem |
children | - | node | Children elements |
renderItem | not required if children is used | FlatListProps<T>['renderItem'] | Takes an item from data and renders it into the list |
onMomentumScrollEnd | - | (item: { index: number }, event: any) | Called after scroll end and the first parameter is the current index |
vertical | false | boolean | Show vertical swiper |
index | 0 | number | Index to start |
renderAll | false | boolean | Render all the items before display it |
Pagination | |||
showPagination | false | boolean | Show pagination |
paginationDefaultColor | gray | string | Pagination color |
paginationActiveColor | white | string | Pagination color |
paginationStyle | {} | ViewStyle | Style object for the container |
paginationStyleItem | {} | ViewStyle | Style object for the item (dot) |
paginationStyleItemActive | {} | ViewStyle | Style object for the active item (dot) |
paginationStyleItemInactive | {} | ViewStyle | Style object for the inactive item (dot) |
onPaginationSelectedIndex | - | () => void | Executed when the user presses the pagination index, similar properties onChangeIndex |
PaginationComponent | Component | node | Overwrite Pagination component |
Autoplay | |||
autoplay | false | boolean | Change index automatically |
autoplayDelay | 3 | number | Delay between every page in seconds |
autoplayLoop | false | boolean | Continue playing after reach end |
autoplayLoopKeepAnimation | false | boolean | Show animation when reach the end of the list |
autoplayInvertDirection | false | boolean | Invert auto play direction |
disableGesture | false | boolean | Disable swipe gesture |
More props
This is a wrapper around Flatlist, all their props
works well and the inherited props
too (from ScrollView and VirtualizedList)
Name | Type | Use |
---|---|---|
scrollToIndex | ({ index: number, animated?: boolean}) => void | Scroll to the index |
getCurrentIndex | () => number | Returns the current index |
getPrevIndex | () => number | Returns the previous index |
onChangeIndex | ({ index: number, prevIndex: number}) => void | Executed every time the index change, the index change when the user reaches 60% of the next screen |
goToFirstIndex | () => void | Go to the first index |
goToLastIndex | () => void | Go to the last index |
This library support RTL languages, when I18nManager.isRTL
is true
.
useReactNativeGestureHandler
which is a workaround for this issue.Gustavo Gard
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
binaries present in source code
Details
Reason
SAST tool detected but not run on all commits
Details
Reason
5 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 5
Reason
Found 4/30 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
67 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More