Skip to content

Commit

Permalink
Navigator: fix README heading hierarchy (WordPress#65763)
Browse files Browse the repository at this point in the history
Co-authored-by: ciampo <[email protected]>
Co-authored-by: mirka <[email protected]>
  • Loading branch information
3 people authored Oct 1, 2024
1 parent 8e4aac8 commit f5378f6
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions packages/components/src/navigator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ The children elements.

#### `Navigator.Screen`

##### Props

###### `path`: `string`

The screen's path, matched against the current path stored in the navigator.
Expand All @@ -94,7 +96,9 @@ The children elements.

- Required: Yes

##### `Navigator.Button`
#### `Navigator.Button`

##### Props

###### `path`: `string`

Expand All @@ -119,7 +123,9 @@ The children elements.

`Navigator.Button` also inherits all of the [`Button` props](/packages/components/src/button/README.md#props), except for `href` and `target`.

##### `Navigator.BackButton`
#### `Navigator.BackButton`

##### Props

###### `children`: `string`

Expand All @@ -131,10 +137,12 @@ The children elements.

`Navigator.BackButton` also inherits all of the [`Button` props](/packages/components/src/button/README.md#props), except for `href` and `target`.

###### `useNavigator`
#### `useNavigator`

You can retrieve a `navigator` instance by using the `useNavigator` hook.

##### Props

The `navigator` instance has a few properties:

###### `goTo`: `( path: string, options: NavigateOptions ) => void`
Expand Down

0 comments on commit f5378f6

Please sign in to comment.