Skip to content

Commit

Permalink
docs: document new prop onValueUpdate
Browse files Browse the repository at this point in the history
  • Loading branch information
@fakeheal
fakeheal committed Mar 7, 2022
1 parent 57df619 commit 4589453
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,21 @@ For more detailed example, take a look at the demo app inside [example/](./examp

## ⚪ Props

| Property | Type | Default | Description |
|-------------------|------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| flagUndetermined | string? | `❓` | Displayed when country code cannot be derived from current phone number. |
| onEndEditing | `function` | undefined | Callback that is called when text input ends [ text input ends](https://reactnative.dev/docs/textinput#onendediting).<br/> It receives [`result`](.src/index.ts#L124). |
| onValidation | `function` | undefined | Callback that is called each time the validation status changes. |
| defaultCountry | `string` | undefined | Two letter code for default country, eg. `BG` |
| defaultPrefix | `string` | undefined | Default number prefix, eg. `+359` |
| defaultValue | `string` | undefined | Default value for the `TextInput`, if you want to pre-populate it. |
| defaultFlag | `string` | undefined | Emoji for the default flag, eg. `🇧🇬` |
| containerStyle | `object` | undefined | Styles for the component's wrapper `<View />` |
| flagContainerStyle | `object` | undefined | Styles for the flag emoji wrapper `<View />` |
| flagTextStyle | `object` | undefined | Styles for the flag emoji `<Text />` |
| textInputStyle | `object` | undefined | Styles for the underlying `<TextInput />` |
| textInputProps | `object` | undefined | [Additional props](https://reactnative.dev/docs/textinput#props) for the underlying `<TextInput />` |
| Property | Type | Default | Description |
|-------------------|------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| flagUndetermined | string? | `❓` | Displayed when country code cannot be derived from current phone number. |
| onEndEditing | `function` | undefined | Callback that is called when text input ends [ text input ends](https://reactnative.dev/docs/textinput#onendediting). <br/> It receives [`result`](.src/index.ts#L124). |
| onValidation | `function` | undefined | Callback that is called each time the validation status changes. |
| onValueUpdate | `function` | undefined | Callback that is called each time the underlying `value` changes. |
| defaultCountry | `string` | undefined | Two letter code for default country, eg. `BG` |
| defaultPrefix | `string` | undefined | Default number prefix, eg. `+359` |
| defaultValue | `string` | undefined | Default value for the `TextInput`, if you want to pre-populate it. |
| defaultFlag | `string` | undefined | Emoji for the default flag, eg. `🇧🇬` |
| containerStyle | `object` | undefined | Styles for the component's wrapper `<View />` |
| flagContainerStyle | `object` | undefined | Styles for the flag emoji wrapper `<View />` |
| flagTextStyle | `object` | undefined | Styles for the flag emoji `<Text />` |
| textInputStyle | `object` | undefined | Styles for the underlying `<TextInput />` |
| textInputProps | `object` | undefined | [Additional props](https://reactnative.dev/docs/textinput#props) for the underlying `<TextInput />` |

## Contributing

Expand Down

0 comments on commit 4589453

Please sign in to comment.