# ImeAction

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/ImeAction.kt+class:androidx.compose.ui.text.input.ImeAction) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/AllAndroid/JVM
- Cmn

  ```
  value class ImeAction
  ```

*** ** * ** ***

Signals the keyboard what type of action should be displayed. It is not guaranteed that the keyboard will show the requested action.

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Default()` Use the platform and keyboard defaults and let the keyboard decide the action it is going to show. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Done()` Represents that the user is done providing input to a group of inputs. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Go()` Represents that the user would like to go to the target of the text in the input i.e. visiting a URL. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Next()` Represents that the user is done with the current input, and wants to move to the next one i.e. moving to the next field in a form. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#None()` Represents that no action is expected from the keyboard. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Previous()` Represents that the user wants to return to the previous input i.e. going back to the previous field in a form. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Search()` Represents that the user wants to execute a search, i.e. web search query. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Send()` Represents that the user wants to send the text in the input, i.e. an SMS. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Unspecified()` The action is not specified. | Cmn |

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#toString()()` | 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: ImeAction
```

Use the platform and keyboard defaults and let the keyboard decide the action it is going to show. The keyboards will mostly show one of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Done()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#None()` actions based on the single/multi line configuration. This action will never be sent as the performed action to IME action callbacks.

### Done

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

```
val Done: ImeAction
```

Represents that the user is done providing input to a group of inputs. Some kind of finalization behavior should now take place i.e. the field was the last element in a group and the data input is finalized.

### Go

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

```
val Go: ImeAction
```

Represents that the user would like to go to the target of the text in the input i.e. visiting a URL.

### Next

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

```
val Next: ImeAction
```

Represents that the user is done with the current input, and wants to move to the next one i.e. moving to the next field in a form.

### None

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

```
val None: ImeAction
```

Represents that no action is expected from the keyboard. Keyboard might choose to show an action which mostly will be newline, however this action will never be sent as the performed action to IME action callbacks.

### Previous

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

```
val Previous: ImeAction
```

Represents that the user wants to return to the previous input i.e. going back to the previous field in a form.

### Search

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

```
val Search: ImeAction
```

Represents that the user wants to execute a search, i.e. web search query.

### Send

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

```
val Send: ImeAction
```

Represents that the user wants to send the text in the input, i.e. an SMS.

### Unspecified

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

```
val Unspecified: ImeAction
```

The action is not specified. This defaults to `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Default()`, which explicitly requests the platform and keyboard to make the decision, but `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction#Default()` will take precedence when merging `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/ImeAction`s.

## Public functions

### toString

Cmn

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