KeyboardOptions

val Default: KeyboardOptions

Default KeyboardOptions. Please see parameter descriptions for default values.

KeyboardOptions(
    capitalization: KeyboardCapitalization = KeyboardCapitalization.Unspecified,
    autoCorrect: Boolean,
    keyboardType: KeyboardType = KeyboardType.Unspecified,
    imeAction: ImeAction = ImeAction.Unspecified,
    platformImeOptions: PlatformImeOptions? = null,
    showKeyboardOnFocus: Boolean? = null,
    hintLocales: LocaleList? = null
)

KeyboardOptions(
    capitalization: KeyboardCapitalization = KeyboardCapitalization.Unspecified,
    autoCorrectEnabled: Boolean? = null,
    keyboardType: KeyboardType = KeyboardType.Unspecified,
    imeAction: ImeAction = ImeAction.Unspecified,
    platformImeOptions: PlatformImeOptions? = null,
    showKeyboardOnFocus: Boolean? = null,
    hintLocales: LocaleList? = null
)

fun copy(
    capitalization: KeyboardCapitalization = this.capitalization,
    autoCorrect: Boolean = this.autoCorrectOrDefault,
    keyboardType: KeyboardType = this.keyboardType,
    imeAction: ImeAction = this.imeAction,
    platformImeOptions: PlatformImeOptions? = this.platformImeOptions,
    showKeyboardOnFocus: Boolean? = this.showKeyboardOnFocusOrDefault,
    hintLocales: LocaleList? = this.hintLocales
): KeyboardOptions

fun copy(
    capitalization: KeyboardCapitalization = this.capitalization,
    autoCorrectEnabled: Boolean? = this.autoCorrectEnabled,
    keyboardType: KeyboardType = this.keyboardType,
    imeAction: ImeAction = this.imeAction,
    platformImeOptions: PlatformImeOptions? = this.platformImeOptions,
    showKeyboardOnFocus: Boolean? = null,
    hintLocales: LocaleList? = null
): KeyboardOptions

Returns a copy of this object with the values passed to this method.

Note that if an unspecified (null) value is passed explicitly to this method, it will replace any actually-specified value. This differs from the behavior of merge, which will never take an unspecified value over a specified one.

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

fun merge(other: KeyboardOptions?): KeyboardOptions

Returns a new KeyboardOptions that is a combination of this options and a given other options.

others null or Unspecified properties are replaced with the non-null properties of this object.

If the other is null, returns this.

open fun toString(): String

val autoCorrect: Boolean

val autoCorrectEnabled: Boolean?

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. A null value (the default parameter value) means autocorrect will be enabled.

val capitalization: KeyboardCapitalization

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.

val hintLocales: LocaleList?

List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. This special "hint" can be used mainly for, but not limited to, multilingual users who want IMEs to switch language based on editor's context. Pass null to express the intention that a specific hint should not be set.

val imeAction: ImeAction

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.

val keyboardType: KeyboardType

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.

val platformImeOptions: PlatformImeOptions?

defines the platform specific IME options.

val showKeyboardOnFocus: Boolean?

when true, software keyboard will show on focus gain. When false, the user must interact (e.g. tap) before the keyboard is shown. A null value (the default parameter value) means the keyboard will be shown on focus.