The [TextFieldValue] to be shown in the [BaseTextField].

value

Called when the input service updates values in [TextFieldValue].

onValueChange

modifier

[Color] to apply to the text. If [Color.Unspecified], and [textStyle] has no color set, this will be [AmbientContentColor].

textColor

Style configuration that applies at character level such as color, font etc. The default [textStyle] uses the [AmbientTextStyle] defined by the theme

textStyle

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 [KeyboardType.Ascii].

keyboardType

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 [ImeAction.Search] is specified. Then, when user tap that key, the [onImeActionPerformed] callback is called with specified ImeAction.

imeAction

Called when the input service requested an IME action. When the input service emitted an IME action, this callback is called with the emitted IME action. Note that this IME action may be different from what you specified in [imeAction].

onImeActionPerformed

The visual transformation filter for changing the visual representation of the input. By default no visual transformation is applied.

visualTransformation

Callback that is executed when a new text layout is calculated.

onTextLayout

Callback that is executed when the initialization has done for communicating with platform text input service, e.g. software keyboard on Android. Called with [SoftwareKeyboardController] instance which can be used for requesting input show/hide software keyboard.

onTextInputStarted

Color of the cursor. If [Color.Unspecified], there will be no cursor drawn  @see TextFieldValue @see ImeAction @see KeyboardType @see VisualTransformatio

cursorColor

Composable that enables users to edit text via hardware or software keyboard.

BaseTextField

[TextFieldState] object that holds the internal state of a [BasicTextField2].

state

controls the enabled state of the [BasicTextField2]. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable.

enabled

Called when the user submits a form either by pressing the action button in the input method editor (IME), or by pressing the enter key on a hardware keyboard. If the user submits the form by pressing the action button in the IME, the provided IME action is passed to the function. If the user submits the form by pressing the enter key on a hardware keyboard, the defined [imeAction] parameter is passed to the function. Return true to indicate that the action has been handled completely, which will skip the default behavior, such as hiding the keyboard for the [ImeAction.Done] action.

onSubmit

The IME action. This IME action is honored by keyboard and may show specific icons on the keyboard.

Determines the method used to obscure the input text.

textObfuscationMode

The keyboard type to be used in this text field. It is set to [KeyboardType.Password] by default. Use [KeyboardType.NumberPassword] for numerical password fields.

Optional [TextEditFilter] that will be used to filter changes to the [TextFieldState] made by the user. The filter will be applied to changes made by hardware and software keyboard events, pasting or dropping text, accessibility services, and tests. The filter will _not_ be applied when changing the [state] programmatically, or when the filter is changed. If the filter is changed on an existing text field, it will be applied to the next user edit. the filter will not immediately affect the current [state].

filter

Style configuration for text content that's displayed in the editor.

the [MutableInteractionSource] representing the stream of [Interaction]s for this TextField. You can create and pass in your own remembered [MutableInteractionSource] if you want to observe [Interaction]s and customize the appearance / behavior of this TextField for different [Interaction]s.

interactionSource

[Brush] to paint cursor with. If [SolidColor] with [Color.Unspecified] provided, there will be no cursor drawn

cursorBrush

Used to manage the horizontal scroll when the input content exceeds the bounds of the text field. It controls the state of the scroll for the text field.

scrollState

Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text. For example, to draw a cursor or selection around the text. [Density] scope is the one that was used while creating the given text layout.

Composable lambda that allows to add decorations around text field, such as icon, placeholder, helper messages or similar, and automatically increase the hit target area of the text field. To allow you to control the placement of the inner text field relative to your decorations, the text field implementation will pass in a framework-controlled composable parameter "innerTextField" to the decorationBox lambda you provide. You must call innerTextField exactly once

decorationBox

BasicSecureTextField is a new text input component that is still in heavy development.

BasicSecureTextField

the input [String] text to be shown in the text field

the callback that is triggered when the input service updates the text. An updated text comes as a parameter of the callback

