You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,14 +74,14 @@ export function UsageWithIcons({ navigation }) {
74
74
75
75
Is a wrapper over all the visible header buttons (those can be text-buttons, icon-button, or any custom react elements).
76
76
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.
| 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.|
85
85
| left?: boolean | whether the `HeaderButtons` are on the left from header title | false by default, it only influences styling in a subtle way |
86
86
87
87
#### `Item`
@@ -111,9 +111,9 @@ Renders text, or icon, and has an `onPress` handler. Take a look at the example
111
111
#### `OverflowMenu`
112
112
113
113
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.
115
115
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):
@@ -131,9 +131,9 @@ The package exports common handlers you can use, but you can provide your own to
131
131
| 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". |
132
132
| 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'`|
133
133
| 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`.|
135
135
| 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 |
0 commit comments