Properties for the CrossEditor component. Supports masking through maskProps. This allows getting the masked value.

The `onChangeText` event will isntead export the raw value.

Inherits react-native-paper TextInputProps

### Hierarchy

- TextInputProps
  - ICrossEditorProps

## Index

### Properties

- accessibilityActions
- accessibilityComponentType
- accessibilityElementsHidden
- accessibilityLabel
- accessibilityLiveRegion
- accessibilityTraits
- accessibilityViewIsModal
- accessible
- allowFontScaling
- autoCapitalize
- autoCorrect
- autoFocus
- blurOnSubmit
- caretHidden
- clearButtonMode
- clearTextOnFocus
- collapsable
- contextMenuHidden
- dataDetectorTypes
- defaultValue
- disableFullscreenUI
- disabled
- editable
- enablesReturnKeyAutomatically
- error
- hitSlop
- importantForAccessibility
- inlineImageLeft
- inlineImagePadding
- inputAccessoryViewID
- keyboardAppearance
- keyboardType
- label
- maskProps
- maxLength
- mode
- multiline
- needsOffscreenAlphaCompositing
- numberOfLines
- onAccessibilityAction
- onAccessibilityTap
- onBlur
- onChange
- onChangeText
- onContentSizeChange
- onEndEditing
- onFocus
- onKeyPress
- onLayout
- onMagicTap
- onMoveShouldSetResponder
- onMoveShouldSetResponderCapture
- onResponderEnd
- onResponderGrant
- onResponderMove
- onResponderReject
- onResponderRelease
- onResponderStart
- onResponderTerminate
- onResponderTerminationRequest
- onScroll
- onSelectionChange
- onStartShouldSetResponder
- onStartShouldSetResponderCapture
- onSubmitEditing
- onTouchCancel
- onTouchEnd
- onTouchEndCapture
- onTouchMove
- onTouchStart
- placeholder
- placeholderTextColor
- pointerEvents
- removeClippedSubviews
- render
- renderToHardwareTextureAndroid
- returnKeyLabel
- returnKeyType
- secureTextEntry
- selectTextOnFocus
- selection
- selectionColor
- selectionState
- shouldRasterizeIOS
- spellCheck
- style
- testID
- textBreakStrategy
- textContentType
- theme
- underlineColor
- underlineColorAndroid
- value

## Properties

### Optional accessibilityActions

accessibilityActions: Array<string>

Inherited from ViewPropsIOS.accessibilityActions

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1769

Provides an array of custom actions available for accessibility.

platform

  ios

### Optional accessibilityComponentType

accessibilityComponentType: "none" | "button" | "radiobutton_checked" | "radiobutton_unchecked"

Inherited from AccessibilityPropsAndroid.accessibilityComponentType

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1857

In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.

platform

  android

### Optional accessibilityElementsHidden

accessibilityElementsHidden: undefined | false | true

Inherited from AccessibilityPropsIOS.accessibilityElementsHidden

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1887

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

platform

  ios

### Optional accessibilityLabel

accessibilityLabel: undefined | string

Inherited from AccessibilityProps.accessibilityLabel

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1846

Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.

### Optional accessibilityLiveRegion

accessibilityLiveRegion: "none" | "polite" | "assertive"

Inherited from AccessibilityPropsAndroid.accessibilityLiveRegion

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1865

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.

platform

  android

### Optional accessibilityTraits

accessibilityTraits: AccessibilityTrait | AccessibilityTrait[]

Inherited from AccessibilityPropsIOS.accessibilityTraits

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1894

Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.

platform

  ios

### Optional accessibilityViewIsModal

accessibilityViewIsModal: undefined | false | true

Inherited from ViewPropsIOS.accessibilityViewIsModal

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1763

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

platform

  ios

### Optional accessible

accessible: undefined | false | true

Inherited from AccessibilityProps.accessible

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1840

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

### Optional allowFontScaling

allowFontScaling: undefined | false | true

Inherited from TextInputProps.allowFontScaling

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1205

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

### Optional autoCapitalize

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

