Gathering detailed insights and metrics for @emperorschildren/react-native-scroll-bottom-sheet
Gathering detailed insights and metrics for @emperorschildren/react-native-scroll-bottom-sheet
Installations
npm install @emperorschildren/react-native-scroll-bottom-sheetDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.16.0
NPM Version
10.8.1
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
2.0.1
Package Id
@emperorschildren/react-native-scroll-bottom-sheet@2.0.1
Unpacked Size
209.13 kB
Size
45.03 kB
File Count
11
NPM Version
10.8.1
Node Version
20.16.0
Published on
Sep 13, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
4
Dev Dependencies
22
@commitlint/config-conventional@react-native-community/bob@react-native-community/eslint-config@release-it/conventional-changelog@types/babel__core@types/jest@types/react@types/react-nativecommitlinteslinteslint-config-prettiereslint-plugin-headereslint-plugin-prettierhuskyjestprettierreactreact-nativereact-native-gesture-handlerreact-native-reanimatedrelease-ittypescript
Scroll Bottom Sheet
Cross platform scrollable bottom sheet with virtualisation support and fully native animations, that integrates with all core scrollable components from React Native: FlatList, ScrollView and SectionList. Also, it's 100% compatible with Expo.
 |  |
|---|
Features
- :electron: Virtualisation support:
FlatListandSectionListcomponents are 1st class citizens, as well asScrollView - :fire: Performant: runs at 60 FPS even on low grade Android devices
- :white_check_mark: Horizontal mode: allows for nice implementation of Google or Apple Maps bottom sheets types, where you have several horizontal lists embedded
- :gear: Minimalistic: exposes a set of fundamental props to easily control its behaviour, supporting both Timing and Spring animations
- :point_down: Support for interruptions: animations can be interrupted anytime smoothly without sudden jumps
- :sunglasses: Imperative snapping: for cases where you need to close the bottom sheet by pressing an external touchable
- :rocket: Animate all the things: you can animate other elements on the screen based on the bottom sheet position
- :muscle: No native dependencies: fully implemented in JS land, thanks to the powerful Gesture Handler and Reanimated libraries
- :iphone: Expo compatible: no need to eject to enjoy this component!
- :hammer_and_wrench: TS definitions: For those of you like me who can't look back to start a project in plain JS
Installation
npm
1npm i react-native-scroll-bottom-sheet
yarn
1yarn add react-native-scroll-bottom-sheet
If you don't use Expo, you also need to install react-native-gesture-handler and react-native-reanimated libraries along with this one.
It's recommended you install a version of gesture handler equal or higher than 1.6.0, and for reanimated, equal or higher than 1.7.0. Otherwise you may run into unexpected errors. This library is also compatible with reanimated 2.x, starting with react-native-reanimated: 2.0.0-alpha.4.
Usage
The below is an example using the core FlatList from React Native as the scrollable component.
1import React from 'react'; 2import { Dimensions, StyleSheet, Text, View } from 'react-native'; 3import ScrollBottomSheet from 'react-native-scroll-bottom-sheet'; 4 5const windowHeight = Dimensions.get('window').height; 6 7function Example() { 8 return ( 9 <View style={styles.container}> 10 <ScrollBottomSheet<string> // If you are using TS, that'll infer the renderItem `item` type 11 componentType="FlatList" 12 snapPoints={[128, '50%', windowHeight - 200]} 13 initialSnapIndex={2} 14 renderHandle={() => ( 15 <View style={styles.header}> 16 <View style={styles.panelHandle} /> 17 </View> 18 )} 19 data={Array.from({ length: 200 }).map((_, i) => String(i))} 20 keyExtractor={i => i} 21 renderItem={({ item }) => ( 22 <View style={styles.item}> 23 <Text>{`Item ${item}`}</Text> 24 </View> 25 )} 26 contentContainerStyle={styles.contentContainerStyle} 27 /> 28 </View> 29 ); 30} 31 32const styles = StyleSheet.create({ 33 container: { 34 flex: 1, 35 }, 36 contentContainerStyle: { 37 padding: 16, 38 backgroundColor: '#F3F4F9', 39 }, 40 header: { 41 alignItems: 'center', 42 backgroundColor: 'white', 43 paddingVertical: 20, 44 borderTopLeftRadius: 20, 45 borderTopRightRadius: 20 46 }, 47 panelHandle: { 48 width: 40, 49 height: 2, 50 backgroundColor: 'rgba(0,0,0,0.3)', 51 borderRadius: 4 52 }, 53 item: { 54 padding: 20, 55 justifyContent: 'center', 56 backgroundColor: 'white', 57 alignItems: 'center', 58 marginVertical: 10, 59 }, 60});
Props
There are 2 types of props this component receives: explicit and inherited.
Explicit
This is the list of exclusive props that are meant to be used to customise the bottom sheet behaviour.
| Name | Required | Type | Description |
|---|---|---|---|
componentType | yes | string | 'FlatList', 'ScrollView', or 'SectionList' |
snapPoints | yes | Array<string | number> | Array of numbers and/or percentages that indicate the different resting positions of the bottom sheet (in dp or %), starting from the top. If a percentage is used, that would translate to the relative amount of the total window height. If you want that percentage to be calculated based on the parent available space instead, for example to account for safe areas or navigation bars, use it in combination with topInset prop |
initialSnapIndex | yes | number | Index that references the initial resting position of the drawer, starting from the top |
renderHandle | yes | () => React.ReactNode | Render prop for the handle, should return a React Element |
onSettle | no | (index: number) => void | Callback that is executed right after the bottom sheet settles in one of the snapping points. The new index is provided on the callback |
animationType | no | string | timing (default) or spring |
animationConfig | no | TimingConfig or SpringConfig | Timing or Spring configuration for the animation. If animationType is timing, it uses by default a timing configuration with a duration of 250ms and easing fn Easing.inOut(Easing.linear). If animationType is spring, it uses this default spring configuration. You can partially override any parameter from the animation config as per your needs |
animatedPosition | no | Animated.Value<number> | Animated value that tracks the position of the drawer, being: 0 => closed, 1 => fully opened |
topInset | no | number | This value is useful to provide an offset (in dp) when applying percentages for snapping points |
innerRef | no | RefObject | Ref to the inner scrollable component (ScrollView, FlatList or SectionList), so that you can call its imperative methods. For instance, calling scrollTo on a ScrollView. In order to so, you have to use getNode as well, since it's wrapped into an animated component: ref.current.getNode().scrollTo({y: 0, animated: true}) |
containerStyle | no | StyleProp<ViewStyle> | Style to be applied to the container (Handle and Content) |
friction | no | number | Factor of resistance when the gesture is released. A value of 0 offers maximum * acceleration, whereas 1 acts as the opposite. Defaults to 0.95 |
enableOverScroll | no | boolean | Allow drawer to be dragged beyond lowest snap point |
Inherited
Depending on the value of componentType chosen, the bottom sheet component will inherit its underlying props, being one of
FlatListProps, ScrollViewProps or SectionListProps, so that you can tailor the scrollable content behaviour as per your needs.
Methods
snapTo(index)
Imperative method to snap to a specific index, i.e.
1bottomSheetRef.current.snapTo(0)
bottomSheetRef refers to the ref passed to the ScrollBottomSheet component.
Compatibility table
You may add some touchable components inside the bottom sheet or several FlatList widgets for horizontal mode. Unfortunately, not all interactable React Native components are compatible with this library. This is due to some limitations on react-native-gesture-handler, which this library uses behind the scenes. For that, please follow this compatibility table:
| Import | Touchable | Flatlist |
|---|---|---|
| react-native | iOS | 🚫 |
| react-native-gesture-handler | Android | Android, iOS |
Touchables
As you can see on the table, for any touchable component (TouchableOpacity, TouchableHighlight, ...) you need to have different imports depending on the platform. The below is a snippet you may find useful to abstract that into a component.
1import React from "react"; 2import { Platform, TouchableOpacity } from "react-native"; 3import { TouchableOpacity as RNGHTouchableOpacity } from "react-native-gesture-handler"; 4 5const BottomSheetTouchable = (props) => { 6 if (Platform.OS === "android") { 7 return ( 8 <RNGHTouchableOpacity {...props} /> 9 ); 10 } 11 12 return <TouchableOpacity {...props} /> 13}; 14 15export default BottomSheetTouchable;
Horizontal Mode
For this mode to work properly, you have to import FlatList from react-native-gesture-handler instead of react-native.
1import { FlatList } from 'react-native-gesture-handler'; 2 3...
Limitations
At the moment, the component does not support updating snap points via state, something you may want to achieve when changing device orientation for instance. A temporary workaround is to leverage React keys to force a re-mount of the component. This is some illustrative code to give you an idea how you could handle an orientation change with keys:
1import { useDimensions } from '@react-native-community/hooks' 2 3const useOrientation = () => { 4 const { width, height } = useDimensions().window; 5 6 if (height > width) { 7 return 'portrait' 8 } 9 10 return 'landscape' 11} 12 13const OrientationAwareBS = () => { 14 const orientation = useOrientation(); 15 const snapPoints = { 16 portrait: [...], 17 landscape: [...] 18 } 19 20 return ( 21 <ScrollBottomSheet 22 key={orientation} 23 componentType="FlatList" 24 snapPoints={snapPoints[orientation]} 25 initialSnapIndex={2} 26 ... 27 /> 28 ); 29}
Example
There is an Expo example application that you can play with to get a good grasp on the different customisation options. In case of Android, you can directly open the project here. For iOS, head to the example folder and run the project locally:
1$ npm install 2 3$ npm start
Typescript
The library has been written in Typescript, so you'll get type checking and autocompletion if you use it as well.
License
MIT © Raul Gomez Acuna
If you found this project interesting, please consider following me on twitter
No vulnerabilities found.
No security vulnerabilities found.