Skip to content

Commit 5e06252

Browse files
Eyesonly88osdnk
authored andcommitted
Improve docs (#9)
Make it clear that `initialSnap` value is actually the index from `snapPoints` and not the point value itself. Example, if `snapPoints=[400,250,50]` and I want to set initial snap point to 250 then the `initialSnap` value is actually 1.
1 parent 12040e3 commit 5e06252

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class Example extends React.Component {
5959
| name | required | default | description |
6060
| ------------------------- | -------- | ------- | ------------|
6161
| snapPoints | yes | | E.g. `[300, 200, 0]`. Points for snapping of bottom sheet coomponent. They define distance from bottom of the screen. Might be number or percent (as string e.g. `'20%'`) for points or percents of screen height from bottom. |
62-
| initialSnap | no | 0 | Determines initial snap point of bottom sheet. |
62+
| initialSnap | no | 0 | Determines initial snap point of bottom sheet. The value is the index from snapPoints. |
6363
| renderContent | no | | Method for rendering scrollable content of bottom sheet. |
6464
| renderHeader | no | | Method for rendering non-scrollable header of bottom sheet. |
6565
| enabledGestureInteraction | no | `true` | Defines if bottom sheet could be scrollable by gesture. |

0 commit comments

Comments
 (0)