Inherited from TextInputProps.autoCapitalize

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1216

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

https://facebook.github.io/react-native/docs/textinput.html#autocapitalize

### Optional autoCorrect

autoCorrect: undefined | false | true

Inherited from TextInputProps.autoCorrect

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1222

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

### Optional autoFocus

autoFocus: undefined | false | true

Inherited from TextInputProps.autoFocus

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1228

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

### Optional blurOnSubmit

blurOnSubmit: undefined | false | true

Inherited from TextInputProps.blurOnSubmit

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1234

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

### Optional caretHidden

caretHidden: undefined | false | true

Inherited from TextInputProps.caretHidden

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1239

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

### Optional clearButtonMode

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

Inherited from TextInputIOSProps.clearButtonMode

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:972

enum('never', 'while-editing', 'unless-editing', 'always') When the clear button should appear on the right side of the text view

### Optional clearTextOnFocus

clearTextOnFocus: undefined | false | true

Inherited from TextInputIOSProps.clearTextOnFocus

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:977

If true, clears the text field automatically when editing begins

### Optional collapsable

collapsable: undefined | false | true

Inherited from ViewPropsAndroid.collapsable

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1797

Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.

### Optional contextMenuHidden

contextMenuHidden: undefined | false | true

Inherited from TextInputProps.contextMenuHidden

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1244

If true, context menu is hidden. The default value is false.

### Optional dataDetectorTypes

dataDetectorTypes: DataDetectorTypes | DataDetectorTypes[]

Inherited from TextInputIOSProps.dataDetectorTypes

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:995

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.

You can provide one type or an array of many types.

Possible values for `dataDetectorTypes` are:

- `'phoneNumber'`
- `'link'`
- `'address'`
- `'calendarEvent'`
- `'none'`
- `'all'`

### Optional defaultValue

defaultValue: undefined | string

Inherited from TextInputProps.defaultValue

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1251

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.

### Optional disableFullscreenUI

disableFullscreenUI: undefined | false | true

Inherited from TextInputAndroidProps.disableFullscreenUI

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1078

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. When true, this feature is disabled and users will always edit the text directly inside of the text input. Defaults to false.

### Optional disabled

disabled: undefined | false | true

Inherited from TextInputProps.disabled

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:7

### Optional editable

editable: undefined | false | true

Inherited from TextInputProps.editable

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1256

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

### Optional enablesReturnKeyAutomatically

enablesReturnKeyAutomatically: undefined | false | true

Inherited from TextInputIOSProps.enablesReturnKeyAutomatically

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1001

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.

### Optional error

error: boolean | undefined

Overrides TextInputProps.error

- Defined in components/input/CrossEditor.tsx:22

`True` to use error styling https://callstack.github.io/react-native-paper/text-input.html

### Optional hitSlop

hitSlop: Insets

Inherited from ViewProps.hitSlop

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1943

This defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.

### Optional importantForAccessibility

importantForAccessibility: "auto" | "yes" | "no" | "no-hide-descendants"

Inherited from AccessibilityPropsAndroid.importantForAccessibility

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1878

Controls how view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.

Possible values: 'auto' - The system determines whether the view is important for accessibility - default (recommended). 'yes' - The view is important for accessibility. 'no' - The view is not important for accessibility. 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.

### Optional inlineImageLeft

inlineImageLeft: undefined | string

Inherited from TextInputAndroidProps.inlineImageLeft

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1083

If defined, the provided image resource will be rendered on the left.

### Optional inlineImagePadding

inlineImagePadding: undefined | number

Inherited from TextInputAndroidProps.inlineImagePadding

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1088

Padding between the inline image, if any, and the text input itself.

### Optional inputAccessoryViewID

inputAccessoryViewID: undefined | string

Inherited from TextInputProps.inputAccessoryViewID

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1396

Used to connect to an InputAccessoryView. Not part of react-natives documentation, but present in examples and code. See https://facebook.github.io/react-native/docs/inputaccessoryview.html for more information.

### Optional keyboardAppearance

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

Inherited from TextInputIOSProps.keyboardAppearance

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1006

