Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.77 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.77 KB
Raw

NavigatorScreen

This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.

The NavigatorScreen component represents a single view/screen/panel and should be used in combination with the NavigatorProvider, the NavigatorButton and the NavigatorBackButton components (or the useNavigator hook).

Usage

Refer to the NavigatorProvider component for a usage example.

Props

The component accepts the following props:

path: string

The screen"s path, matched against the current path stored in the navigator.

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.

Navigator will treat "back" navigations as going to the parent screen — it is therefore responsibility of the consumer of the component to create the correct screen hierarchy.

For example:

  • / is the root of all paths. There should always be a screen with path="/".

  • /parent/child is a child of /parent.

  • /parent/child/grand-child is a child of /parent/child.

  • /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.

  • Required: Yes