TextField

@shopify/shop-minis-platform-sdk / components/TextField/TextField

TextFieldProps

Extends

• ComponentProps\<typeof TextInput>

Properties

accessibilityActions?

optional accessibilityActions: readonly Readonly\<object>[]

Provides an array of custom actions available for accessibility.

Inherited from

React.ComponentProps.accessibilityActions

accessibilityElementsHidden?

optional accessibilityElementsHidden: boolean

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

Platform

ios

Inherited from

React.ComponentProps.accessibilityElementsHidden

accessibilityHint?

optional accessibilityHint: string

An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

Inherited from

React.ComponentProps.accessibilityHint

accessibilityIgnoresInvertColors?

optional accessibilityIgnoresInvertColors: boolean

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

Platform

ios

Inherited from

React.ComponentProps.accessibilityIgnoresInvertColors

accessibilityLabel?

optional accessibilityLabel: string

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.

Inherited from

React.ComponentProps.accessibilityLabel

accessibilityLabelledBy?

optional accessibilityLabelledBy: string | string[]

A reference to another element nativeID used to build complex forms. The value of accessibilityLabelledBy should match the nativeID of the related element.

Platform

android

Inherited from

React.ComponentProps.accessibilityLabelledBy

accessibilityLanguage?

optional accessibilityLanguage: string

By using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios

Platform

ios

Inherited from

React.ComponentProps.accessibilityLanguage

accessibilityLiveRegion?

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

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

Inherited from

React.ComponentProps.accessibilityLiveRegion

accessibilityRole?

optional accessibilityRole: AccessibilityRole

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

Inherited from

React.ComponentProps.accessibilityRole

accessibilityState?

optional accessibilityState: AccessibilityState

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

Inherited from

React.ComponentProps.accessibilityState

accessibilityValue?

optional accessibilityValue: AccessibilityValue

Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).

Inherited from

React.ComponentProps.accessibilityValue

accessibilityViewIsModal?

optional accessibilityViewIsModal: boolean

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

Platform

ios

Inherited from

React.ComponentProps.accessibilityViewIsModal

accessible?

optional accessible: boolean

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

Inherited from

React.ComponentProps.accessible

allowFontScaling?

optional allowFontScaling: boolean

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

Inherited from

React.ComponentProps.allowFontScaling

aria-busy?

optional aria-busy: boolean

alias for accessibilityState

see https://reactnative.dev/docs/accessibility#accessibilitystate

Inherited from

React.ComponentProps.aria-busy

aria-checked?

optional aria-checked: boolean | "mixed"

Inherited from

React.ComponentProps.aria-checked

aria-disabled?

optional aria-disabled: boolean

Inherited from

React.ComponentProps.aria-disabled

aria-expanded?

optional aria-expanded: boolean

Inherited from

React.ComponentProps.aria-expanded

aria-hidden?

optional aria-hidden: boolean

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

Inherited from

React.ComponentProps.aria-hidden

aria-label?

optional aria-label: string

Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424

Inherited from

React.ComponentProps.aria-label

aria-labelledby?

optional aria-labelledby: string

Represents the nativeID of the associated label text. When the assistive technology focuses on the component with this props, the text is read aloud.

Platform

android

Inherited from

React.ComponentProps.aria-labelledby

aria-live?

optional aria-live: "polite" | "assertive" | "off"

Inherited from

React.ComponentProps.aria-live

aria-modal?

optional aria-modal: boolean

Inherited from

React.ComponentProps.aria-modal

aria-selected?

optional aria-selected: boolean

Inherited from

React.ComponentProps.aria-selected

aria-valuemax?

optional aria-valuemax: number

Inherited from

React.ComponentProps.aria-valuemax

aria-valuemin?

optional aria-valuemin: number

Inherited from

React.ComponentProps.aria-valuemin

aria-valuenow?

optional aria-valuenow: number

Inherited from

React.ComponentProps.aria-valuenow

aria-valuetext?

optional aria-valuetext: string

Inherited from

React.ComponentProps.aria-valuetext

autoCapitalize?

optional autoCapitalize: "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

https://reactnative.dev/docs/textinput#autocapitalize

Inherited from

React.ComponentProps.autoCapitalize

autoComplete?

optional autoComplete: "email" | "name" | "off" | "password" | "tel" | "url" | "additional-name" | "address-line1" | "address-line2" | "birthdate-day" | "birthdate-full" | "birthdate-month" | "birthdate-year" | "cc-csc" | "cc-exp" | "cc-exp-day" | "cc-exp-month" | "cc-exp-year" | "cc-number" | "cc-name" | "cc-given-name" | "cc-middle-name" | "cc-family-name" | "cc-type" | "country" | "current-password" | "family-name" | "gender" | "given-name" | "honorific-prefix" | "honorific-suffix" | "name-family" | "name-given" | "name-middle" | "name-middle-initial" | "name-prefix" | "name-suffix" | "new-password" | "nickname" | "one-time-code" | "organization" | "organization-title" | "password-new" | "postal-address" | "postal-address-country" | "postal-address-extended" | "postal-address-extended-postal-code" | "postal-address-locality" | "postal-address-region" | "postal-code" | "street-address" | "sms-otp" | "tel-country-code" | "tel-national" | "tel-device" | "username" | "username-new"

Specifies autocomplete hints for the system, so it can provide autofill. On Android, the system will always attempt to offer autofill by using heuristics to identify the type of content. To disable autocomplete, set autoComplete to off.

The following values work across platforms:

• additional-name
• address-line1
• address-line2
• cc-number
• country
• current-password
• email
• family-name
• given-name
• honorific-prefix
• honorific-suffix
• name
• new-password
• off
• one-time-code
• postal-code
• street-address
• tel
• username

The following values work on iOS only:

• nickname
• organization
• organization-title
• url

The following values work on Android only:

• birthdate-day
• birthdate-full
• birthdate-month
• birthdate-year
• cc-csc
• cc-exp
• cc-exp-day
• cc-exp-month
• cc-exp-year
• gender
• name-family
• name-given
• name-middle
• name-middle-initial
• name-prefix
• name-suffix
• password
• password-new
• postal-address
• postal-address-country
• postal-address-extended
• postal-address-extended-postal-code
• postal-address-locality
• postal-address-region
• sms-otp
• tel-country-code
• tel-national
• tel-device
• username-new

Inherited from

React.ComponentProps.autoComplete

autoCorrect?

optional autoCorrect: boolean

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

Inherited from

React.ComponentProps.autoCorrect

autoFocus?

optional autoFocus: boolean

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

Inherited from

React.ComponentProps.autoFocus

blurOnSubmit?

optional blurOnSubmit: boolean

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

Inherited from

React.ComponentProps.blurOnSubmit

caretHidden?

optional caretHidden: boolean

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

Inherited from

React.ComponentProps.caretHidden

children?

optional children: ReactNode

Inherited from

React.ComponentProps.children

clearButtonMode?

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

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

Inherited from

React.ComponentProps.clearButtonMode

clearTextOnFocus?

optional clearTextOnFocus: boolean

If true, clears the text field automatically when editing begins

Inherited from

React.ComponentProps.clearTextOnFocus

collapsable?

optional collapsable: boolean

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.

Inherited from

React.ComponentProps.collapsable

containerStyle?

optional containerStyle: StyleProp\<ViewStyle>

Custom style for the surrounding box.

Example

<TextField {...} containerStyle={{borderColor: 'green'}} />

contextMenuHidden?

optional contextMenuHidden: boolean

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

Inherited from

React.ComponentProps.contextMenuHidden

cursorColor?

optional cursorColor: null | ColorValue

When provided it will set the color of the cursor (or "caret") in the component. Unlike the behavior of selectionColor the cursor color will be set independently from the color of the text selection box.

Platform

android

Inherited from

React.ComponentProps.cursorColor

dataDetectorTypes?

optional dataDetectorTypes: DataDetectorTypes | DataDetectorTypes[]

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'

Inherited from

React.ComponentProps.dataDetectorTypes

defaultValue?

optional 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.

Inherited from

React.ComponentProps.defaultValue

disabled?

optional disabled: boolean

If true, disables interactions for this component.

Example

<TextField {...} disabled />

disableFullscreenUI?

optional disableFullscreenUI: boolean

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.

Inherited from

React.ComponentProps.disableFullscreenUI

editable?

optional editable: boolean

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

Inherited from

React.ComponentProps.editable

enablesReturnKeyAutomatically?

optional enablesReturnKeyAutomatically: boolean

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.

Inherited from

React.ComponentProps.enablesReturnKeyAutomatically

enterKeyHint?

optional enterKeyHint: EnterKeyHintTypeOptions

Determines what text should be shown to the return key on virtual keyboards. Has precedence over the returnKeyType prop.

Inherited from

React.ComponentProps.enterKeyHint

error?

optional error: string

Text element placed bellow the TextField indicating errors.

Example

<TextField {...} error="Value cannot be empty" />

focusable?

optional focusable: boolean

Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

Inherited from

React.ComponentProps.focusable

handleFocus()?

optional handleFocus: () => void

Custom handler to be called when the user taps the TextField. If present the TextField becomes not editable.

Returns

void

Example

<TextField {...} handleFocus={openCountryPicker} />

hasTVPreferredFocus?

optional hasTVPreferredFocus: boolean

(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.

Platform

ios

Inherited from

React.ComponentProps.hasTVPreferredFocus

helper?

optional helper: string

Text element placed bellow the TextField with helping text.

Example

<TextField {...} helper="Optional" />

hitSlop?

optional hitSlop: Insets

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.

Inherited from

React.ComponentProps.hitSlop

id?

optional id: string

Used to reference react managed views from native code.

Inherited from

React.ComponentProps.id

importantForAccessibility?

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

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

Inherited from

React.ComponentProps.importantForAccessibility

importantForAutofill?

optional importantForAutofill: "auto" | "yes" | "no" | "noExcludeDescendants" | "yesExcludeDescendants"

Determines whether the individual fields in your app should be included in a view structure for autofill purposes on Android API Level 26+. Defaults to auto. To disable auto complete, use off.

Android Only

The following values work on Android only:

• auto - let Android decide
• no - not important for autofill
• noExcludeDescendants - this view and its children aren't important for autofill
• yes - is important for autofill
• yesExcludeDescendants - this view is important for autofill but its children aren't

Inherited from

React.ComponentProps.importantForAutofill

inlineImageLeft?

optional inlineImageLeft: string

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

Inherited from

React.ComponentProps.inlineImageLeft

inlineImagePadding?

optional inlineImagePadding: number

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

Inherited from

React.ComponentProps.inlineImagePadding

inputAccessoryViewID?

optional inputAccessoryViewID: string

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

Inherited from

React.ComponentProps.inputAccessoryViewID

inputMode?

optional inputMode: InputModeOptions

Works like the inputmode attribute in HTML, it determines which keyboard to open, e.g. numeric and has precedence over keyboardType.

Inherited from

React.ComponentProps.inputMode

isTVSelectable?

optional isTVSelectable: boolean

(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.

Platform

ios

Inherited from

React.ComponentProps.isTVSelectable

keyboardAppearance?

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

Determines the color of the keyboard.

Inherited from

React.ComponentProps.keyboardAppearance

keyboardType?

optional keyboardType: KeyboardTypeOptions

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

Inherited from

React.ComponentProps.keyboardType

leadingComponent?

optional leadingComponent: ReactNode

Element placed on the left of the text in the TextField.

Example

<TextField {...} leadingComponent={<CoolImage />} />

lineBreakStrategyIOS?

optional lineBreakStrategyIOS: "none" | "standard" | "hangul-word" | "push-out"

Set line break strategy on iOS.

Inherited from

React.ComponentProps.lineBreakStrategyIOS

maxFontSizeMultiplier?

optional maxFontSizeMultiplier: null | number

Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values:

• null/undefined (default): inherit from the parent node or the global default (0)
• 0: no max, ignore parent/global default

• = 1: sets the maxFontSizeMultiplier of this node to this value

Inherited from

React.ComponentProps.maxFontSizeMultiplier

maxLength?

optional maxLength: number

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

Inherited from

React.ComponentProps.maxLength

multiline?

optional multiline: boolean

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

Inherited from

React.ComponentProps.multiline

nativeID?

optional nativeID: string

Used to reference react managed views from native code.

Inherited from

React.ComponentProps.nativeID

needsOffscreenAlphaCompositing?

optional needsOffscreenAlphaCompositing: boolean

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.

Inherited from

React.ComponentProps.needsOffscreenAlphaCompositing

numberOfLines?

optional numberOfLines: number

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

Inherited from

React.ComponentProps.numberOfLines

onAccessibilityAction()?

optional onAccessibilityAction: (event) => void

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

Parameters

Parameter	Type
event	AccessibilityActionEvent

Returns

void

Inherited from

React.ComponentProps.onAccessibilityAction

onAccessibilityEscape()?

optional onAccessibilityEscape: () => void

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

Returns

void

Platform

ios

Inherited from

React.ComponentProps.onAccessibilityEscape

onAccessibilityTap()?

optional onAccessibilityTap: () => void

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

Returns

void

Platform

ios

Inherited from

React.ComponentProps.onAccessibilityTap

onBlur()?

optional onBlur: (e) => void

Callback that is called when the text input is blurred

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputFocusEventData>

Returns

void

Inherited from

React.ComponentProps.onBlur

onChange()?

optional onChange: (e) => void

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

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputChangeEventData>

Returns

void

Inherited from

React.ComponentProps.onChange

onChangeText()?

optional onChangeText: (text) => void

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

Parameters

Parameter	Type
text	string

Returns

void

Inherited from

React.ComponentProps.onChangeText

onContentSizeChange()?

optional onContentSizeChange: (e) => void

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.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputContentSizeChangeEventData>

Returns

void

Inherited from

React.ComponentProps.onContentSizeChange

onEndEditing()?

optional onEndEditing: (e) => void

Callback that is called when text input ends.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputEndEditingEventData>

Returns

void

Inherited from

React.ComponentProps.onEndEditing

onFocus()?

optional onFocus: (e) => void

Callback that is called when the text input is focused

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputFocusEventData>

Returns

void

Inherited from

React.ComponentProps.onFocus

onKeyPress()?

optional onKeyPress: (e) => void

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.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputKeyPressEventData>

Returns

void

Inherited from

React.ComponentProps.onKeyPress

onLayout()?

optional onLayout: (event) => void

Invoked on mount and layout changes with

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

Parameters

Parameter	Type
event	LayoutChangeEvent

Returns

void

Inherited from

React.ComponentProps.onLayout

onMagicTap()?

optional onMagicTap: () => void

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

Returns

void

Platform

ios

Inherited from

React.ComponentProps.onMagicTap

onMoveShouldSetResponder()?

optional onMoveShouldSetResponder: (event) => boolean

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

React.ComponentProps.onMoveShouldSetResponder

onMoveShouldSetResponderCapture()?

optional onMoveShouldSetResponderCapture: (event) => boolean

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.

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

React.ComponentProps.onMoveShouldSetResponderCapture

onPointerCancel()?

optional onPointerCancel: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerCancel

onPointerCancelCapture()?

optional onPointerCancelCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerCancelCapture

onPointerDown()?

optional onPointerDown: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerDown

onPointerDownCapture()?

optional onPointerDownCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerDownCapture

onPointerEnter()?

optional onPointerEnter: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerEnter

onPointerEnterCapture()?

optional onPointerEnterCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerEnterCapture

onPointerLeave()?

optional onPointerLeave: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerLeave

onPointerLeaveCapture()?

optional onPointerLeaveCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerLeaveCapture

onPointerMove()?

optional onPointerMove: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerMove

onPointerMoveCapture()?

optional onPointerMoveCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerMoveCapture

onPointerUp()?

optional onPointerUp: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerUp

onPointerUpCapture()?

optional onPointerUpCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

React.ComponentProps.onPointerUpCapture

onPressIn()?

optional onPressIn: (e) => void

Callback that is called when a touch is engaged.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<NativeTouchEvent>

Returns

void

Inherited from

React.ComponentProps.onPressIn

onPressOut()?

optional onPressOut: (e) => void

Callback that is called when a touch is released.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<NativeTouchEvent>

Returns

void

Inherited from

React.ComponentProps.onPressOut

onResponderEnd()?

optional onResponderEnd: (event) => void

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderEnd

onResponderGrant()?

optional onResponderGrant: (event) => void

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderGrant

onResponderMove()?

optional onResponderMove: (event) => void

The user is moving their finger

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderMove

onResponderReject()?

optional onResponderReject: (event) => void

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderReject

onResponderRelease()?

optional onResponderRelease: (event) => void

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderRelease

onResponderStart()?

optional onResponderStart: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderStart

onResponderTerminate()?

optional onResponderTerminate: (event) => void

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)

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onResponderTerminate

onResponderTerminationRequest()?

optional onResponderTerminationRequest: (event) => boolean

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

React.ComponentProps.onResponderTerminationRequest

onScroll()?

optional onScroll: (e) => void

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.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputScrollEventData>

Returns

void

Inherited from

React.ComponentProps.onScroll

onSelectionChange()?

optional onSelectionChange: (e) => void

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

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputSelectionChangeEventData>

Returns

void

Inherited from

React.ComponentProps.onSelectionChange

onStartShouldSetResponder()?

optional onStartShouldSetResponder: (event) => boolean

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

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

React.ComponentProps.onStartShouldSetResponder

onStartShouldSetResponderCapture()?

optional onStartShouldSetResponderCapture: (event) => boolean

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.

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

React.ComponentProps.onStartShouldSetResponderCapture

onSubmitEditing()?

optional onSubmitEditing: (e) => void

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

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputSubmitEditingEventData>

Returns

void

Inherited from

React.ComponentProps.onSubmitEditing

onTextInput()?

optional onTextInput: (e) => void

Callback that is called on new text input with the argument { nativeEvent: { text, previousText, range: { start, end } } }.

This prop requires multiline={true} to be set.

Parameters

Parameter	Type
e	NativeSyntheticEvent\<TextInputTextInputEventData>

Returns

void

Inherited from

React.ComponentProps.onTextInput

onTouchCancel()?

optional onTouchCancel: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onTouchCancel

onTouchEnd()?

optional onTouchEnd: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onTouchEnd

onTouchEndCapture()?

optional onTouchEndCapture: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onTouchEndCapture

onTouchMove()?

optional onTouchMove: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onTouchMove

onTouchStart()?

optional onTouchStart: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

React.ComponentProps.onTouchStart

paddingHorizontal?

optional paddingHorizontal: "s" | "section" | "auto" | "m" | "l" | "-xxxl" | "-xxl" | "-xl" | "-l" | "-m" | "-gutter" | "-section" | "-s" | "-xs-s" | "-xs" | "-xxs" | "-xxxs" | "none" | "xxxs" | "xxs" | "xs" | "xs-s" | "gutter" | "xl" | "xxl" | "xxxl"

Horizontal padding of the text inside the TextField.

Example

<TextField {...} paddingHorizontal="m" />

passwordRules?

optional passwordRules: null | string

Provide rules for your password. For example, say you want to require a password with at least eight characters consisting of a mix of uppercase and lowercase letters, at least one number, and at most two consecutive characters. "required: upper; required: lower; required: digit; max-consecutive: 2; minlength: 8;"

Inherited from

React.ComponentProps.passwordRules

placeholder?

optional placeholder: string

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

Inherited from

React.ComponentProps.placeholder

placeholderTextColor?

optional placeholderTextColor: ColorValue

The text color of the placeholder string

Inherited from

React.ComponentProps.placeholderTextColor

pointerEvents?

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

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.

Inherited from

React.ComponentProps.pointerEvents

pushTrailingComponent?

optional pushTrailingComponent: boolean

If true reduces the padding on the right of the trailingComponent.

Example

<TextField {...} pushTrailingComponent />

readOnly?

optional readOnly: boolean

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

Inherited from

React.ComponentProps.readOnly

rejectResponderTermination?

optional rejectResponderTermination: null | boolean

If true, allows TextInput to pass touch events to the parent component. This allows components to be swipeable from the TextInput on iOS, as is the case on Android by default. If false, TextInput always asks to handle the input (except when disabled).

Inherited from

React.ComponentProps.rejectResponderTermination

removeClippedSubviews?

optional removeClippedSubviews: boolean

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).

Inherited from

React.ComponentProps.removeClippedSubviews

renderToHardwareTextureAndroid?

optional renderToHardwareTextureAndroid: boolean

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.

Inherited from

React.ComponentProps.renderToHardwareTextureAndroid

returnKeyLabel?

optional returnKeyLabel: string

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

Platform

android

Inherited from

React.ComponentProps.returnKeyLabel

returnKeyType?

optional returnKeyType: ReturnKeyTypeOptions

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

Inherited from

React.ComponentProps.returnKeyType

role?

optional role: Role

Indicates to accessibility services to treat UI component like a specific role.

Inherited from

React.ComponentProps.role

scrollEnabled?

optional scrollEnabled: boolean

If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true}

Inherited from

React.ComponentProps.scrollEnabled

secureTextEntry?

optional secureTextEntry: boolean

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

Inherited from

React.ComponentProps.secureTextEntry

selection?

optional selection: object

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

end?

optional end: number

start

start: number

Inherited from

React.ComponentProps.selection

selectionColor?

optional selectionColor: ColorValue

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

Inherited from

React.ComponentProps.selectionColor

selectionState?

optional selectionState: DocumentSelectionState

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

Inherited from

React.ComponentProps.selectionState

selectTextOnFocus?

optional selectTextOnFocus: boolean

If true, all text will automatically be selected on focus

Inherited from

React.ComponentProps.selectTextOnFocus

shouldRasterizeIOS?

optional shouldRasterizeIOS: boolean

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.

Inherited from

React.ComponentProps.shouldRasterizeIOS

showSoftInputOnFocus?

optional showSoftInputOnFocus: boolean

When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true

Inherited from

React.ComponentProps.showSoftInputOnFocus

smartInsertDelete?

optional smartInsertDelete: boolean

If false, the iOS system will not insert an extra space after a paste operation neither delete one or two spaces after a cut or delete operation.

The default value is true.

Inherited from

React.ComponentProps.smartInsertDelete

spellCheck?

optional spellCheck: boolean

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

Inherited from

React.ComponentProps.spellCheck

style?

optional style: StyleProp\<TextStyle>

Styles

Inherited from

React.ComponentProps.style

testID?

optional testID: string

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

Inherited from

React.ComponentProps.testID

textAlign?

optional textAlign: "center" | "right" | "left"

Align the input text to the left, center, or right sides of the input field.

Inherited from

React.ComponentProps.textAlign

textAlignVertical?

optional textAlignVertical: "center" | "auto" | "top" | "bottom"

Vertically align text when multiline is set to true

Inherited from

React.ComponentProps.textAlignVertical

textBreakStrategy?

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

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

Inherited from

React.ComponentProps.textBreakStrategy

textContentType?

optional textContentType: "name" | "none" | "password" | "nickname" | "username" | "URL" | "addressCity" | "addressCityAndState" | "addressState" | "countryName" | "creditCardNumber" | "creditCardExpiration" | "creditCardExpirationMonth" | "creditCardExpirationYear" | "creditCardSecurityCode" | "creditCardType" | "creditCardName" | "creditCardGivenName" | "creditCardMiddleName" | "creditCardFamilyName" | "emailAddress" | "familyName" | "fullStreetAddress" | "givenName" | "jobTitle" | "location" | "middleName" | "namePrefix" | "nameSuffix" | "organizationName" | "postalCode" | "streetAddressLine1" | "streetAddressLine2" | "sublocality" | "telephoneNumber" | "newPassword" | "oneTimeCode" | "birthdate" | "birthdateDay" | "birthdateMonth" | "birthdateYear"

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

To disable autofill, set textContentType to none.

Possible values for textContentType are:

• 'none'
• 'URL'
• 'addressCity'
• 'addressCityAndState'
• 'addressState'
• 'countryName'
• 'creditCardNumber'
• 'creditCardExpiration' (iOS 17+)
• 'creditCardExpirationMonth' (iOS 17+)
• 'creditCardExpirationYear' (iOS 17+)
• 'creditCardSecurityCode' (iOS 17+)
• 'creditCardType' (iOS 17+)
• 'creditCardName' (iOS 17+)
• 'creditCardGivenName' (iOS 17+)
• 'creditCardMiddleName' (iOS 17+)
• 'creditCardFamilyName' (iOS 17+)
• 'emailAddress'
• 'familyName'
• 'fullStreetAddress'
• 'givenName'
• 'jobTitle'
• 'location'
• 'middleName'
• 'name'
• 'namePrefix'
• 'nameSuffix'
• 'nickname'
• 'organizationName'
• 'postalCode'
• 'streetAddressLine1'
• 'streetAddressLine2'
• 'sublocality'
• 'telephoneNumber'
• 'username'
• 'password'
• 'newPassword'
• 'oneTimeCode'
• 'birthdate' (iOS 17+)
• 'birthdateDay' (iOS 17+)
• 'birthdateMonth' (iOS 17+)
• 'birthdateYear' (iOS 17+)

Inherited from

React.ComponentProps.textContentType

trailingComponent?

optional trailingComponent: ReactNode

Element placed on the right of the text in the TextField.

Example

<TextField {...} trailingComponent={<CoolImage />} />

tvParallaxMagnification?

optional tvParallaxMagnification: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.

Platform

ios

Inherited from

React.ComponentProps.tvParallaxMagnification

tvParallaxProperties?

optional tvParallaxProperties: TVParallaxProperties

(Apple TV only) Object with properties to control Apple TV parallax effects.

Platform

ios

Inherited from

React.ComponentProps.tvParallaxProperties

tvParallaxShiftDistanceX?

optional tvParallaxShiftDistanceX: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.

Platform

ios

Inherited from

React.ComponentProps.tvParallaxShiftDistanceX

tvParallaxShiftDistanceY?

optional tvParallaxShiftDistanceY: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.

Platform

ios

Inherited from

React.ComponentProps.tvParallaxShiftDistanceY

tvParallaxTiltAngle?

optional tvParallaxTiltAngle: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.

Platform

ios

Inherited from

React.ComponentProps.tvParallaxTiltAngle

underlineColorAndroid?

optional underlineColorAndroid: ColorValue

The color of the textInput underline.

Inherited from

React.ComponentProps.underlineColorAndroid

value?

optional value: 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. For most uses this works great, but in some 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.

Inherited from

React.ComponentProps.value

verticalAlign?

optional verticalAlign: "auto" | "top" | "bottom" | "middle"

Vertically align text when multiline is set to true

Inherited from

React.ComponentProps.verticalAlign

---

TextField()

TextField(props): ReactNode

<TextField /> is a component to enables users to input different types of information. Validation should be handled outside of the component.

Some user information may be available without input such as email, name and telephone. See TextFieldAutofill for more information

Parameters

Parameter	Type
props	TextFieldProps & RefAttributes\<TextInput>

Returns

ReactNode