Determines the color of the keyboard.

### Optional keyboardType

keyboardType: KeyboardTypeOptions

Inherited from TextInputProps.keyboardType

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1266

enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search', 'visible-password') Determines which keyboard to open, e.g.numeric. The following values work across platforms: - default - numeric - email-address - phone-pad The following values work on iOS: - ascii-capable - numbers-and-punctuation - url - number-pad - name-phone-pad - decimal-pad - twitter - web-search The following values work on Android: - visible-password

### label

label: string

Overrides TextInputProps.label

- Defined in components/input/CrossEditor.tsx:17

Text for floating label https://callstack.github.io/react-native-paper/text-input.html

### Optional maskProps

maskProps: TextInputMaskProps | undefined

- Defined in components/input/CrossEditor.tsx:40

Allows masking the input.

https://github.com/benhurott/react-native-masked-text

example

      <CrossEditor
      label='Mobile'
      maskProps={{ type: 'cel-phone' }} />

### Optional maxLength

maxLength: undefined | number

Inherited from TextInputProps.maxLength

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1272

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

### Optional mode

mode: "flat" | "outlined" | undefined

Overrides TextInputProps.mode

- Defined in components/input/CrossEditor.tsx:28

Visual appearence. Default value is 'outlined'

https://callstack.github.io/react-native-paper/text-input.html

### Optional multiline

multiline: undefined | false | true

Inherited from TextInputProps.multiline

Overrides TextInputProps.multiline

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:13

### Optional needsOffscreenAlphaCompositing

needsOffscreenAlphaCompositing: undefined | false | true

Inherited from ViewPropsAndroid.needsOffscreenAlphaCompositing

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1813

Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).

Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.

### Optional numberOfLines

numberOfLines: undefined | number

Inherited from TextInputProps.numberOfLines

Overrides TextInputAndroidProps.numberOfLines

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:14

### Optional onAccessibilityAction

onAccessibilityAction: undefined | function

Inherited from ViewPropsIOS.onAccessibilityAction

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1776

When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action.

platform

  ios

### Optional onAccessibilityTap

onAccessibilityTap: undefined | function

Inherited from AccessibilityPropsIOS.onAccessibilityTap

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1900

When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture.

platform

  ios

### Optional onBlur

onBlur: undefined | function

Inherited from TextInputProps.onBlur

Overrides TextInputProps.onBlur

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:16

### Optional onChange

onChange: undefined | function

Inherited from TextInputProps.onChange

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1287

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

### Optional onChangeText

onChangeText: undefined | function

Inherited from TextInputProps.onChangeText

Overrides TextInputProps.onChangeText

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:11

### Optional onContentSizeChange

onContentSizeChange: undefined | function

Inherited from TextInputProps.onContentSizeChange

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1302

Callback that is called when the text input's content size changes. This will be called with `{ nativeEvent: { contentSize: { width, height } } }`.

Only called for multiline text inputs.

### Optional onEndEditing

onEndEditing: undefined | function

Inherited from TextInputProps.onEndEditing

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1307

Callback that is called when text input ends.

### Optional onFocus

onFocus: undefined | function

Inherited from TextInputProps.onFocus

Overrides TextInputProps.onFocus

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:15

### Optional onKeyPress

onKeyPress: undefined | function

Inherited from TextInputProps.onKeyPress

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1341

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. Note: on Android only the inputs from soft keyboard are handled, not the hardware keyboard inputs.

### Optional onLayout

onLayout: undefined | function

Inherited from ViewProps.onLayout

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1950

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

### Optional onMagicTap

onMagicTap: undefined | function

Inherited from AccessibilityPropsIOS.onMagicTap

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1906

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

platform

  ios

### Optional onMoveShouldSetResponder

onMoveShouldSetResponder: undefined | function

Inherited from GestureResponderHandlers.onMoveShouldSetResponder

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1637

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

### Optional onMoveShouldSetResponderCapture

onMoveShouldSetResponderCapture: undefined | function

Inherited from GestureResponderHandlers.onMoveShouldSetResponderCapture

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1713

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.

