Skip to content

Commit c7eea5a

Browse files
Update README
1 parent b7ac2b0 commit c7eea5a

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,36 @@ navigation.navigate("firstSheet", { id: 1 });
4343

4444
```
4545

46+
## API
47+
48+
### Navigation options
49+
50+
#### `snapPoints` **Required**
51+
52+
```ts
53+
Array<string | number>
54+
```
55+
56+
Points for the bottom sheet to snap to, points should be sorted from bottom to top. It accepts array of number and string.
57+
58+
#### Other options
59+
60+
Most props from bottom sheet are exposed as navigation options. See the [@gorhom/bottom-sheet website](https://gorhom.github.io/react-native-bottom-sheet/props) for full documentation.
61+
4662
See the [example app](./example/src/SimpleExample.tsx) for full usage details.
4763

64+
### Navigation helpers
65+
66+
Navigation helpers are available on the `navigation` object.
67+
68+
#### `snapTo`
69+
70+
```ts
71+
(index: number) => void
72+
```
73+
74+
Snaps the current sheet to `index`.
75+
4876
## Contributing
4977

5078
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

0 commit comments

Comments
 (0)