Skip to content

Commit

Permalink
Mention wrapper height in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ciampo committed Aug 29, 2024
1 parent 77b1c26 commit ab55d38
Showing 1 changed file with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down

0 comments on commit ab55d38

Please sign in to comment.