### Optional onResponderEnd

onResponderEnd: undefined | function

Inherited from GestureResponderHandlers.onResponderEnd

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1643

If the View returns true and attempts to become the responder, one of the following will happen:

### Optional onResponderGrant

onResponderGrant: undefined | function

Inherited from GestureResponderHandlers.onResponderGrant

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1649

The View is now responding for touch events. This is the time to highlight and show the user what is happening

### Optional onResponderMove

onResponderMove: undefined | function

Inherited from GestureResponderHandlers.onResponderMove

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1663

The user is moving their finger

### Optional onResponderReject

onResponderReject: undefined | function

Inherited from GestureResponderHandlers.onResponderReject

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1654

Something else is the responder right now and will not release it

### Optional onResponderRelease

onResponderRelease: undefined | function

Inherited from GestureResponderHandlers.onResponderRelease

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1668

Fired at the end of the touch, ie "touchUp"

### Optional onResponderStart

onResponderStart: undefined | function

Inherited from GestureResponderHandlers.onResponderStart

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1670

### Optional onResponderTerminate

onResponderTerminate: undefined | function

Inherited from GestureResponderHandlers.onResponderTerminate

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1683

The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)

### Optional onResponderTerminationRequest

onResponderTerminationRequest: undefined | function

Inherited from GestureResponderHandlers.onResponderTerminationRequest

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1676

Something else wants to become responder. Should this view release the responder? Returning true allows release

### Optional onScroll

onScroll: undefined | function

Inherited from TextInputProps.onScroll

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1330

Invoked on content scroll with `{ nativeEvent: { contentOffset: { x, y } } }`.

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

### Optional onSelectionChange

onSelectionChange: undefined | function

Inherited from TextInputProps.onSelectionChange

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1317

Callback that is called when the text input selection is changed.

### Optional onStartShouldSetResponder

onStartShouldSetResponder: undefined | function

Inherited from GestureResponderHandlers.onStartShouldSetResponder

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1632

Does this view want to become responder on the start of a touch?

### Optional onStartShouldSetResponderCapture

onStartShouldSetResponderCapture: undefined | function

Inherited from GestureResponderHandlers.onStartShouldSetResponderCapture

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1698

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.

### Optional onSubmitEditing

onSubmitEditing: undefined | function

Inherited from TextInputProps.onSubmitEditing

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1322

Callback that is called when the text input's submit button is pressed.

### Optional onTouchCancel

onTouchCancel: undefined | function

Inherited from Touchable.onTouchCancel

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:449

### Optional onTouchEnd

onTouchEnd: undefined | function

Inherited from Touchable.onTouchEnd

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:448

### Optional onTouchEndCapture

onTouchEndCapture: undefined | function

Inherited from Touchable.onTouchEndCapture

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:450

### Optional onTouchMove

onTouchMove: undefined | function

Inherited from Touchable.onTouchMove

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:447

### Optional onTouchStart

onTouchStart: undefined | function

Inherited from Touchable.onTouchStart

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:446

### Optional placeholder

placeholder: undefined | string

Inherited from TextInputProps.placeholder

Overrides TextInputProps.placeholder

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:9

### Optional placeholderTextColor

placeholderTextColor: undefined | string

Inherited from TextInputProps.placeholderTextColor

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1351

The text color of the placeholder string

### Optional pointerEvents

pointerEvents: "box-none" | "none" | "box-only" | "auto"

Inherited from ViewProps.pointerEvents

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1975

In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:

.box-none { pointer-events: none; } .box-none * { pointer-events: all; }

box-only is the equivalent of

.box-only { pointer-events: all; } .box-only * { pointer-events: none; }

But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.

### Optional removeClippedSubviews

removeClippedSubviews: undefined | false | true

Inherited from ViewProps.removeClippedSubviews

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1983

This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

### Optional render

render: undefined | function

Inherited from TextInputProps.render

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:17

### Optional renderToHardwareTextureAndroid

renderToHardwareTextureAndroid: undefined | false | true

