diff --git a/docs/PROPSMETHODS.md b/docs/PROPSMETHODS.md index 11bc7a08..758fb7c9 100644 --- a/docs/PROPSMETHODS.md +++ b/docs/PROPSMETHODS.md @@ -12,7 +12,7 @@ By passing a children props it will use the default `ScrollView` component. Howe | -------- | -------- | | node | No | -### `height` +### `snapPoint` A number that will enable the snapping feature and create an intermediate point before opening the modal to full screen. @@ -22,6 +22,14 @@ The value you pass is the height of the modal before being full opened. | -------- | -------- | | number | No | +### `modalHeight` + +A number to define the modal's total height. + +| Type | Required | +| -------- | -------- | +| number | No | + ### `alwaysOpen` A number that will make the modal visible all the time. You can still [open](/PROPSMETHODS.md?id=open) and [close](/PROPSMETHODS.md?id=close) it, using the build-in methods. @@ -40,7 +48,7 @@ Define where the handle on top of the modal should be positioned. | ------------------------- | -------- | --------- | | enum('outside', 'inside') | No | `outside` | -### `style` +### `modalStyle` Define the style of the modal. @@ -76,6 +84,22 @@ It's not really recommanded to set it to `false`, but sometimes you don't have c | -------- | -------- | -------- | | bool | No | `true` | +### `openAnimationConfig` + +Object to change the open animations. There is `Animated.timing` and `Animated.spring` used to animate the modal. That's why the configuration object is splited into two objects to configure both animation. + +| Type | Required | Default | +| -------- | -------- | --------------------------------------------------------------------- | +| object | No | `{ timing: { duration: 280 }, spring: { speed: 14, bounciness: 5 } }` | + +### `closeAnimationConfig` + +Object to change the close animations. There is `Animated.timing` and `Animated.spring` used to animate the modal. That's why the configuration object is splited into two objects to configure both animation. + +| Type | Required | Default | +| -------- | -------- | --------------------------------------------------------------------- | +| object | No | `{ timing: { duration: 280 }, spring: { speed: 14, bounciness: 5 } }` | + ### `adjustToContentHeight` Shrink the modal to your content's height.