# ImeOptions

Artifact: [androidx.compose.ui:ui-text](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/text/input/ImeOptions.kt+class:androidx.compose.ui.text.input.ImeOptions) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/AllAndroid/JVM
- Cmn

  ```
  class ImeOptions
  ```

*** ** * ** ***

The IME configuration options for `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/TextInputService`. It is not guaranteed if IME will comply with the options provided here.

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#Default()` Default `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions`. | Cmn |

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#ImeOptions(kotlin.Boolean,androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction,androidx.compose.ui.text.input.PlatformImeOptions,androidx.compose.ui.text.intl.LocaleList)( singleLine: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, capitalization: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization, autoCorrect: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, keyboardType: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType, imeAction: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction, platformImeOptions: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions?, hintLocales: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList )` | Cmn |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#copy(kotlin.Boolean,androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction,androidx.compose.ui.text.input.PlatformImeOptions,androidx.compose.ui.text.intl.LocaleList)( singleLine: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, capitalization: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization, autoCorrect: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, keyboardType: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType, imeAction: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction, platformImeOptions: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions?, hintLocales: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList )` | Cmn |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#hashCode()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#toString()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#autoCorrect()` informs the IME whether to enable auto correct. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#capitalization()` informs the IME whether to automatically capitalize characters, words or sentences. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#hintLocales()` List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#imeAction()` The IME action. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#keyboardType()` The keyboard type to be used in this text field. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions?` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#platformImeOptions()` defines the platform specific IME options. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#singleLine()` informs the IME that the text field is single line and IME should not show return key. | Cmn |

## Public companion properties

### Default

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val Default: ImeOptions
```

Default `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions`. Please see parameter descriptions for default values.

## Public constructors

### ImeOptions

Cmn Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.9.0)

```
ImeOptions(
    singleLine: Boolean = false,
    capitalization: KeyboardCapitalization = KeyboardCapitalization.None,
    autoCorrect: Boolean = true,
    keyboardType: KeyboardType = KeyboardType.Text,
    imeAction: ImeAction = ImeAction.Default,
    platformImeOptions: PlatformImeOptions? = null,
    hintLocales: LocaleList = LocaleList.Empty
)
```

| Parameters |
|---|---|
| `singleLine: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | informs the IME that the text field is single line and IME should not show return key. |
| `capitalization: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization = KeyboardCapitalization.None` | informs the IME whether to automatically capitalize characters, words or sentences. Only applicable to only text based `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Text()`, `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Ascii()`. It will not be applied to `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Number()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Decimal()`. |
| `autoCorrect: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | informs the IME whether to enable auto correct. Only applicable to text based `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Email()`, `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Uri()`. It will not be applied to `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Number()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Decimal()`. Most of IME implementations ignore this value for `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Text()`. |
| `keyboardType: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType = KeyboardType.Text` | The keyboard type to be used in this text field. Note that this input type is honored by IME and shows corresponding keyboard but this is not guaranteed. For example, some IME may send non-ASCII character even if you set `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Ascii()`. |
| `imeAction: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction = ImeAction.Default` | The IME action. This IME action is honored by IME and may show specific icons on the keyboard. For example, search icon may be shown if `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Search()` is specified. When `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#singleLine()` is false, the IME might show return key rather than the action requested here. |
| `platformImeOptions: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/PlatformImeOptions? = null` | defines the platform specific IME options. |
| `hintLocales: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList = LocaleList.Empty` | 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 `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#Empty()` to express the intention that a specific hint should not be set. |

## Public functions

### copy

Cmn Added in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0)

```
fun copy(
    singleLine: Boolean = this.singleLine,
    capitalization: KeyboardCapitalization = this.capitalization,
    autoCorrect: Boolean = this.autoCorrect,
    keyboardType: KeyboardType = this.keyboardType,
    imeAction: ImeAction = this.imeAction,
    platformImeOptions: PlatformImeOptions? = this.platformImeOptions,
    hintLocales: LocaleList = this.hintLocales
): ImeOptions
```

### equals

Cmn

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

### hashCode

Cmn

```
open fun hashCode(): Int
```

### toString

Cmn

```
open fun toString(): String
```

## Public properties

### autoCorrect

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val autoCorrect: Boolean
```

informs the IME whether to enable auto correct. Only applicable to text based `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Email()`, `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Uri()`. It will not be applied to `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Number()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Decimal()`. Most of IME implementations ignore this value for `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Text()`.

### capitalization

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val capitalization: KeyboardCapitalization
```

informs the IME whether to automatically capitalize characters, words or sentences. Only applicable to only text based `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Text()`, `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Ascii()`. It will not be applied to `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Number()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Decimal()`.

### hintLocales

Cmn Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
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 `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#Empty()` to express the intention that a specific hint should not be set.

### imeAction

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val imeAction: ImeAction
```

The IME action. This IME action is honored by IME and may show specific icons on the keyboard. For example, search icon may be shown if `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Search()` is specified. When `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeOptions#singleLine()` is false, the IME might show return key rather than the action requested here.

### keyboardType

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val keyboardType: KeyboardType
```

The keyboard type to be used in this text field. Note that this input type is honored by IME and shows corresponding keyboard but this is not guaranteed. For example, some IME may send non-ASCII character even if you set `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Ascii()`.

### platformImeOptions

Cmn Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0)

```
val platformImeOptions: PlatformImeOptions?
```

defines the platform specific IME options.

### singleLine

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val singleLine: Boolean
```

informs the IME that the text field is single line and IME should not show return key.