Skip to content

Commit

Permalink
πŸ“ WIP README: Minore Changes
Browse files Browse the repository at this point in the history
  • Loading branch information
dominicstop committed Sep 15, 2021
1 parent 113710c commit 79da36b
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export function App() {

#### D.1.1. `NavigatorView` Component

This component is a wrapper around [`UINavigationController`](https://developer.apple.com/documentation/uikit/uinavigationcontroller), and as such, it also facilitates navigation in a stack-like manner, where in routes are "pushed" and "popped" in and out of the navigation stack. Only one route can be shown at a given time. However it is possible to have multiple `NavigatorView` instances at the same time.
This component is a wrapper around [`UINavigationController`](https://developer.apple.com/documentation/uikit/uinavigationcontroller), and as such, it also facilitates navigation in a stack-like manner (where in routes are "pushed" and "popped" in and out of the navigation stack). Only one route can be shown at a given time. However it is possible to have multiple `NavigatorView` instances at the same time.

* Each instance will have their own separate navigation stack, allowing you to show multiple routes at once.
* But do note that the 1st instance will always be treated as the "root" navigation controller, and subsequently, it’ll become responsible for handling things like setting the color of the status bar, etc.
Expand Down Expand Up @@ -479,13 +479,13 @@ This component uses the "transparent navigation bar" approach. When in use, this
<br>
##### D.1.4.1. `RouteHeaderView` Component Props
##### `RouteHeaderView` Component Props
| Prop Name and Type | Description |
| :----------------------------------------------------------- | ----------- |
| πŸ”€ **Required**: `config`<br/><br/>βš›οΈ [`RouteHeaderConfig`](PLACE_HOLDER_LINK) | |
| πŸ”€ `headerTopPadding`<br/><br/>βš›οΈ [`HeaderHeightConfig`](PLACE_HOLDER_LINK) | |
| πŸ”€ `style`<br/><br/>βš›οΈ `ViewStyle` | |
| πŸ”€ **Required**: `config`<br/><br/>βš›οΈ [`RouteHeaderConfig`](PLACE_HOLDER_LINK) | TBA |
| πŸ”€ `headerTopPadding`<br/><br/>βš›οΈ [`HeaderHeightConfig`](PLACE_HOLDER_LINK) | TBA |
| πŸ”€ `style`<br/><br/>βš›οΈ `ViewStyle` | TBA |
<br>
Expand Down Expand Up @@ -1080,23 +1080,39 @@ Native/Swift Integration
### Navigation Hello World
#### Routes and Route Config
#### Initial Routes
<br>
### Navigation Commands Basics
#### `RouteProps` (Forward Data To Routes)
#### The `NavigationObject`
#### Pushing Routes
#### Forwarding Data To Routes
#### Configure Next Routes
#### `RouteOptions` (Configure Next Routes)
#### Popping Routes
#### `NavCommandPushOptions` and `NavCommandPopOptions`
#### Extra Options
<br>
### Route Config (`routes` prop)
### Customizations Basics
### Initial Routes
#### Route Options
### Basic Customizations
#### Applying Route Options
#### Navigator Customization
#### Per-Route Customization
#### Dynamic Customizations
------
Expand All @@ -1108,16 +1124,12 @@ Native/Swift Integration
#### Navigation Bar: Appearance/Legacy API
##### Navigation Bar Legacy Customizations
##### Navigation Bar β€” Legacy Customizations
##### Navigation Bar Appearance Customizations
##### Navigation Bar β€” Appearance Customizations
<br>
#### Navigation Bar: Global/Default Customizations
#### Navigation Bar: Per-Route Customizations
#### Navigation Bar: Custom Bar Items
#### Navigation Bar: Search Bar
Expand Down

0 comments on commit 79da36b

Please sign in to comment.