Skip to content

docs: document new animation property #1215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions versioned_docs/version-4.x/stack-navigator.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,24 @@ 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
- `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:
Expand Down
18 changes: 18 additions & 0 deletions versioned_docs/version-5.x/stack-navigator.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,24 @@ 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
- `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:
Expand Down
18 changes: 18 additions & 0 deletions versioned_docs/version-6.x/stack-navigator.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,24 @@ 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
- `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:
Expand Down
18 changes: 18 additions & 0 deletions versioned_docs/version-7.x/stack-navigator.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,24 @@ 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
- `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:
Expand Down