controls the enabled state of the [BasicTextField]. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable

controls the editable state of the [BasicTextField]. When `true`, the text field can not be modified, however, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that user can not edit

readOnly

Style configuration that applies at character level such as color, font etc.

software keyboard options that contains configuration such as [KeyboardType] and [ImeAction].

keyboardOptions

when the input service emits an IME action, the corresponding callback is called. Note that this IME action may be different from what you specified in [KeyboardOptions.imeAction].

keyboardActions

when set to true, this text field becomes a single horizontally scrolling text field instead of wrapping onto multiple lines. The keyboard will be informed to not show the return key as the [ImeAction]. [maxLines] and [minLines] are ignored as both are automatically set to 1.

singleLine

the maximum height in terms of maximum number of visible lines. It is required that 1 <= [minLines] <= [maxLines]. This parameter is ignored when [singleLine] is true.

maxLines

the minimum height in terms of minimum number of visible lines. It is required that 1 <= [minLines] <= [maxLines]. This parameter is ignored when [singleLine] is true.

minLines

Callback that is executed when a new text layout is calculated. A [TextLayoutResult] object that callback provides contains paragraph information, size of the text, baselines and other details. The callback can be used to add additional decoration or functionality to the text. For example, to draw a cursor or selection around the text.

the [MutableInteractionSource] representing the stream of [Interaction]s for this TextField. You can create and pass in your own remembered [MutableInteractionSource] if you want to observe [Interaction]s and customize the appearance / behavior of this TextField in different [Interaction]s.

Basic composable that enables users to edit text via hardware or software keyboard, but provides no decorations like hint or placeholder.

BasicTextField

The [androidx.compose.ui.text.input.TextFieldValue] to be shown in the [CoreTextField].

Called when the input service updates the values in [TextFieldValue].

The [InteractionState] representing the different [Interaction]s present on this TextField. You can create and pass in your own remembered [InteractionState] if you want to read the [InteractionState] and customize the appearance / behavior of this TextField in different [Interaction]s.

interactionState

Color of the cursor. If [Color.Unspecified], there will be no cursor drawn

Whether the text should break at soft line breaks. If false, the glyphs in the text will be positioned as if there was unlimited horizontal space.

softWrap

The maximum height in terms of maximum number of visible lines. Should be equal or greater than 1.

Contains different IME configuration options.

imeOptions

controls the enabled state of the text field. When `false`, the text field will be neither editable nor focusable, the input of the text field will not be selectable

controls the editable state of the [CoreTextField]. When `true`, the text field can not be modified, however, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that user can not edit

Base composable that enables users to edit text via hardware or software keyboard.

CoreTextField

the input text to be shown in the text field

the label to be displayed inside the text field container. The default text style for internal [Text] is [Typography.caption] when the text field is in focus and [Typography.subtitle1] when the text field is not in focus

label

the style to be applied to the input text. The default [textStyle] uses the [currentTextStyle] defined by the theme

the optional placeholder to be displayed when the text field is in focus and the input text is empty. The default text style for internal [Text] is [Typography.subtitle1]

placeholder

the optional leading icon to be displayed at the beginning of the text field container

leadingIcon

the optional trailing icon to be displayed at the end of the text field container

trailingIcon

indicates if the text field's current value is in error. If set to true, the label, bottom indicator and trailing icon will be displayed in [errorColor] color

isErrorValue

transforms the visual representation of the input [value]. For example, you can use [androidx.ui.input.PasswordVisualTransformation] to create a password text field. By default no visual transformation is applied

the keyboard type to be used with the text field. Note that the input type is not guaranteed. For example, an IME may send a non-ASCII character even if you set the keyboard type to [KeyboardType.Ascii]

the IME action honored by the IME. The 'enter' key on the soft keyboard input will show a corresponding icon. For example, search icon may be shown if [ImeAction.Search] is selected. When a user taps on that 'enter' key, the [onImeActionPerformed] callback is called with the specified [ImeAction]