Inherited from ViewPropsAndroid.renderToHardwareTextureAndroid

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1822

Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.

On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

### Optional returnKeyLabel

returnKeyLabel: undefined | string

Inherited from TextInputAndroidProps.returnKeyLabel

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1100

Sets the return key to the label. Use it instead of `returnKeyType`.

platform

  android

### Optional returnKeyType

returnKeyType: ReturnKeyTypeOptions

Inherited from TextInputProps.returnKeyType

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1357

enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') Determines how the return key should look.

### Optional secureTextEntry

secureTextEntry: undefined | false | true

Inherited from TextInputProps.secureTextEntry

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1363

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 | false | true

Inherited from TextInputProps.selectTextOnFocus

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1368

If true, all text will automatically be selected on focus

### Optional selection

selection: undefined | object

Inherited from TextInputProps.selection

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1374

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: undefined | string

Inherited from TextInputProps.selectionColor

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1379

The highlight (and cursor on ios) color of the text input

### Optional selectionState

selectionState: DocumentSelectionState

Inherited from TextInputIOSProps.selectionState

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1011

See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document

### Optional shouldRasterizeIOS

shouldRasterizeIOS: undefined | false | true

Inherited from ViewPropsIOS.shouldRasterizeIOS

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1788

Whether this view should be rendered as a bitmap before compositing.

On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.

Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.

### Optional spellCheck

spellCheck: undefined | false | true

Inherited from TextInputIOSProps.spellCheck

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1016

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

### Optional style

style: any

Inherited from TextInputProps.style

Overrides TextInputProps.style

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:19

### Optional testID

testID: undefined | string

Inherited from TextInputProps.testID

Overrides ViewProps.testID

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1389

Used to locate this view in end-to-end tests

### Optional textBreakStrategy

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

Inherited from TextInputAndroidProps.textBreakStrategy

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1106

Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced The default value is simple.

### Optional textContentType

textContentType: "none" | "URL" | "addressCity" | "addressCityAndState" | "addressState" | "countryName" | "creditCardNumber" | "emailAddress" | "familyName" | "fullStreetAddress" | "givenName" | "jobTitle" | "location" | "middleName" | "name" | "namePrefix" | "nameSuffix" | "nickname" | "organizationName" | "postalCode" | "streetAddressLine1" | "streetAddressLine2" | "sublocality" | "telephoneNumber" | "username" | "password"

Inherited from TextInputIOSProps.textContentType

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1058

Give the keyboard and the system information about the expected semantic meaning for the content that users enter.

For iOS 11+ you can set `textContentType` to `username` or `password` to enable autofill of login details from the device keychain.

To disable autofill, set textContentType to `none`.

Possible values for `textContentType` are:

- `'none'`
- `'URL'`
- `'addressCity'`
- `'addressCityAndState'`
- `'addressState'`
- `'countryName'`
- `'creditCardNumber'`
- `'emailAddress'`
- `'familyName'`
- `'fullStreetAddress'`
- `'givenName'`
- `'jobTitle'`
- `'location'`
- `'middleName'`
- `'name'`
- `'namePrefix'`
- `'nameSuffix'`
- `'nickname'`
- `'organizationName'`
- `'postalCode'`
- `'streetAddressLine1'`
- `'streetAddressLine2'`
- `'sublocality'`
- `'telephoneNumber'`
- `'username'`
- `'password'`

### Optional theme

theme: ThemeShape

Inherited from TextInputProps.theme

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:20

### Optional underlineColor

underlineColor: undefined | string

Inherited from TextInputProps.underlineColor

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:12

### Optional underlineColorAndroid

underlineColorAndroid: undefined | string

Inherited from TextInputAndroidProps.underlineColorAndroid

- Defined in /Users/thomas/Source/react-native-core/node_modules/@types/react-native/index.d.ts:1111

The color of the textInput underline.

### Optional value

value: undefined | string

Inherited from TextInputProps.value

Overrides TextInputProps.value

- Defined in /Users/thomas/Source/react-native-core/node_modules/react-native-paper/typings/components/TextInput.d.ts:18