Skip to content

Commit ec12459

Browse files
committed
docs: minor docs update
1 parent 98337a1 commit ec12459

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ export function UsageWithIcons({ navigation }) {
7474

7575
Is a wrapper over all the visible header buttons (those can be text-buttons, icon-button, or any custom react elements).
7676
The most important prop is `HeaderButtonComponent` that defines how all icons rendered in children will look.
77-
In particular, it allows setting their icon component, color, and size once so that you don't need to repeat it for each icon-button - but you can easily override those for each `Item` if you like.
77+
In particular, it allows setting their `IconComponent`, `color`, and `size` once so that you don't need to repeat it for each icon-button - but you can override those for each `Item` if you like.
7878

7979
`HeaderButtons` accepts:
8080

8181
| prop and type | description | note |
8282
| ------------------------------------------------ | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8383
| HeaderButtonComponent?: React.ComponentType<any> | component that renders the buttons, `HeaderButton` by default | Typically, you'll want to provide a component that wraps `HeaderButton` provided by this package, as seen in the [quick example](#quick-example). However, you're free to use your own component (see `HeaderButton.js` for reference). |
84-
| children: React.Node | whatever you want to render inside | typically `Item` or your component that renders `Item`, but it can be anything. |
84+
| children: React.Node | whatever you want to render inside | Typically, `Item` or your component that renders `Item`, but it can be any React element. |
8585
| left?: boolean | whether the `HeaderButtons` are on the left from header title | false by default, it only influences styling in a subtle way |
8686

8787
#### `Item`
@@ -111,9 +111,9 @@ Renders text, or icon, and has an `onPress` handler. Take a look at the example
111111
#### `OverflowMenu`
112112

113113
Is the place to define the behavior for overflow button (if there is one). Please note you can render `OverflowMenu` only by itself too, you do no need to wrap it in `HeaderButtons`.
114-
The most interesting prop is `onPress` which defines what kind of overflow menu we should show.
114+
The most important prop is `onPress` which defines what kind of overflow menu we should show.
115115

116-
The package exports common handlers you can use, but you can provide your own too (via `onPress` prop):
116+
The package exports common handlers you can use, but you can provide your own too (via the `onPress` prop):
117117

118118
| exported handler | description |
119119
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -131,9 +131,9 @@ The package exports common handlers you can use, but you can provide your own to
131131
| onPress?: (OnOverflowMenuPressParams) => any | function that is called when overflow menu is pressed. | This will override the default handler. Note the default handler offers (limited) customization. See more in "Recipes". |
132132
| testID?: string | testID to locate the overflow button in e2e tests | the default is available under `import { OVERFLOW_BUTTON_TEST_ID } from 'react-navigation-header-buttons/e2e'` |
133133
| accessibilityLabel?: string | | 'More options' by default |
134-
| left?: boolean | whether the `OverflowMenu` is on the left from header title | false by default, it just influences styling. No need to pass this if you passed it to `HeaderButtons` |
134+
| left?: boolean | whether the `OverflowMenu` is on the left from header title | false by default, it just influences styling. No need to pass this if you already passed it to `HeaderButtons`. |
135135
| children: React.Node | the overflow items | typically `HiddenItem`s, please read the note below |
136-
| other props | props passed to the nested Touchable | pass eg. `pressColor` to control ripple color on Android |
136+
| ...TouchableProps | props passed to the nested Touchable | pass eg. `pressColor` to control ripple color on Android |
137137

138138
##### Important note
139139

0 commit comments

Comments
 (0)