ImeAction

value class ImeAction private constructor(@Suppress("unused") private val value: Int)

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

Companion Object

Properties

val Unspecified: ImeAction

The action is not specified. This defaults to Default, which explicitly requests the platform and keyboard to make the decision, but Default will take precedence when merging ImeActions.

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 Done or None actions based on the single/multi line configuration. This action will never be sent as the performed action to IME action callbacks.

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.

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.

val Search: ImeAction

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

val Send: ImeAction

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

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.

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.

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.