From 42682dce171b9c3253c71336e8f9e35778c2001c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dros=CC=81?= Date: Mon, 27 Feb 2023 14:35:12 +0100 Subject: [PATCH 1/2] docs: document new animation property --- versioned_docs/version-4.x/stack-navigator.md | 19 +++++++++++++++++++ versioned_docs/version-5.x/stack-navigator.md | 19 +++++++++++++++++++ versioned_docs/version-6.x/stack-navigator.md | 19 +++++++++++++++++++ versioned_docs/version-7.x/stack-navigator.md | 19 +++++++++++++++++++ 4 files changed, 76 insertions(+) diff --git a/versioned_docs/version-4.x/stack-navigator.md b/versioned_docs/version-4.x/stack-navigator.md index 0b870e2e33a..9d849c8fce1 100644 --- a/versioned_docs/version-4.x/stack-navigator.md +++ b/versioned_docs/version-4.x/stack-navigator.md @@ -313,6 +313,25 @@ You can also specify `{ backgroundColor: 'transparent' }` to make the previous s Whether transition animation should be enabled the screen. If you set it to `false`, the screen won't animate when pushing or popping. Defaults to `true`. +#### `animation` + +How the screen should animate when pushed or popped. + +Supported values: + +- `default`: use the platform default animation +- `fade`: fade screen in or out +- `fade_from_bottom`: fade the new screen from bottom +- `simple_push`: default animation, but without shadow and native header transition +- `slide_from_bottom`: slide in the new screen from bottom +- `slide_from_right`: slide in the new screen from right +- `slide_from_left`: slide in the new screen from left +- `none`: don't animate the screen + +If `animation` is set, it overrides `cardStyleInterpolator` property. + +Only supported on Android and iOS. + #### `animationTypeForReplace` The type of animation to use when this screen replaces another screen. It takes the following values: diff --git a/versioned_docs/version-5.x/stack-navigator.md b/versioned_docs/version-5.x/stack-navigator.md index bb751bc64f2..7f969f821e3 100755 --- a/versioned_docs/version-5.x/stack-navigator.md +++ b/versioned_docs/version-5.x/stack-navigator.md @@ -364,6 +364,25 @@ You can also specify `{ backgroundColor: 'transparent' }` to make the previous s Whether transition animation should be enabled on the screen. If you set it to `false`, the screen won't animate when pushing or popping. Defaults to `true` on iOS and Android, `false` on Web. +#### `animation` + +How the screen should animate when pushed or popped. + +Supported values: + +- `default`: use the platform default animation +- `fade`: fade screen in or out +- `fade_from_bottom`: fade the new screen from bottom +- `simple_push`: default animation, but without shadow and native header transition +- `slide_from_bottom`: slide in the new screen from bottom +- `slide_from_right`: slide in the new screen from right +- `slide_from_left`: slide in the new screen from left +- `none`: don't animate the screen + +If `animation` is set, it overrides `cardStyleInterpolator` property. + +Only supported on Android and iOS. + #### `animationTypeForReplace` The type of animation to use when this screen replaces another screen. It takes the following values: diff --git a/versioned_docs/version-6.x/stack-navigator.md b/versioned_docs/version-6.x/stack-navigator.md index 280071e18a5..c605bade23d 100755 --- a/versioned_docs/version-6.x/stack-navigator.md +++ b/versioned_docs/version-6.x/stack-navigator.md @@ -166,6 +166,25 @@ See [Transparent modals](#transparent-modals) for more details on how to customi Whether transition animation should be enabled on the screen. If you set it to `false`, the screen won't animate when pushing or popping. Defaults to `true` on iOS and Android, `false` on Web. +#### `animation` + +How the screen should animate when pushed or popped. + +Supported values: + +- `default`: use the platform default animation +- `fade`: fade screen in or out +- `fade_from_bottom`: fade the new screen from bottom +- `simple_push`: default animation, but without shadow and native header transition +- `slide_from_bottom`: slide in the new screen from bottom +- `slide_from_right`: slide in the new screen from right +- `slide_from_left`: slide in the new screen from left +- `none`: don't animate the screen + +If `animation` is set, it overrides `cardStyleInterpolator` property. + +Only supported on Android and iOS. + #### `animationTypeForReplace` The type of animation to use when this screen replaces another screen. It takes the following values: diff --git a/versioned_docs/version-7.x/stack-navigator.md b/versioned_docs/version-7.x/stack-navigator.md index 280071e18a5..c605bade23d 100755 --- a/versioned_docs/version-7.x/stack-navigator.md +++ b/versioned_docs/version-7.x/stack-navigator.md @@ -166,6 +166,25 @@ See [Transparent modals](#transparent-modals) for more details on how to customi Whether transition animation should be enabled on the screen. If you set it to `false`, the screen won't animate when pushing or popping. Defaults to `true` on iOS and Android, `false` on Web. +#### `animation` + +How the screen should animate when pushed or popped. + +Supported values: + +- `default`: use the platform default animation +- `fade`: fade screen in or out +- `fade_from_bottom`: fade the new screen from bottom +- `simple_push`: default animation, but without shadow and native header transition +- `slide_from_bottom`: slide in the new screen from bottom +- `slide_from_right`: slide in the new screen from right +- `slide_from_left`: slide in the new screen from left +- `none`: don't animate the screen + +If `animation` is set, it overrides `cardStyleInterpolator` property. + +Only supported on Android and iOS. + #### `animationTypeForReplace` The type of animation to use when this screen replaces another screen. It takes the following values: From f96589b0a7c7d154f862fd58785422723c216978 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dros=CC=81?= Date: Mon, 27 Feb 2023 15:51:22 +0100 Subject: [PATCH 2/2] docs: remove simple_push animation option --- versioned_docs/version-4.x/stack-navigator.md | 1 - versioned_docs/version-5.x/stack-navigator.md | 1 - versioned_docs/version-6.x/stack-navigator.md | 1 - versioned_docs/version-7.x/stack-navigator.md | 1 - 4 files changed, 4 deletions(-) diff --git a/versioned_docs/version-4.x/stack-navigator.md b/versioned_docs/version-4.x/stack-navigator.md index 9d849c8fce1..b687ab301a8 100644 --- a/versioned_docs/version-4.x/stack-navigator.md +++ b/versioned_docs/version-4.x/stack-navigator.md @@ -322,7 +322,6 @@ Supported values: - `default`: use the platform default animation - `fade`: fade screen in or out - `fade_from_bottom`: fade the new screen from bottom -- `simple_push`: default animation, but without shadow and native header transition - `slide_from_bottom`: slide in the new screen from bottom - `slide_from_right`: slide in the new screen from right - `slide_from_left`: slide in the new screen from left diff --git a/versioned_docs/version-5.x/stack-navigator.md b/versioned_docs/version-5.x/stack-navigator.md index 7f969f821e3..48a77d058cd 100755 --- a/versioned_docs/version-5.x/stack-navigator.md +++ b/versioned_docs/version-5.x/stack-navigator.md @@ -373,7 +373,6 @@ Supported values: - `default`: use the platform default animation - `fade`: fade screen in or out - `fade_from_bottom`: fade the new screen from bottom -- `simple_push`: default animation, but without shadow and native header transition - `slide_from_bottom`: slide in the new screen from bottom - `slide_from_right`: slide in the new screen from right - `slide_from_left`: slide in the new screen from left diff --git a/versioned_docs/version-6.x/stack-navigator.md b/versioned_docs/version-6.x/stack-navigator.md index c605bade23d..cd3ea066372 100755 --- a/versioned_docs/version-6.x/stack-navigator.md +++ b/versioned_docs/version-6.x/stack-navigator.md @@ -175,7 +175,6 @@ Supported values: - `default`: use the platform default animation - `fade`: fade screen in or out - `fade_from_bottom`: fade the new screen from bottom -- `simple_push`: default animation, but without shadow and native header transition - `slide_from_bottom`: slide in the new screen from bottom - `slide_from_right`: slide in the new screen from right - `slide_from_left`: slide in the new screen from left diff --git a/versioned_docs/version-7.x/stack-navigator.md b/versioned_docs/version-7.x/stack-navigator.md index c605bade23d..cd3ea066372 100755 --- a/versioned_docs/version-7.x/stack-navigator.md +++ b/versioned_docs/version-7.x/stack-navigator.md @@ -175,7 +175,6 @@ Supported values: - `default`: use the platform default animation - `fade`: fade screen in or out - `fade_from_bottom`: fade the new screen from bottom -- `simple_push`: default animation, but without shadow and native header transition - `slide_from_bottom`: slide in the new screen from bottom - `slide_from_right`: slide in the new screen from right - `slide_from_left`: slide in the new screen from left