{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ImeAction.Companion

public static class ImeAction.Companion


Summary

Public methods

static final @NonNull ImeAction

Use the platform and keyboard defaults and let the keyboard to decide the action.

static final @NonNull ImeAction

Represents that the user is done providing input to a group of inputs.

static final @NonNull ImeAction

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

static final @NonNull 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.

static final @NonNull ImeAction

Represents that no action is expected from the keyboard.

static final @NonNull ImeAction

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

static final @NonNull ImeAction

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

static final @NonNull ImeAction

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

Public methods

getDefault

public static final @NonNull ImeAction getDefault()

Use the platform and keyboard defaults and let the keyboard to decide the action. The keyboards will mostly show one of Done or None actions based on the single/multi line configuration.

getDone

public static final @NonNull ImeAction getDone()

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.

getGo

public static final @NonNull ImeAction getGo()

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

getNext

public static final @NonNull ImeAction getNext()

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.

getNone

public static final @NonNull ImeAction getNone()

Represents that no action is expected from the keyboard. Keyboard might choose to show an action which mostly will be newline, however this action is not carried into the app via any androidx.compose.foundation.text.KeyboardAction.

getPrevious

public static final @NonNull ImeAction getPrevious()

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

getSearch

public static final @NonNull ImeAction getSearch()

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

getSend

public static final @NonNull ImeAction getSend()

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