Skip to content

Commit 7b1780f

Browse files
authored
docs: more polishing
1 parent c0f9897 commit 7b1780f

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Cross platform scrollable bottom sheet with virtualisation support and fully nat
1616
## Features
1717
- **:electron: Virtualisation support**: `FlatList` and `SectionList` components are 1st class citizens, as well as `ScrollView`
1818
- **:fire: Peformant**: runs at 60 FPS even on low grade Android devices
19+
- **:white_check_mark: Horizontal mode**: allows for nice implementation of Google or Apple Maps bottom sheets types, where you have several horizontal lists embedded
20+
- **:gear: Minimalistic**: exposes a set of fundamental props to easily control its behaviour
21+
- **:point_down: Support for interruptions**: animations can be interrupted anytime smoothly without sudden jumps
22+
- **:sunglasses: Imperative snapping**: for cases where you need to close the bottom sheet by pressing an external touchable
23+
- **:rocket: Animate all the things**: you can animate other elements on the screen based on the bottom sheet position
1924
- **: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
20-
- **:white_check_mark: Horizontal mode**: allows for nice implementation of Google or Apple Maps bottom sheets types, where you have several horizontal lists embedded (i.e show recommended places). Take a look at one of the examples where that concept is illustrated
2125
- **:iphone: Expo compatible**: no need to eject to enjoy this component!
22-
- **:gear: Minimalistic**: exposes a set of fundamental props to control its behaviour
23-
- **:point_down: Support for interruptions**: animations can be interrupted anytime without any sudden jumps on the component position
24-
- **:sunglasses: Imperative snapping**: for cases where you need to close the bottom sheet by pressing an external touchable
25-
- **:rocket: Animate all the things**: you can animate other elements on the screen based on the bottom sheet position. See the examples attached
2626
- **:hammer_and_wrench: TS definitions**: For those of you like me who can't look back to start a project in plain JS
2727

2828
## Installation
@@ -143,6 +143,15 @@ bottomSheetRef.current.snapTo(0)
143143

144144
`bottomSheetRef` refers to the [`ref`](https://reactjs.org/docs/react-api.html#reactcreateref) passed to the `ScrollBottomSheet` component.
145145

146+
## Example
147+
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:
148+
149+
```bash
150+
$ npm install
151+
152+
$ npm start
153+
```
154+
146155
## Typescript
147156
The library has been written in Typescript, so you'll get type checking and autocompletion if you use it as well.
148157

0 commit comments

Comments
 (0)