is triggered when the input service performs an [ImeAction]. Note that the emitted IME action may be different from what you specified through the [imeAction] field. The callback also exposes a [SoftwareKeyboardController] instance as a parameter that can be used to request to hide the software keyboard

a callback to be invoked when the text field receives or loses focus If the boolean parameter value is `true`, it means the text field has focus, and vice versa

onFocusChanged

a callback to be invoked when the connection with the platform's text input service (e.g. software keyboard on Android) has been established. Called with the [SoftwareKeyboardController] instance that can be used to request to show or hide the software keyboard

the color of the label, bottom indicator and the cursor when the text field is in focus

activeColor

the color of either the input text or placeholder when the text field is in focus, and the color of the label and bottom indicator when the text field is not in focus

inactiveColor

the alternative color of the label, bottom indicator, cursor and trailing icon used when [isErrorValue] is set to true

errorColor

the background color of the text field's container. To the color provided here there will be applied a transparency alpha defined by Material Design specifications

backgroundColor

shape

FilledTextField

the [Modifier] to be applied to this text field

controls the enabled state of this text field. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.

controls the editable state of the text field. When `true`, the text field cannot be modified. However, a user can focus it and copy text from it. Read-only text fields are usually used to display pre-filled forms that a user cannot edit.

the style to be applied to the input text. Defaults to [LocalTextStyle].

the optional label to be displayed inside the text field container. The default text style for internal [Text] is [Typography.bodySmall] when the text field is in focus and [Typography.bodyLarge] when the text field is not in focus

the optional placeholder to be displayed when the text field is in focus and the input text is empty. The default text style for internal [Text] is [Typography.bodyLarge]

the optional prefix to be displayed before the input text in the text field

prefix

the optional suffix to be displayed after the input text in the text field

suffix

the optional supporting text to be displayed below the text field

supportingText

indicates if the text field's current value is in error. If set to true, the label, bottom indicator and trailing icon by default will be displayed in error color

isError

transforms the visual representation of the input [value] For example, you can use [PasswordVisualTransformation][androidx.compose.ui.text.input.PasswordVisualTransformation] to create a password text field. By default, no visual transformation is applied.

software keyboard options that contains configuration such as [KeyboardType] and [ImeAction]

when the input service emits an IME action, the corresponding callback is called. Note that this IME action may be different from what you specified in [KeyboardOptions.imeAction]

when `true`, this text field becomes a single horizontally scrolling text field instead of wrapping onto multiple lines. The keyboard will be informed to not show the return key as the [ImeAction]. Note that [maxLines] parameter will be ignored as the maxLines attribute will be automatically set to 1.

the [MutableInteractionSource] representing the stream of [Interaction]s for this text field. You can create and pass in your own `remember`ed instance to observe [Interaction]s and customize the appearance / behavior of this text field in different states.

defines the shape of this text field's border

[TextFieldColors] that will be used to resolve the colors used for this text field in different states. See [OutlinedTextFieldDefaults.colors]

colors

OutlinedTextField

This function is used to set the current value of [AmbientTextStyle], merging the given style with the current style values for any missing attributes.

ProvideTextStyle

The [androidx.ui.input.TextFieldValue] to be shown in the [TextField].

Called when the input service updates values in [androidx.ui.input.TextFieldValue].

[Color] to apply to the text. If [Color.Unset], and [textStyle] has no color set, this will be [contentColor].

Style configuration that applies at character level such as color, font etc. The default [textStyle] uses the [currentTextStyle] defined by the theme

Called with true value when the input field gains focus and with false value when the input field loses focus. Use [FocusModifier.requestFocus] to obtain text input focus to this TextField.

Color of the cursor.  @see TextFieldValue @see ImeAction @see KeyboardType @see VisualTransformatio

TextField

A list of all Jetpack Compose Text Input components listed on our website, you can use in your Jetpack Compose projects.

Jetpack Compose Text Input components

OutlinedTextField

Bring your next idea to life with Compose UI