KeyboardOptions
Kotlin
|Java
@Immutable class KeyboardOptions
| kotlin.Any | |
| ↳ | androidx.compose.foundation.text.KeyboardOptions |
The keyboard configuration options for TextFields. It is not guaranteed if software keyboard will comply with the options provided here.
Summary
| Public constructors | |
|---|---|
<init>(capitalization: KeyboardCapitalization = KeyboardCapitalization.None, autoCorrect: Boolean = true, keyboardType: KeyboardType = KeyboardType.Text, imeAction: ImeAction = ImeAction.Default)The keyboard configuration options for TextFields. |
|
| Public methods | |
|---|---|
| KeyboardOptions |
copy(capitalization: KeyboardCapitalization = this.capitalization, autoCorrect: Boolean = this.autoCorrect, keyboardType: KeyboardType = this.keyboardType, imeAction: ImeAction = this.imeAction) |
| Boolean | |
| Int |
hashCode() |
| String |
toString() |
| Properties | |
|---|---|
| Boolean |
informs the keyboard whether to enable auto correct. |
| KeyboardCapitalization |
informs the keyboard whether to automatically capitalize characters, words or sentences. |
| ImeAction |
The IME action. |
| KeyboardType |
The keyboard type to be used in this text field. |
| Companion properties | |
|---|---|
| KeyboardOptions |
Default KeyboardOptions. |
Public constructors
<init>
KeyboardOptions(
capitalization: KeyboardCapitalization = KeyboardCapitalization.None,
autoCorrect: Boolean = true,
keyboardType: KeyboardType = KeyboardType.Text,
imeAction: ImeAction = ImeAction.Default)
The keyboard configuration options for TextFields. It is not guaranteed if software keyboard will comply with the options provided here.
| Parameters | |
|---|---|
| capitalization: KeyboardCapitalization = KeyboardCapitalization.None | informs the keyboard whether to automatically capitalize characters, words or sentences. Only applicable to only text based KeyboardTypes such as KeyboardType.Text, KeyboardType.Ascii. It will not be applied to KeyboardTypes such as KeyboardType.Number. |
| autoCorrect: Boolean = true | informs the keyboard whether to enable auto correct. Only applicable to text based KeyboardTypes such as KeyboardType.Email, KeyboardType.Uri. It will not be applied to KeyboardTypes such as KeyboardType.Number. Most of keyboard implementations ignore this value for KeyboardTypes such as KeyboardType.Text. |
| keyboardType: KeyboardType = KeyboardType.Text | The keyboard type to be used in this text field. Note that this input type is honored by keyboard and shows corresponding keyboard but this is not guaranteed. For example, some keyboards may send non-ASCII character even if you set KeyboardType.Ascii. |
| imeAction: ImeAction = ImeAction.Default | The IME action. This IME action is honored by keyboard and may show specific icons on the keyboard. For example, search icon may be shown if ImeAction.Search is specified. When ImeOptions.singleLine is false, the keyboard might show return key rather than the action requested here. |
Public methods
copy
fun copy(
capitalization: KeyboardCapitalization = this.capitalization,
autoCorrect: Boolean = this.autoCorrect,
keyboardType: KeyboardType = this.keyboardType,
imeAction: ImeAction = this.imeAction
): KeyboardOptions
hashCode
fun hashCode(): Int