Skip to content

Commit b0cb3c6

Browse files
vonovakvonovak
committed
update readme with correct prop types
1 parent 6e8569b commit b0cb3c6

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

‎README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,21 @@ static navigationOptions = {
4545
| left: boolean | whether the `HeaderButtons` are on the left from header title | false by default |
4646
| HeaderButtonComponent: React.ComponentType<\*> | component that renders the buttons | 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` for reference). |
4747
| OverflowIcon?: React.Element<\*> | React element for the overflow icon | you need to provide this only if you need an overflow icon |
48-
| overflowButtonWrapperStyle?: StyleObj | optional styles for overflow button | there are some default styles set, as seen in `OverflowButton.js` |
48+
| overflowButtonWrapperStyle?: ViewStyleProp | optional styles for overflow button | there are some default styles set, as seen in `OverflowButton.js` |
4949
| onOverflowMenuPress?: ({ hiddenButtons: Array<React.Element<\*>>, overflowButtonRef: ?View }) => any | function that is called when overflow menu is pressed. | this will override the default handler |
5050

5151
`Item` accepts:
5252

53-
| prop and type | description | note |
54-
| ----------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
55-
| onPress: ?() => any | function to call on press | if this is a falsy value, the button won't react to touches |
56-
| title: string | title for the button, required | |
57-
| show: "always" or "never" | string specifying if the icon should be shown or hidden in overflow menu | "always" by default |
58-
| ButtonElement?: React.Node | optional React element to show as button. Use this for completely custom buttons. | if neither `IconComponent` nor this is defined, will render text with the `title` |
59-
| iconName?: string | icon name, used together with the `IconComponent` prop | |
60-
| buttonStyle?: StyleObj | style to apply to the button | applies to both icon and text |
61-
| buttonWrapperStyle?: StyleObj | style to apply to the touchable element that wraps the button | |
62-
| testID?: string | ID to locate the view in e2e tests | testID of the overflow button is exported under `OVERFLOW_BUTTON_TEST_ID` |
53+
| prop and type | description | note |
54+
| ---------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
55+
| onPress: ?() => any | function to call on press | if this is a falsy value, the button won't react to touches |
56+
| title: string | title for the button, required | |
57+
| show: "always" or "never" | string specifying if the icon should be shown or hidden in overflow menu | "always" by default |
58+
| ButtonElement?: React.Node | optional React element to show as button. Use this for completely custom buttons. | if neither `IconComponent` nor this is defined, will render text with the `title` |
59+
| iconName?: string | icon name, used together with the `IconComponent` prop | |
60+
| buttonStyle?: ViewStyleProp | style to apply to the button | applies to both icon and text |
61+
| buttonWrapperStyle?: ViewStyleProp | style to apply to the touchable element that wraps the button | |
62+
| testID?: string | ID to locate the view in e2e tests | testID of the overflow button is exported under `OVERFLOW_BUTTON_TEST_ID` |
6363

6464
`HeaderButton` accepts:
6565

0 commit comments

Comments
 (0)