From 9df56739d18145945f41c23d031d61ac167f2c7e Mon Sep 17 00:00:00 2001 From: Marco Ciampini Date: Wed, 28 Aug 2024 23:55:58 +0200 Subject: [PATCH] Mention wrapper height in README --- .../components/src/navigator/navigator-provider/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/components/src/navigator/navigator-provider/README.md b/packages/components/src/navigator/navigator-provider/README.md index 35bf7a69720be2..3290b39c83010c 100644 --- a/packages/components/src/navigator/navigator-provider/README.md +++ b/packages/components/src/navigator/navigator-provider/README.md @@ -33,7 +33,7 @@ const MyNavigation = () => ( ); ``` -**Important note** +### Hierarchical `path`s `Navigator` assumes that screens are organized hierarchically according to their `path`, which should follow a URL-like scheme where each path segment starts with and is separated by the `/` character. @@ -47,6 +47,10 @@ For example: - `/parent/:param` is a child of `/parent` as well. - if the current screen has a `path` with value `/parent/child/grand-child`, when going "back" `Navigator` will try to recursively navigate the path hierarchy until a matching screen (or the root `/`) is found. +### Height and animations + +Due to how `NavigatorScreen` animations work, it is recommended that the `NavigatorProvider` component is given enough height to match the tallest `NavigatorScreen`. Not doing so could result in glitchy animations, especially when transitioning from a taller to a shorter `NavigatorScreen`. + ## Props The component accepts the following props: