TextInput
TextInput is a native text field, single-line or multi-line. Bind its value to a variable, as you would an input on the web. The platform draws it, so it has the system keyboard, selection, autocorrect and autofill.
- Android
- iOS
<script lang="ts">
import { Screen, Text, TextInput, View } from 'expo-svelte';
let name = $state('');
</script>
<Screen title="Your name">
<View style={{ padding: 20, gap: 12 }}>
<TextInput
bind:value={name}
placeholder="Name"
placeholderTextColor="#9ca3af"
autoCapitalize="words"
accessibilityLabel="Name"
style={{ minHeight: 48, paddingHorizontal: 12, borderRadius: 12, borderWidth: 1, borderColor: '#d1d5db', fontSize: 16 }}
/>
<Text>{name === '' ? 'Nothing typed yet.' : `Hello, ${name}`}</Text>
</View>
</Screen>A TextInput has no border or padding of its own. Give it a style, and a minHeight of 48 so it's easy to tap.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
value |
string |
'' |
The text. Use bind:value to keep a variable and the field in step. |
onChangeText |
(text: string) => void |
Called on every edit, after the bound value is updated. |
|
onChange |
(event) => void |
Called on every edit before onChangeText, with event.nativeEvent.text and eventCount. It doesn't replace onChangeText or bind:value. |
|
placeholder |
string |
Shown while the field is empty. | |
placeholderTextColor |
string |
a grey of the mode | The placeholder's colour: without one, the system's placeholder grey on iOS and 40 % of the mode's text colour on Android. The typed text's is style.color, and without one it is the system's text colour in the app's light or dark mode, as a Text's. |
multiline |
boolean |
false |
Allows several lines. Return inserts a line break instead of submitting. |
maxLength |
number |
The most characters the field accepts. | |
editable |
boolean |
true |
false makes the field read-only. |
readOnly |
boolean |
The web's name: readOnly wins over editable. |
|
keyboardType |
'default' | 'email-address' | 'numeric' | 'phone-pad' | 'number-pad' | 'decimal-pad' | 'url' |
'default' |
Which keyboard opens. |
inputMode |
'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' |
The web's name for the keyboard. It wins over keyboardType, and 'none' opens no keyboard. |
|
secureTextEntry |
boolean |
false |
Hides the text, for passwords. |
autoCapitalize |
'none' | 'sentences' | 'words' | 'characters' |
'sentences' |
Which letters the keyboard capitalises. |
autoCorrect |
boolean |
true |
Autocorrect. Turn it off for email addresses and user names. |
autoComplete, textContentType |
string |
What the field holds ('email', 'current-password', 'new-password', 'one-time-code', 'off', ...), for autofill and password managers. As in React Native, autoComplete is Android's autofill hint and becomes textContentType on iOS; a textContentType you set wins there. |
|
returnKeyType |
'done' | 'go' | 'next' | 'search' | 'send' |
The label of the return key. | |
enterKeyHint |
'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send' |
The web's name for the return key. It wins over returnKeyType. |
|
selection |
{ start: number; end?: number } |
Selects that range, or puts the caret at start when there is no end. It applies when the field mounts and when selection changes. In between, the user moves the caret as usual. |
|
onSubmitEditing |
(event) => void |
The return key was pressed, in a single-line field. | |
onFocus, onBlur |
(event) => void |
The field gained or lost focus. | |
autoFocus |
boolean |
false |
Focuses the field, and opens the keyboard, when it mounts. |
ref |
(handle | null) => void |
Receives the field's handle. See ref. | |
style |
TextStyle |
Text style and layout. | |
class |
ClassValue |
A list of classes: a string, an array or an object, as on a DOM element in Svelte. Their style goes under style, which wins. Needs the css option (Classes). |
|
accessibilityLabel |
string |
What a screen reader calls the field. A placeholder isn't a label. |
It also takes the other props of React Native's TextInput. On Android the field doesn't send onContentSizeChange or onScroll yet, multiline or not: a composer that grows with its text gets its size from onLayout on Android.
ref
The handle has the methods of React Native's TextInput:
| Method | Description |
|---|---|
focus() |
Focuses the field and opens the keyboard. |
blur() |
Takes the focus away and closes the keyboard. |
measure(callback) |
As on a View. |
clear() isn't there: set the bound value to '' instead.
A form that moves from field to field when the user presses return:
svelte
<script lang="ts">
import { TextInput, View } from 'expo-svelte';
let email = $state('');
let password = $state('');
let passwordField: { focus(): void } | null = null;
function submit() {
console.log(email, password);
}
</script>
<View style={{ gap: 12 }}>
<TextInput
bind:value={email}
keyboardType="email-address"
autoCapitalize="none"
autoCorrect={false}
autoComplete="email"
returnKeyType="next"
onSubmitEditing={() => passwordField?.focus()}
placeholder="Email"
accessibilityLabel="Email"
/>
<TextInput
bind:value={password}
ref={(handle) => (passwordField = handle)}
secureTextEntry
autoComplete="password"
returnKeyType="done"
onSubmitEditing={submit}
placeholder="Password"
accessibilityLabel="Password"
/>
</View>Forms and the keyboard
- Put a form in a
KeyboardAvoidingViewso the keyboard doesn't cover the field being edited. - In a
ScrollView, setkeyboardShouldPersistTaps="handled": otherwise the first tap on a button while the keyboard is open only closes the keyboard. Keyboard.dismiss()fromexpo-svelte/platformcloses the keyboard from code.- A remote function's
formgives the props of a field to spread onto aTextInput: see loading data.