Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TextInputProperties

Indexable

[key: string]: any

key for others property.

Index

Properties

Optional allowFontScaling

allowFontScaling: undefined | true | false

Specifies whether fonts should scale to respect Text Size accessibility settings. The default is true. Specifies whether fonts should scale to respect Text Size accessibility settings. The default is true.

Optional autoCapitalize

autoCapitalize: "none" | "sentences" | "words" | "characters"

Can tell TextInput to automatically capitalize certain characters. Can tell TextInput to automatically capitalize certain characters.

Optional autoCorrect

autoCorrect: boolean | string

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

Optional autoFocus

autoFocus: undefined | true | false

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

Optional autoGrow

autoGrow: undefined | true | false

If true, will increase the height of the textbox if need be. If false, the textbox will become scrollable once the height is reached. The default value is false. It is android only If true, will increase the height of the textbox if need be. If false, the textbox will become scrollable once the height is reached. The default value is false. It is android only

Optional blurOnSubmit

blurOnSubmit: undefined | true | false

If true, the text field will blur when submitted. The default value is true for single-line fields and false for multiline fields If true, the text field will blur when submitted. The default value is true for single-line fields and false for multiline fields

Optional caretHidden

caretHidden: undefined | true | false

If true, caret is hidden. The default value is false. If true, caret is hidden. The default value is false.

Optional clear

clear: undefined | function

Removes all text from the TextInput. Removes all text from the TextInput.

Optional clearButtonMode

clearButtonMode: "never" | "while-editing" | "unless-editing" | "always"

Optional clearTextOnFocus

clearTextOnFocus: undefined | true | false

If true, clears the text field automatically when editing begins. It is for ios only If true, clears the text field automatically when editing begins. It is for ios only

Optional dataDetectorTypes

dataDetectorTypes: "phoneNumber" | "link" | "address" | "calendarEvent" | "none" | "all"

Determines the types of data converted to clickable URLs in the text input. Only valid if multiline={true} and editable={false}. By default no data types are detected. Determines the types of data converted to clickable URLs in the text input. Only valid if multiline={true} and editable={false}. By default no data types are detected.

Optional defaultValue

defaultValue: undefined | string

Provides an initial value that will change when the user starts typing Provides an initial value that will change when the user starts typing

Optional disableFullscreenUI

disableFullscreenUI: undefined | true | false

When false, if there is a small amount of space available around a text input (e.g. landscape orientation on a phone), the OS may choose to have the user edit the text inside of a full screen text input mode It is for android only When false, if there is a small amount of space available around a text input (e.g. landscape orientation on a phone), the OS may choose to have the user edit the text inside of a full screen text input mode It is for android only

Optional editable

editable: undefined | true | false

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

Optional enablesReturnKeyAutomatically

enablesReturnKeyAutomatically: undefined | true | false

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. It is for ios only 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. It is for ios only

Optional error

error: undefined | true | false

If true, Input shows error state with errorText, if provided. If true, Input shows error state with errorText, if provided.

Optional errorText

errorText: ReactNode

Text to show when error state is displayed. Text to show when error state is displayed.

Optional inlineImageLeft

inlineImageLeft: undefined | string

If defined, the provided image resource will be rendered on the left It is for android only If defined, the provided image resource will be rendered on the left It is for android only

Optional inlineImagePadding

inlineImagePadding: undefined | number

Padding between the inline image, if any, and the text input itself. It is for android only Padding between the inline image, if any, and the text input itself. It is for android only

Optional isFocused

isFocused: undefined | function

Returns true if the input is currently focused; false otherwise. Returns true if the input is currently focused; false otherwise.

Optional keyboardAppearance

keyboardAppearance: "default" | "light" | "dark"

Determines the color of the keyboard. It is for ios only Determines the color of the keyboard. It is for ios only

Optional keyboardType

keyboardType: "default" | "email-address" | "numeric" | "phone-pad" | "ascii-capable" | "numbers-and-punctuation" | "url" | "number-pad" | "name-phone-pad" | "decimal-pad" | "twitter" | "web-search" | "visible-password"

Determines which keyboard to open, e.g.numeric. visible-password is for android only Determines which keyboard to open, e.g.numeric. visible-password is for android only

Optional maxHeight

maxHeight: undefined | number

