Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigator: fix README heading hierarchy #65763

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Navigator: fix README heading hierarchy #65763

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions packages/components/src/navigator/README.md
View file
Open in desktop
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
Loading