diff --git a/docs/textinput.html b/docs/textinput.html index 0ee044a1ed9..f9df953a4e4 100644 --- a/docs/textinput.html +++ b/docs/textinput.html @@ -8,15 +8,7 @@ example:

<TextInput style={{height: 40, borderColor: 'gray', borderWidth: 1}} onChangeText={(text) => this.setState({text})} value={this.state.text} - />

Note that some props are only available with multiline={true/false}:

var onlyMultiline = { - onSelectionChange: true, // not supported in Open Source yet - onTextInput: true, // not supported in Open Source yet - children: true, - }; - - var notMultiline = { - onSubmitEditing: true, - };

Edit on GitHubProps #

View props... #

autoCapitalize enum('none', 'sentences', 'words', 'characters') #

Can tell TextInput to automatically capitalize certain characters.

  • characters: all characters,
  • words: first letter of each word
  • sentences: first letter of each sentence (default)
  • none: don't auto capitalize anything

autoCorrect bool #

If false, disables auto-correct. The default value is true.

autoFocus bool #

If true, focuses the input on componentDidMount. + />

Note that some props are only available with multiline={true/false}:

Edit on GitHubProps #

View props... #

autoCapitalize enum('none', 'sentences', 'words', 'characters') #

Can tell TextInput to automatically capitalize certain characters.

  • characters: all characters,
  • words: first letter of each word
  • sentences: first letter of each sentence (default)
  • none: don't auto capitalize anything

autoCorrect bool #

If false, disables auto-correct. The default value is true.

autoFocus bool #

If true, focuses the input on componentDidMount. The default value is false.

defaultValue string #

Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you don't want to deal with listening to events and updating the value prop to keep the controlled state in sync.

editable bool #

If false, text is not editable. The default value is true.

keyboardType enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search') #

Determines which keyboard to open, e.g.numeric.

The following values work across platforms: @@ -34,7 +26,10 @@ cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

iosblurOnSubmit bool #

If true, the text field will blur when submitted. -The default value is true.

iosclearButtonMode enum('never', 'while-editing', 'unless-editing', 'always') #

When the clear button should appear on the right side of the text view

iosclearTextOnFocus bool #

If true, clears the text field automatically when editing begins

iosenablesReturnKeyAutomatically bool #

If true, the keyboard disables the return key when there is no text and +The default value is true for single-line fields and false for +multiline fields. Note that for multiline fields, setting blurOnSubmit +to true means that pressing return will blur the field and trigger the +onSubmitEditing event instead of inserting a newline into the field.

iosclearButtonMode enum('never', 'while-editing', 'unless-editing', 'always') #

When the clear button should appear on the right side of the text view

iosclearTextOnFocus bool #

If true, clears the text field automatically when editing begins

iosenablesReturnKeyAutomatically bool #

If true, the keyboard disables the return key when there is no text and automatically enables it when there is text. The default value is false.

ioskeyboardAppearance enum('default', 'light', 'dark') #

Determines the color of the keyboard.

androidnumberOfLines number #

Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.

iosonKeyPress function #

Callback that is called when a key is pressed. Pressed key value is passed as an argument to the callback handler.