Skip to content

Commit

Permalink
feat: Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
patricronge committed Nov 16, 2022
1 parent a125a47 commit 8038c66
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
6 changes: 6 additions & 0 deletions createNativeStackNavigator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,12 @@ The search and close icon color shown in the header. (Android only)

Show the search hint icon when search bar is focused. (Android only)

#### `shouldClearOnSubmit`

Clear the search input when the search button is pressed. (Android only)

Defaults to false.

### Helpers

The stack navigator adds the following methods to the navigation prop:
Expand Down
1 change: 1 addition & 0 deletions guides/GUIDE_FOR_LIBRARY_AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ To render a search bar use `ScreenStackHeaderSearchBarView` with `<SearchBar>` c
- `hintTextColor` - The search hint text color. (Android only)
- `headerIconColor` - The search and close icon color shown in the header. (Android only)
- `shouldShowHintSearchIcon` - Show the search hint icon when search bar is focused. (Android only)
- `shouldClearOnSubmit` - Clear the search input when the search button is pressed. (Android only) Defaults to `false`. (Android only)

Below is a list of properties that can be set with `ScreenStackHeaderConfig` component:

Expand Down
6 changes: 6 additions & 0 deletions native-stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,12 @@ The search and close icon color shown in the header. (Android only)

Show the search hint icon when search bar is focused. (Android only)

#### `shouldClearOnSubmit`

Clear the search input when the search button is pressed. (Android only)

Defaults to false.

### Events

The navigator can [emit events](https://reactnavigation.org/docs/navigation-events) on certain actions. Supported events are:
Expand Down

0 comments on commit 8038c66

Please sign in to comment.