Skip to content

Commit

Permalink
fix: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremybarbet committed Mar 20, 2020
1 parent 534dc69 commit 7ec0bb2
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/PROPSMETHODS.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,19 +287,21 @@ Callback to subscribe to layout changes. Return the `LayoutRectangle` object fro

The method to open the modal.

| Type | Required |
| -------- | --------- |
| function | Yes |
?> If you are using `snapPoint` prop, you can supply a `dest` argument to the `open` method, to open it to the top directly `open('top')`. You don't have to provide anything if you want the default behavior.

| Type | Required |
| ------------------------------------ | --------- |
| function: (dest?: 'default' | 'top') | Yes |

### `close()`

The method to close the modal. You don't need to call it to dismiss the modal, since you can swipe down to dismiss.

?> If you are using `alwaysOpen` props, you can supply a `dest` argument to the `close` method to reset it to the intial position `close('alwaysOpen')`, and avoiding to close it completely.
?> If you are using `alwaysOpen` prop, you can supply a `dest` argument to the `close` method to reset it to the intial position `close('alwaysOpen')`, and avoiding to close it completely.

| Type | Required |
| ------------------------------------------- | -------- |
| function: (dest: 'alwaysOpen' \| 'default') | No |
| Type | Required |
| -------------------------------------------- | -------- |
| function: (dest?: 'default' \| 'alwaysOpen') | No |

### `scrollTo()`

Expand Down

0 comments on commit 7ec0bb2

Please sign in to comment.