If autogrow is true, limits the height that the TextInput box can grow to. Once it reaches this height, the TextInput becomes scrollable. If autogrow is true, limits the height that the TextInput box can grow to. Once it reaches this height, the TextInput becomes scrollable.

Optional maxLength

maxLength: undefined | number

Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker. Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.

Optional multiline

multiline: undefined | true | false

If true, the text input can be multiple lines. The default value is false. If true, the text input can be multiple lines. The default value is false.

Optional numberOfLines

numberOfLines: undefined | number

Optional onBlur

onBlur: undefined | function

Callback that is called when the text input is blurred. Callback that is called when the text input is blurred.

Optional onChange

onChange: undefined | function

Callback that is called when the text input's text changes. Callback that is called when the text input's text changes.

Optional onChangeText

onChangeText: undefined | function

Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler. Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler.

Optional onContentSizeChange

onContentSizeChange: undefined | function

Callback that is called when the text input's content size changes Callback that is called when the text input's content size changes

Optional onEndEditing

onEndEditing: undefined | function

Callback that is called when text input ends. Callback that is called when text input ends.

Optional onFocus

onFocus: undefined | function

Callback that is called when the text input is focused. Callback that is called when the text input is focused.

Optional onKeyPress

onKeyPress: undefined | function

Callback that is called when a key is pressed. This will be called with { nativeEvent: { key: keyValue } } where keyValue is 'Enter' or 'Backspace' for respective keys and the typed-in character otherwise including ' ' for space. Fires before onChange callbacks It is for ios only Callback that is called when a key is pressed. This will be called with { nativeEvent: { key: keyValue } } where keyValue is 'Enter' or 'Backspace' for respective keys and the typed-in character otherwise including ' ' for space. Fires before onChange callbacks It is for ios only

Optional onLayout

onLayout: undefined | function

Invoked on mount and layout changes with {x, y, width, height}. Invoked on mount and layout changes with {x, y, width, height}.

Optional onScroll

onScroll: undefined | function

Invoked on content scroll.May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons. Invoked on content scroll.May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons.

Optional onSelectionChange

onSelectionChange: undefined | function

Callback that is called when the text input selection is changed. This will be called with { nativeEvent: { selection: { start, end } } }. Callback that is called when the text input selection is changed. This will be called with { nativeEvent: { selection: { start, end } } }.

Optional onSubmitEditing

onSubmitEditing: undefined | function

Callback that is called when the text input's submit button is pressed. Invalid if multiline={true} is specified. Callback that is called when the text input's submit button is pressed. Invalid if multiline={true} is specified.

Optional placeholder

placeholder: undefined | string

The string that will be rendered before text input has been entered. The string that will be rendered before text input has been entered.

Optional placeholderTextColor

placeholderTextColor: ColorProperties

The text color of the placeholder string. The text color of the placeholder string.

Optional returnKeyLabel

returnKeyLabel: undefined | string

Optional returnKeyType

returnKeyType: "done" | "go" | "next" | "search" | "send" | "none" | "previous" | "default" | "emergency-call" | "google" | "join" | "route" | "yahoo"

Determines how the return key should look. On Android you can also use returnKeyLabel Determines how the return key should look. On Android you can also use returnKeyLabel

Optional secureTextEntry

secureTextEntry: undefined | true | false

If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false. If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.

Optional selectTextOnFocus

selectTextOnFocus: undefined | true | false

If true, all text will automatically be selected on focus. If true, all text will automatically be selected on focus.

Optional selection

selection: undefined | object

The start and end of the text input's selection. Set start and end to the same value to position the cursor. The start and end of the text input's selection. Set start and end to the same value to position the cursor.

Optional selectionColor

selectionColor: ColorProperties

The highlight and cursor color of the text input. The highlight and cursor color of the text input.

Optional selectionState

An instance of DocumentSelectionState, this is some state that is responsible for maintaining selection information for a document. An instance of DocumentSelectionState, this is some state that is responsible for maintaining selection information for a document.

Optional spellCheck

spellCheck: undefined | true | false

If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect. If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect.

Optional style

style: undefined | object

It is used to style TextInput It is used to style TextInput

Optional textBreakStrategy

textBreakStrategy: "simple" | "highQuality" | "balanced"

Optional underlineColorAndroid

underlineColorAndroid: ColorProperties

Optional value

value: undefined | string

The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc