Input#
The <Input>
component is used in a form in order to retrieve input from the user.
Import#
import { Input, InputField } from 'bumbag-native'
Usage#
Labels#
Fields#
You can also use the <InputField>
component, which internally has a FieldWrapper to wrap form controls such as labels, hint text and validation text.
It accepts a combination of Input props and FieldWrapper props.
Default values#
For uncontrolled inputs, set a default value using the defaultValue
prop.
Disabled#
Make the input disabled with the disabled
prop.
Sizes#
An input can come in different sizes - small
, medium
, large
, or the default.
Colors#
Input colors#
Placeholder colors#
Label colors#
States#
Icons#
Addons#
Controlled input#
Props#
Input Props#
accessibilityLabelledBy
string
iconAfter
string
Icon to place before the input.
iconAfterProps
{ top?: string | number | { [key: string]: string }; right?: string | number | { [key: string]: string }; bottom?: string | number | { [key: string]: string }; left?: string | number | { [key: string]: string }; color?: "default" | ... 6 more ... | ({ ... } & string); ... 589 more ...; useOriginalFill?: boolean...
iconBefore
string
Icon to place after the input.
iconBeforeProps
{ top?: string | number | { [key: string]: string }; right?: string | number | { [key: string]: string }; bottom?: string | number | { [key: string]: string }; left?: string | number | { [key: string]: string }; color?: "default" | ... 6 more ... | ({ ... } & string); ... 589 more ...; useOriginalFill?: boolean...
inputProps
{ top?: string | number | { [key: string]: string }; right?: string | number | { [key: string]: string }; bottom?: string | number | { [key: string]: string }; left?: string | number | { [key: string]: string }; color?: Flexible<Flexible<...>, string | ... 1 more ... | { ... }>; ... 652 more ...; size?: Flexibl...
inputRef
((instance: any) => void) | RefObject<any>
label
string
Label of the input.
labelTextColor
"default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {})
Label color of the input. Can be any color in your palette.
labelProps
any
palette
"default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {})
placeholderTextColor
"default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {})
Placeholder color of the input. Can be any color in your palette.
state
"default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {})
State of the input. Can be any color in your palette.
size
"default" | (string & {}) | "small" | "medium" | "large"
Alters the size of the input. Can be "small", "medium" or "large"
Inherits React Native's TextInput
props
allowFontScaling
boolean
Specifies whether fonts should scale to respect Text Size accessibility settings.
The default is true
.
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
autoCorrect
boolean
If false, disables auto-correct. The default value is true.
autoFocus
boolean
If true, focuses the input on componentDidMount. The default value is false.
blurOnSubmit
boolean
If true, the text field will blur when submitted. The default value is true.
caretHidden
boolean
If true, caret is hidden. The default value is false.
contextMenuHidden
boolean
If true, context menu is hidden. The default value is false.
defaultValue
string
Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you don't want to deal with listening to events and updating the value prop to keep the controlled state in sync.
editable
boolean
If false, text is not editable. The default value is true.
keyboardType
"default" | "url" | "numeric" | "email-address" | "phone-pad" | "number-pad" | "decimal-pad" | "visible-password" | "ascii-capable" | "numbers-and-punctuation" | "name-phone-pad" | "twitter" | "web-search"
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
maxLength
number
Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.
multiline
boolean
If true, the text input can be multiple lines. The default value is false.
onBlur
(e: NativeSyntheticEvent<TextInputFocusEventData>) => void
Callback that is called when the text input is blurred
onChange
(e: NativeSyntheticEvent<TextInputChangeEventData>) => void
Callback that is called when the text input's text changes.
onChangeText
(text: string) => void
Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler.
onContentSizeChange
(e: NativeSyntheticEvent<TextInputContentSizeChangeEventData>) => 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.
onEndEditing
(e: NativeSyntheticEvent<TextInputEndEditingEventData>) => void
Callback that is called when text input ends.
onFocus
(e: NativeSyntheticEvent<TextInputFocusEventData>) => void
Callback that is called when the text input is focused
onSelectionChange
(e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => void
Callback that is called when the text input selection is changed.
onSubmitEditing
(e: NativeSyntheticEvent<TextInputSubmitEditingEventData>) => void
Callback that is called when the text input's submit button is pressed.
onTextInput
(e: NativeSyntheticEvent<TextInputTextInputEventData>) => 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.
onScroll
(e: NativeSyntheticEvent<TextInputScrollEventData>) => 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.
onKeyPress
(e: NativeSyntheticEvent<TextInputKeyPressEventData>) => 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.
placeholder
string
The string that will be rendered before text input has been entered
returnKeyType
"next" | "previous" | "default" | "none" | "search" | "done" | "go" | "send" | "google" | "join" | "route" | "yahoo" | "emergency-call"
enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call') Determines how the return key should look.
secureTextEntry
boolean
If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.
selectTextOnFocus
boolean
If true, all text will automatically be selected on focus
selection
{ start: number; end?: number; }
The start and end of the text input's selection. Set start and end to the same value to position the cursor.
selectionColor
string | typeof OpaqueColorValue
The highlight (and cursor on ios) color of the text input
style
false | TextStyle | RegisteredStyle<TextStyle> | RecursiveArray<false | TextStyle | RegisteredStyle<TextStyle>>
Styles
textAlign
"right" | "left" | "center"
Align the input text to the left, center, or right sides of the input field.
testID
string
Used to locate this view in end-to-end tests
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.
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.
maxFontSizeMultiplier
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
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.
onLayout
(event: LayoutChangeEvent) => void
Invoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
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.
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).
nativeID
string
Used to reference react managed views from native code.
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.
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.
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.
focusable
boolean
Whether this View
should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
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.
isTVSelectable
boolean
(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
hasTVPreferredFocus
boolean
(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
tvParallaxProperties
{ enabled?: boolean; shiftDistanceX?: number; shiftDistanceY?: number; tiltAngle?: number; magnification?: number; pressMagnification?: number; pressDuration?: number; pressDelay?: number; }
(Apple TV only) Object with properties to control Apple TV parallax effects.
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.
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.
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.
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.
onStartShouldSetResponder
(event: GestureResponderEvent) => boolean
Does this view want to become responder on the start of a touch?
onMoveShouldSetResponder
(event: GestureResponderEvent) => boolean
Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onResponderEnd
(event: GestureResponderEvent) => void
If the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant
(event: GestureResponderEvent) => void
The View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject
(event: GestureResponderEvent) => void
Something else is the responder right now and will not release it
onResponderMove
(event: GestureResponderEvent) => void
The user is moving their finger
onResponderRelease
(event: GestureResponderEvent) => void
Fired at the end of the touch, ie "touchUp"
onResponderStart
(event: GestureResponderEvent) => void
onResponderTerminationRequest
(event: GestureResponderEvent) => boolean
Something else wants to become responder. Should this view release the responder? Returning true allows release
onResponderTerminate
(event: GestureResponderEvent) => 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)
onStartShouldSetResponderCapture
(event: GestureResponderEvent) => 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.
onMoveShouldSetResponderCapture
(event: GestureResponderEvent) => 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.
onTouchStart
(event: GestureResponderEvent) => void
onTouchMove
(event: GestureResponderEvent) => void
onTouchEnd
(event: GestureResponderEvent) => void
onTouchCancel
(event: GestureResponderEvent) => void
onTouchEndCapture
(event: GestureResponderEvent) => void
accessible
boolean
When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
accessibilityActions
readonly Readonly<{ name: string; label?: string; }>[]
Provides an array of custom actions available for accessibility.
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.
accessibilityRole
"none" | "text" | "search" | "button" | "link" | "menu" | "alert" | "checkbox" | "radio" | "image" | "keyboardkey" | "adjustable" | "imagebutton" | "header" | "summary" | "combobox" | ... 10 more ... | "toolbar"
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
accessibilityState
AccessibilityState
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
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.
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).
onAccessibilityAction
(event: AccessibilityActionEvent) => void
When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
accessibilityLiveRegion
"none" | "assertive" | "polite"
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.
importantForAccessibility
"auto" | "yes" | "no" | "no-hide-descendants"
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.
accessibilityElementsHidden
boolean
A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.
accessibilityViewIsModal
boolean
A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
onAccessibilityEscape
() => void
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
onAccessibilityTap
() => void
When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
onMagicTap
() => void
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
accessibilityIgnoresInvertColors
boolean
https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios
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
clearTextOnFocus
boolean
If true, clears the text field automatically when editing begins
dataDetectorTypes
"none" | "all" | "link" | "phoneNumber" | "address" | "calendarEvent" | 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'
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.
keyboardAppearance
"default" | "light" | "dark"
Determines the color of the keyboard.
passwordRules
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;"
rejectResponderTermination
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).
selectionState
DocumentSelectionState
See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
spellCheck
boolean
If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect
textContentType
"none" | "name" | "location" | "URL" | "addressCity" | "addressCityAndState" | "addressState" | "countryName" | "creditCardNumber" | "emailAddress" | "familyName" | "fullStreetAddress" | ... 15 more ... | "oneTimeCode"
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.
For iOS 12+ newPassword
can be used to indicate a new password input the
user may want to save in the keychain, and oneTimeCode
can be used to indicate
that a field can be autofilled by a code arriving in an SMS.
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'
'newPassword'
'oneTimeCode'
scrollEnabled
boolean
If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true}
autoCompleteType
"off" | "tel" | "email" | "name" | "username" | "password" | "cc-csc" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-number" | "postal-code" | "street-address"
Determines which content to suggest on auto complete, e.g.username
.
To disable auto complete, use off
.
Android Only
The following values work on Android only:
username
password
email
name
tel
street-address
postal-code
cc-number
cc-csc
cc-exp
cc-exp-month
cc-exp-year
off
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 decideno
- not important for autofillnoExcludeDescendants
- this view and its children aren't important for autofillyes
- is important for autofillyesExcludeDescendants
- this view is important for autofill but its children aren't
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.
inlineImageLeft
string
If defined, the provided image resource will be rendered on the left.
inlineImagePadding
number
Padding between the inline image, if any, and the text input itself.
numberOfLines
number
Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.
returnKeyLabel
string
Sets the return key to the label. Use it instead of returnKeyType
.
textBreakStrategy
"simple" | "highQuality" | "balanced"
Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced The default value is simple.
underlineColorAndroid
string | typeof OpaqueColorValue
The color of the textInput underline.
textAlignVertical
"auto" | "top" | "bottom" | "center"
Vertically align text when multiline
is set to true
showSoftInputOnFocus
boolean
When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true
Inherits Box
props
animated
boolean
children
string | number | boolean | {} | ReactElement<any, string | ((props: any) => ReactElement<any, string | ... | (new (props: any) => Component<any, any, any>)>) | (new (props: any) => Component<...>)> | ReactNodeArray | ReactPortal | ((props: BoxProps) => ReactNode)
alignX
"right" | "left" | "center"
alignY
"top" | "bottom" | "center"
altitude
string
variant
string
colorMode
string
disabled
boolean
overrides
{ altitudes?: AltitudesThemeConfig; borders?: BordersThemeConfig; borderRadii?: BorderRadiiThemeConfig; breakpoints?: { ... }; ... 39 more ...; ToastManager?: ToastManagerThemeConfig; }
elementRef
((instance: any) => void) | RefObject<any>
themeKey
string
Inherits React Native's View
props
Theming#
Input#
Input.styles.base
Input.styles.disabled
Input.styles.sizes.small
Input.styles.sizes.default
Input.styles.sizes.medium
Input.styles.sizes.large
Input.LabelWrapper.styles.base
Input.Label.styles.base