Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgommezz/react-native-scroll-bottom-sheet
Cross platform scrollable bottom sheet with virtualisation support, native animations at 60 FPS and fully implemented in JS land :fire:
https://github.com/rgommezz/react-native-scroll-bottom-sheet
android bottom-sheet bottomsheet cross-platform ios react-native react-native-gesture-handler react-native-reanimated
Last synced: about 1 month ago
JSON representation
Cross platform scrollable bottom sheet with virtualisation support, native animations at 60 FPS and fully implemented in JS land :fire:
- Host: GitHub
- URL: https://github.com/rgommezz/react-native-scroll-bottom-sheet
- Owner: rgommezz
- License: mit
- Created: 2020-05-03T17:31:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T19:28:28.000Z (over 1 year ago)
- Last Synced: 2024-07-19T02:14:56.418Z (2 months ago)
- Topics: android, bottom-sheet, bottomsheet, cross-platform, ios, react-native, react-native-gesture-handler, react-native-reanimated
- Language: TypeScript
- Homepage:
- Size: 82.8 MB
- Stars: 1,530
- Watchers: 16
- Forks: 63
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Scroll Bottom Sheet
[](https://www.npmjs.com/package/react-native-scroll-bottom-sheet)
[](https://bundlephobia.com/result?p=react-native-scroll-bottom-sheet)
[](https://github.com/rgommezz/react-native-scroll-bottom-sheet/blob/master/LICENSE)
Cross platform scrollable bottom sheet with virtualisation support and fully native animations, that integrates with all core scrollable components from React Native: [FlatList](https://reactnative.dev/docs/flatlist), [ScrollView](https://reactnative.dev/docs/scrollview) and [SectionList](https://reactnative.dev/docs/sectionlist). Also, it's 100% compatible with Expo.
 |  |
:---------------------:|:------------------:|
## Features
- **:electron: Virtualisation support**: `FlatList` and `SectionList` components are 1st class citizens, as well as `ScrollView`
- **: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](https://github.com/software-mansion/react-native-gesture-handler) and [Reanimated](https://github.com/software-mansion/react-native-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
```sh
npm i react-native-scroll-bottom-sheet
```
#### yarn
```sh
yarn add react-native-scroll-bottom-sheet
```
If you don't use Expo, you also need to install [react-native-gesture-handler](https://github.com/software-mansion/react-native-gesture-handler) and [react-native-reanimated](https://github.com/software-mansion/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.
```tsx
import React from 'react';
import { Dimensions, StyleSheet, Text, View } from 'react-native';
import ScrollBottomSheet from 'react-native-scroll-bottom-sheet';
const windowHeight = Dimensions.get('window').height;
function Example() {
return (
// If you are using TS, that'll infer the renderItem `item` type
componentType="FlatList"
snapPoints={[128, '50%', windowHeight - 200]}
initialSnapIndex={2}
renderHandle={() => (
)}
data={Array.from({ length: 200 }).map((_, i) => String(i))}
keyExtractor={i => i}
renderItem={({ item }) => (
{`Item ${item}`}
)}
contentContainerStyle={styles.contentContainerStyle}
/>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
},
contentContainerStyle: {
padding: 16,
backgroundColor: '#F3F4F9',
},
header: {
alignItems: 'center',
backgroundColor: 'white',
paddingVertical: 20,
borderTopLeftRadius: 20,
borderTopRightRadius: 20
},
panelHandle: {
width: 40,
height: 2,
backgroundColor: 'rgba(0,0,0,0.3)',
borderRadius: 4
},
item: {
padding: 20,
justifyContent: 'center',
backgroundColor: 'white',
alignItems: 'center',
marginVertical: 10,
},
});
```
## 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` | 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](https://github.com/rgommezz/react-native-scroll-bottom-sheet/blob/master/src/index.tsx#L77). You can partially override any parameter from the animation config as per your needs |
| `animatedPosition` | no | `Animated.Value` | 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` | 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](https://reactnative.dev/docs/flatlist#props), [ScrollViewProps](https://reactnative.dev/docs/scrollview#props) or [SectionListProps](https://reactnative.dev/docs/sectionlist#props), 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.
```js
bottomSheetRef.current.snapTo(0)
```
`bottomSheetRef` refers to the [`ref`](https://reactjs.org/docs/react-api.html#reactcreateref) 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.
```js
import React from "react";
import { Platform, TouchableOpacity } from "react-native";
import { TouchableOpacity as RNGHTouchableOpacity } from "react-native-gesture-handler";
const BottomSheetTouchable = (props) => {
if (Platform.OS === "android") {
return (
);
}
return
};
export default BottomSheetTouchable;
```
### Horizontal Mode
For this mode to work properly, **you have to import `FlatList` from react-native-gesture-handler** instead of react-native.
```js
import { FlatList } from 'react-native-gesture-handler';
...
```
## 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:
```js
import { useDimensions } from '@react-native-community/hooks'
const useOrientation = () => {
const { width, height } = useDimensions().window;
if (height > width) {
return 'portrait'
}
return 'landscape'
}
const OrientationAwareBS = () => {
const orientation = useOrientation();
const snapPoints = {
portrait: [...],
landscape: [...]
}
return (
);
}
```
## 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](https://expo.io/@rgommezz/react-native-scroll-bottom-sheet-example). For iOS, head to the [example folder](https://github.com/rgommezz/react-native-scroll-bottom-sheet/tree/master/example) and run the project locally:
```bash
$ npm install
$ 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](https://raulgomez.io/)
If you found this project interesting, please consider following me on [twitter](https://twitter.com/rgommezz)