TextFieldDefaults

Artifact: androidx.compose.material3:material3

Added in 1.0.0

Cmn
```
object TextFieldDefaults
```

Contains the default values used by TextField. For defaults used in OutlinedTextField, see OutlinedTextFieldDefaults.

Summary

Public functions
`Unit`	`@Composable Container( enabled: Boolean, isError: Boolean, interactionSource: InteractionSource, modifier: Modifier, colors: TextFieldColors, shape: Shape, focusedIndicatorLineThickness: Dp, unfocusedIndicatorLineThickness: Dp )` Composable that draws a default container for a `TextField` with an indicator line at the bottom.	Cmn
`Unit`	`@ExperimentalMaterial3Api @Composable ContainerBox( enabled: Boolean, isError: Boolean, interactionSource: InteractionSource, colors: TextFieldColors, shape: Shape )` This function is deprecated. Renamed to TextFieldDefaults.Container	Cmn
`Unit`	@Composable DecorationBox( value: String, innerTextField: @Composable () -> Unit, enabled: Boolean, singleLine: Boolean, visualTransformation: VisualTransformation, interactionSource: InteractionSource, isError: Boolean, label: (@Composable () -> Unit)?, placeholder: (@Composable () -> Unit)?, leadingIcon: (@Composable () -> Unit)?, trailingIcon: (@Composable () -> Unit)?, prefix: (@Composable () -> Unit)?, suffix: (@Composable () -> Unit)?, supportingText: (@Composable () -> Unit)?, shape: Shape, colors: TextFieldColors, contentPadding: PaddingValues, container: @Composable () -> Unit ) A decoration box used to create custom text fields based on Material Design filled text field.	Cmn
`TextFieldColors`	`@Composable colors()` Creates a `TextFieldColors` that represents the default input text, container, and content colors (including label, placeholder, icons, etc.) used in a `TextField`.	Cmn
`TextFieldColors`	@Composable colors( focusedTextColor: Color, unfocusedTextColor: Color, disabledTextColor: Color, errorTextColor: Color, focusedContainerColor: Color, unfocusedContainerColor: Color, disabledContainerColor: Color, errorContainerColor: Color, cursorColor: Color, errorCursorColor: Color, selectionColors: TextSelectionColors?, focusedIndicatorColor: Color, unfocusedIndicatorColor: Color, disabledIndicatorColor: Color, errorIndicatorColor: Color, focusedLeadingIconColor: Color, unfocusedLeadingIconColor: Color, disabledLeadingIconColor: Color, errorLeadingIconColor: Color, focusedTrailingIconColor: Color, unfocusedTrailingIconColor: Color, disabledTrailingIconColor: Color, errorTrailingIconColor: Color, focusedLabelColor: Color, unfocusedLabelColor: Color, disabledLabelColor: Color, errorLabelColor: Color, focusedPlaceholderColor: Color, unfocusedPlaceholderColor: Color, disabledPlaceholderColor: Color, errorPlaceholderColor: Color, focusedSupportingTextColor: Color, unfocusedSupportingTextColor: Color, disabledSupportingTextColor: Color, errorSupportingTextColor: Color, focusedPrefixColor: Color, unfocusedPrefixColor: Color, disabledPrefixColor: Color, errorPrefixColor: Color, focusedSuffixColor: Color, unfocusedSuffixColor: Color, disabledSuffixColor: Color, errorSuffixColor: Color ) Creates a `TextFieldColors` that represents the default input text, container, and content colors (including label, placeholder, icons, etc.) used in a `TextField`.	Cmn
`PaddingValues`	`contentPaddingWithLabel(start: Dp, end: Dp, top: Dp, bottom: Dp)` Default content padding of the input field within the `TextField` when there is an inside label.	Cmn
`PaddingValues`	`contentPaddingWithoutLabel(start: Dp, top: Dp, end: Dp, bottom: Dp)` Default content padding of the input field within the `TextField` when the label is null or positioned `TextFieldLabelPosition.Above`.	Cmn
`TextFieldDecorator`	@Composable decorator( state: TextFieldState, enabled: Boolean, lineLimits: TextFieldLineLimits, outputTransformation: OutputTransformation?, interactionSource: InteractionSource, labelPosition: TextFieldLabelPosition, label: (@Composable TextFieldLabelScope.() -> Unit)?, placeholder: (@Composable () -> Unit)?, leadingIcon: (@Composable () -> Unit)?, trailingIcon: (@Composable () -> Unit)?, prefix: (@Composable () -> Unit)?, suffix: (@Composable () -> Unit)?, supportingText: (@Composable () -> Unit)?, isError: Boolean, colors: TextFieldColors, contentPadding: PaddingValues, container: @Composable () -> Unit ) A decorator used to create custom text fields based on Material Design filled text field.	Cmn
`Modifier`	`Modifier.indicatorLine( enabled: Boolean, isError: Boolean, interactionSource: InteractionSource, colors: TextFieldColors?, textFieldShape: Shape?, focusedIndicatorLineThickness: Dp, unfocusedIndicatorLineThickness: Dp )` A modifier to draw a default bottom indicator line for `TextField`.	Cmn
`PaddingValues`	`outlinedTextFieldPadding(start: Dp, top: Dp, end: Dp, bottom: Dp)` This function is deprecated. Renamed to `OutlinedTextFieldDefaults.contentPadding`	Cmn
`PaddingValues`	`textFieldWithLabelPadding(start: Dp, end: Dp, top: Dp, bottom: Dp)` This function is deprecated. Renamed to `TextFieldDefaults.contentPaddingWithLabel`	Cmn
`PaddingValues`	`textFieldWithoutLabelPadding(start: Dp, top: Dp, end: Dp, bottom: Dp)` This function is deprecated. Renamed to `TextFieldDefaults.contentPaddingWithoutLabel`	Cmn

Public properties
`Dp`	`FocusedBorderThickness` This property is deprecated. Split into `TextFieldDefaults.FocusedIndicatorThickness` and `OutlinedTextFieldDefaults.FocusedBorderThickness`.	Cmn
`Dp`	`FocusedIndicatorThickness` The default thickness of the indicator line in `TextField` in focused state.	Cmn
`Dp`	`MinHeight` The default min height applied to a `TextField`.	Cmn
`Dp`	`MinWidth` The default min width applied to a `TextField`.	Cmn
`Dp`	`UnfocusedBorderThickness` This property is deprecated. Split into `TextFieldDefaults.UnfocusedIndicatorThickness` and `OutlinedTextFieldDefaults.UnfocusedBorderThickness`.	Cmn
`Dp`	`UnfocusedIndicatorThickness` The default thickness of the indicator line in `TextField` in unfocused state.	Cmn
`Shape`	`filledShape` This property is deprecated. Renamed to `TextFieldDefaults.shape`	Cmn
`Shape`	`outlinedShape` This property is deprecated. Renamed to `OutlinedTextFieldDefaults.shape`	Cmn
`Shape`	`shape` Default shape for a `TextField`.	Cmn

Public functions

Container

Cmn

Added in 1.5.0-alpha11

@Composable
fun Container(
    enabled: Boolean,
    isError: Boolean,
    interactionSource: InteractionSource,
    modifier: Modifier = Modifier,
    colors: TextFieldColors = colors(),
    shape: Shape = TextFieldDefaults.shape,
    focusedIndicatorLineThickness: Dp = FocusedIndicatorThickness,
    unfocusedIndicatorLineThickness: Dp = UnfocusedIndicatorThickness
): Unit

Composable that draws a default container for a TextField with an indicator line at the bottom. You can apply it to a BasicTextField using decorator or DecorationBox to create a custom text field based on the styling of a Material filled text field. The TextField component applies it automatically.

Parameters
`enabled: Boolean`	whether the text field is enabled
`isError: Boolean`	whether the text field's current value is in error
`interactionSource: InteractionSource`	the `InteractionSource` of the text field. Used to determine if the text field is in focus or not
`modifier: Modifier = Modifier`	the `Modifier` of this container
`colors: TextFieldColors = colors()`	`TextFieldColors` used to resolve colors of the text field
`shape: Shape = TextFieldDefaults.shape`	the shape of this container
`focusedIndicatorLineThickness: Dp = FocusedIndicatorThickness`	thickness of the indicator line when the text field is focused
`unfocusedIndicatorLineThickness: Dp = UnfocusedIndicatorThickness`	thickness of the indicator line when the text field is not focused

ContainerBox

Cmn

Added in 1.1.0

Deprecated in 1.3.0

@ExperimentalMaterial3Api
@Composable
fun ContainerBox(
    enabled: Boolean,
    isError: Boolean,
    interactionSource: InteractionSource,
    colors: TextFieldColors,
    shape: Shape = TextFieldDefaults.shape
): Unit

DecorationBox

Cmn

Added in 1.1.0

@Composable
fun DecorationBox(
    value: String,
    innerTextField: @Composable () -> Unit,
    enabled: Boolean,
    singleLine: Boolean,
    visualTransformation: VisualTransformation,
    interactionSource: InteractionSource,
    isError: Boolean = false,
    label: (@Composable () -> Unit)? = null,
    placeholder: (@Composable () -> Unit)? = null,
    leadingIcon: (@Composable () -> Unit)? = null,
    trailingIcon: (@Composable () -> Unit)? = null,
    prefix: (@Composable () -> Unit)? = null,
    suffix: (@Composable () -> Unit)? = null,
    supportingText: (@Composable () -> Unit)? = null,
    shape: Shape = TextFieldDefaults.shape,
    colors: TextFieldColors = colors(),
    contentPadding: PaddingValues = if (label == null) {
                contentPaddingWithoutLabel()
            } else {
                contentPaddingWithLabel()
            },
    container: @Composable () -> Unit = {
            Container(
                enabled = enabled,
                isError = isError,
                interactionSource = interactionSource,
                modifier = Modifier,
                colors = colors,
                shape = shape,
                focusedIndicatorLineThickness = FocusedIndicatorThickness,
                unfocusedIndicatorLineThickness = UnfocusedIndicatorThickness,
            )
        }
): Unit

A decoration box used to create custom text fields based on Material Design filled text field.

If your text field requires customising elements that aren't exposed by TextField, consider using this decoration box to achieve the desired design.

For example, if you wish to customise the bottom indicator line, you can pass a custom Container to this decoration box's container.

This decoration box is meant to be used in conjunction with overloads of BasicTextField that accept a decorationBox parameter. For other overloads of BasicTextField that use a TextFieldDecorator, see decorator.

An example of building a custom text field using DecorationBox:

import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.collectIsFocusedAsState
import androidx.compose.foundation.text.BasicTextField
import androidx.compose.material3.LocalTextStyle
import androidx.compose.material3.Text
import androidx.compose.material3.TextField
import androidx.compose.material3.TextFieldDefaults
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.SolidColor
import androidx.compose.ui.graphics.takeOrElse
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.input.VisualTransformation
import androidx.compose.ui.unit.dp

var text by remember { mutableStateOf("") }
val interactionSource = remember { MutableInteractionSource() }
val customColors =
    TextFieldDefaults.colors(
        focusedTextColor = Color.DarkGray,
        unfocusedTextColor = Color.Gray,
        focusedIndicatorColor = Color.Blue,
        cursorColor = Color.Green,
    )
val enabled = true
val isError = false
val singleLine = true

val textColor =
    LocalTextStyle.current.color.takeOrElse {
        customColors.textColor(
            enabled = enabled,
            isError = isError,
            focused = interactionSource.collectIsFocusedAsState().value,
        )
    }

BasicTextField(
    value = text,
    onValueChange = { text = it },
    modifier = Modifier,
    interactionSource = interactionSource,
    enabled = enabled,
    singleLine = singleLine,
    // Colors of non-decoration-box elements (such as text color or cursor color)
    // must be passed to BasicTextField
    textStyle = LocalTextStyle.current.merge(TextStyle(color = textColor)),
    cursorBrush = SolidColor(customColors.cursorColor),
    decorationBox = { innerTextField ->
        TextFieldDefaults.DecorationBox(
            value = text,
            innerTextField = innerTextField,
            visualTransformation = VisualTransformation.None,
            singleLine = singleLine,
            enabled = enabled,
            isError = isError,
            interactionSource = interactionSource,
            container = {
                TextFieldDefaults.Container(
                    enabled = enabled,
                    isError = isError,
                    interactionSource = interactionSource,
                    colors = customColors,
                    // Update indicator line thickness
                    unfocusedIndicatorLineThickness = 2.dp,
                    focusedIndicatorLineThickness = 4.dp,
                )
            },
        )
    },
)

Parameters
`value: String`	the input `String` shown by the text field
`innerTextField: @Composable () -> Unit`	input text field that this decoration box wraps. Pass the framework-controlled composable parameter `innerTextField` from the `decorationBox` lambda of the `BasicTextField`
`enabled: Boolean`	the enabled state of the text field. When `false`, this decoration box will appear visually disabled. This must be the same value that is passed to `BasicTextField`.
`singleLine: Boolean`	indicates if this is a single line or multi line text field. This must be the same value that is passed to `BasicTextField`.
`visualTransformation: VisualTransformation`	transforms the visual representation of the input `value`. This must be the same value that is passed to `BasicTextField`.
`interactionSource: InteractionSource`	the read-only `InteractionSource` representing the stream of `Interaction`s for this text field. You must first create and pass in your own `remember`ed `MutableInteractionSource` instance to the `BasicTextField` for it to dispatch events. And then pass the same instance to this decoration box to observe `Interaction`s and customize the appearance / behavior of this text field in different states.
`isError: Boolean = false`	indicates if the text field's current value is in an error state. When `true`, this decoration box will display its contents in an error color.
`label: (@Composable () -> Unit)? = null`	the optional label to be displayed with this text field. The default text style uses `Typography.bodySmall` when minimized and `Typography.bodyLarge` when expanded.
`placeholder: (@Composable () -> Unit)? = null`	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`.
`leadingIcon: (@Composable () -> Unit)? = null`	the optional leading icon to be displayed at the beginning of the text field container
`trailingIcon: (@Composable () -> Unit)? = null`	the optional trailing icon to be displayed at the end of the text field container
`prefix: (@Composable () -> Unit)? = null`	the optional prefix to be displayed before the input text in the text field
`suffix: (@Composable () -> Unit)? = null`	the optional suffix to be displayed after the input text in the text field
`supportingText: (@Composable () -> Unit)? = null`	the optional supporting text to be displayed below the text field
`shape: Shape = TextFieldDefaults.shape`	defines the shape of this decoration box's container
`colors: TextFieldColors = colors()`	`TextFieldColors` that will be used to resolve the colors used for this text field decoration box in different states. See `TextFieldDefaults.colors`. Note: This parameter only affects the colors of elements in the decoration box. Elements of the `BasicTextField` (such as text color or cursor color) are unaffected and must be changed using the relevant parameters of `BasicTextField`.
`contentPadding: PaddingValues = if (label == null) { contentPaddingWithoutLabel() } else { contentPaddingWithLabel() }`	the padding between the input field and the surrounding elements of the decoration box. Note that the padding values may not be respected if they are incompatible with the text field's size constraints or layout. See `TextFieldDefaults.contentPaddingWithLabel` and `TextFieldDefaults.contentPaddingWithoutLabel`.
`container: @Composable () -> Unit = { Container( enabled = enabled, isError = isError, interactionSource = interactionSource, modifier = Modifier, colors = colors, shape = shape, focusedIndicatorLineThickness = FocusedIndicatorThickness, unfocusedIndicatorLineThickness = UnfocusedIndicatorThickness, ) }`	the container to be drawn behind the text field. By default, this uses `Container`. Default colors for the container come from the `colors`.

colors

Cmn

Added in 1.2.0

@Composable
fun colors(): TextFieldColors

Creates a TextFieldColors that represents the default input text, container, and content colors (including label, placeholder, icons, etc.) used in a TextField.

colors

Cmn

Added in 1.5.0-alpha11

@Composable
fun colors(
    focusedTextColor: Color = Color.Unspecified,
    unfocusedTextColor: Color = Color.Unspecified,
    disabledTextColor: Color = Color.Unspecified,
    errorTextColor: Color = Color.Unspecified,
    focusedContainerColor: Color = Color.Unspecified,
    unfocusedContainerColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    errorContainerColor: Color = Color.Unspecified,
    cursorColor: Color = Color.Unspecified,
    errorCursorColor: Color = Color.Unspecified,
    selectionColors: TextSelectionColors? = null,
    focusedIndicatorColor: Color = Color.Unspecified,
    unfocusedIndicatorColor: Color = Color.Unspecified,
    disabledIndicatorColor: Color = Color.Unspecified,
    errorIndicatorColor: Color = Color.Unspecified,
    focusedLeadingIconColor: Color = Color.Unspecified,
    unfocusedLeadingIconColor: Color = Color.Unspecified,
    disabledLeadingIconColor: Color = Color.Unspecified,
    errorLeadingIconColor: Color = Color.Unspecified,
    focusedTrailingIconColor: Color = Color.Unspecified,
    unfocusedTrailingIconColor: Color = Color.Unspecified,
    disabledTrailingIconColor: Color = Color.Unspecified,
    errorTrailingIconColor: Color = Color.Unspecified,
    focusedLabelColor: Color = Color.Unspecified,
    unfocusedLabelColor: Color = Color.Unspecified,
    disabledLabelColor: Color = Color.Unspecified,
    errorLabelColor: Color = Color.Unspecified,
    focusedPlaceholderColor: Color = Color.Unspecified,
    unfocusedPlaceholderColor: Color = Color.Unspecified,
    disabledPlaceholderColor: Color = Color.Unspecified,
    errorPlaceholderColor: Color = Color.Unspecified,
    focusedSupportingTextColor: Color = Color.Unspecified,
    unfocusedSupportingTextColor: Color = Color.Unspecified,
    disabledSupportingTextColor: Color = Color.Unspecified,
    errorSupportingTextColor: Color = Color.Unspecified,
    focusedPrefixColor: Color = Color.Unspecified,
    unfocusedPrefixColor: Color = Color.Unspecified,
    disabledPrefixColor: Color = Color.Unspecified,
    errorPrefixColor: Color = Color.Unspecified,
    focusedSuffixColor: Color = Color.Unspecified,
    unfocusedSuffixColor: Color = Color.Unspecified,
    disabledSuffixColor: Color = Color.Unspecified,
    errorSuffixColor: Color = Color.Unspecified
): TextFieldColors

Creates a TextFieldColors that represents the default input text, container, and content colors (including label, placeholder, icons, etc.) used in a TextField.

Parameters
`focusedTextColor: Color = Color.Unspecified`	the color used for the input text of this text field when focused
`unfocusedTextColor: Color = Color.Unspecified`	the color used for the input text of this text field when not focused
`disabledTextColor: Color = Color.Unspecified`	the color used for the input text of this text field when disabled
`errorTextColor: Color = Color.Unspecified`	the color used for the input text of this text field when in error state
`focusedContainerColor: Color = Color.Unspecified`	the container color for this text field when focused
`unfocusedContainerColor: Color = Color.Unspecified`	the container color for this text field when not focused
`disabledContainerColor: Color = Color.Unspecified`	the container color for this text field when disabled
`errorContainerColor: Color = Color.Unspecified`	the container color for this text field when in error state
`cursorColor: Color = Color.Unspecified`	the cursor color for this text field
`errorCursorColor: Color = Color.Unspecified`	the cursor color for this text field when in error state
`selectionColors: TextSelectionColors? = null`	the colors used when the input text of this text field is selected
`focusedIndicatorColor: Color = Color.Unspecified`	the indicator color for this text field when focused
`unfocusedIndicatorColor: Color = Color.Unspecified`	the indicator color for this text field when not focused
`disabledIndicatorColor: Color = Color.Unspecified`	the indicator color for this text field when disabled
`errorIndicatorColor: Color = Color.Unspecified`	the indicator color for this text field when in error state
`focusedLeadingIconColor: Color = Color.Unspecified`	the leading icon color for this text field when focused
`unfocusedLeadingIconColor: Color = Color.Unspecified`	the leading icon color for this text field when not focused
`disabledLeadingIconColor: Color = Color.Unspecified`	the leading icon color for this text field when disabled
`errorLeadingIconColor: Color = Color.Unspecified`	the leading icon color for this text field when in error state
`focusedTrailingIconColor: Color = Color.Unspecified`	the trailing icon color for this text field when focused
`unfocusedTrailingIconColor: Color = Color.Unspecified`	the trailing icon color for this text field when not focused
`disabledTrailingIconColor: Color = Color.Unspecified`	the trailing icon color for this text field when disabled
`errorTrailingIconColor: Color = Color.Unspecified`	the trailing icon color for this text field when in error state
`focusedLabelColor: Color = Color.Unspecified`	the label color for this text field when focused
`unfocusedLabelColor: Color = Color.Unspecified`	the label color for this text field when not focused
`disabledLabelColor: Color = Color.Unspecified`	the label color for this text field when disabled
`errorLabelColor: Color = Color.Unspecified`	the label color for this text field when in error state
`focusedPlaceholderColor: Color = Color.Unspecified`	the placeholder color for this text field when focused
`unfocusedPlaceholderColor: Color = Color.Unspecified`	the placeholder color for this text field when not focused
`disabledPlaceholderColor: Color = Color.Unspecified`	the placeholder color for this text field when disabled
`errorPlaceholderColor: Color = Color.Unspecified`	the placeholder color for this text field when in error state
`focusedSupportingTextColor: Color = Color.Unspecified`	the supporting text color for this text field when focused
`unfocusedSupportingTextColor: Color = Color.Unspecified`	the supporting text color for this text field when not focused
`disabledSupportingTextColor: Color = Color.Unspecified`	the supporting text color for this text field when disabled
`errorSupportingTextColor: Color = Color.Unspecified`	the supporting text color for this text field when in error state
`focusedPrefixColor: Color = Color.Unspecified`	the prefix color for this text field when focused
`unfocusedPrefixColor: Color = Color.Unspecified`	the prefix color for this text field when not focused
`disabledPrefixColor: Color = Color.Unspecified`	the prefix color for this text field when disabled
`errorPrefixColor: Color = Color.Unspecified`	the prefix color for this text field when in error state
`focusedSuffixColor: Color = Color.Unspecified`	the suffix color for this text field when focused
`unfocusedSuffixColor: Color = Color.Unspecified`	the suffix color for this text field when not focused
`disabledSuffixColor: Color = Color.Unspecified`	the suffix color for this text field when disabled
`errorSuffixColor: Color = Color.Unspecified`	the suffix color for this text field when in error state

contentPaddingWithLabel

Cmn

Added in 1.5.0-alpha11

fun contentPaddingWithLabel(
    start: Dp = TextFieldPadding,
    end: Dp = TextFieldPadding,
    top: Dp = TextFieldWithLabelVerticalPadding,
    bottom: Dp = TextFieldWithLabelVerticalPadding
): PaddingValues

Default content padding of the input field within the TextField when there is an inside label. Note that the top padding represents the padding above the label in the focused state. The input field is placed directly beneath the label.

Horizontal padding represents the distance between the input field and the leading/trailing icons (if present) or the horizontal edges of the container if there are no icons.

contentPaddingWithoutLabel

Cmn

Added in 1.5.0-alpha11

fun contentPaddingWithoutLabel(
    start: Dp = TextFieldPadding,
    top: Dp = TextFieldPadding,
    end: Dp = TextFieldPadding,
    bottom: Dp = TextFieldPadding
): PaddingValues

Default content padding of the input field within the TextField when the label is null or positioned TextFieldLabelPosition.Above.

Horizontal padding represents the distance between the input field and the leading/trailing icons (if present) or the horizontal edges of the container if there are no icons.

decorator

Cmn

Added in 1.4.0

@Composable
fun decorator(
    state: TextFieldState,
    enabled: Boolean,
    lineLimits: TextFieldLineLimits,
    outputTransformation: OutputTransformation?,
    interactionSource: InteractionSource,
    labelPosition: TextFieldLabelPosition = TextFieldLabelPosition.Attached(),
    label: (@Composable TextFieldLabelScope.() -> Unit)? = null,
    placeholder: (@Composable () -> Unit)? = null,
    leadingIcon: (@Composable () -> Unit)? = null,
    trailingIcon: (@Composable () -> Unit)? = null,
    prefix: (@Composable () -> Unit)? = null,
    suffix: (@Composable () -> Unit)? = null,
    supportingText: (@Composable () -> Unit)? = null,
    isError: Boolean = false,
    colors: TextFieldColors = colors(),
    contentPadding: PaddingValues = if (label == null || labelPosition is TextFieldLabelPosition.Above) {
                contentPaddingWithoutLabel()
            } else {
                contentPaddingWithLabel()
            },
    container: @Composable () -> Unit = {
            Container(
                enabled = enabled,
                isError = isError,
                interactionSource = interactionSource,
                colors = colors,
                shape = shape,
                focusedIndicatorLineThickness = FocusedIndicatorThickness,
                unfocusedIndicatorLineThickness = UnfocusedIndicatorThickness,
            )
        }
): TextFieldDecorator

A decorator used to create custom text fields based on Material Design filled text field.

If your text field requires customising elements that aren't exposed by TextField, such as the indicator line thickness, consider using this decorator to achieve the desired design.

For example, if you wish to customise the bottom indicator line, you can pass a custom Container to this decorator's container.

This decorator is meant to be used in conjunction with the overload of BasicTextField that accepts a TextFieldDecorator parameter. For other overloads of BasicTextField that use a decorationBox, see DecorationBox.

An example of building a custom text field using decorator:

import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.interaction.collectIsFocusedAsState
import androidx.compose.foundation.text.BasicTextField
import androidx.compose.foundation.text.input.TextFieldLineLimits
import androidx.compose.foundation.text.input.rememberTextFieldState
import androidx.compose.material3.LocalTextStyle
import androidx.compose.material3.Text
import androidx.compose.material3.TextField
import androidx.compose.material3.TextFieldDefaults
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.SolidColor
import androidx.compose.ui.graphics.takeOrElse
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.unit.dp

val state = rememberTextFieldState()
val interactionSource = remember { MutableInteractionSource() }
val customColors =
    TextFieldDefaults.colors(
        focusedTextColor = Color.DarkGray,
        unfocusedTextColor = Color.Gray,
        focusedIndicatorColor = Color.Blue,
        cursorColor = Color.Green,
    )
val enabled = true
val isError = false
val lineLimits = TextFieldLineLimits.SingleLine

val textColor =
    LocalTextStyle.current.color.takeOrElse {
        customColors.textColor(
            enabled = enabled,
            isError = isError,
            focused = interactionSource.collectIsFocusedAsState().value,
        )
    }

BasicTextField(
    state = state,
    modifier = Modifier,
    interactionSource = interactionSource,
    enabled = enabled,
    lineLimits = lineLimits,
    // Colors of non-decorator elements (such as text color or cursor color)
    // must be passed to BasicTextField
    textStyle = LocalTextStyle.current.merge(TextStyle(color = textColor)),
    cursorBrush = SolidColor(customColors.cursorColor),
    decorator =
        TextFieldDefaults.decorator(
            state = state,
            outputTransformation = null,
            lineLimits = lineLimits,
            enabled = enabled,
            isError = isError,
            interactionSource = interactionSource,
            container = {
                TextFieldDefaults.Container(
                    enabled = enabled,
                    isError = isError,
                    interactionSource = interactionSource,
                    colors = customColors,
                    // Update indicator line thickness
                    unfocusedIndicatorLineThickness = 2.dp,
                    focusedIndicatorLineThickness = 4.dp,
                )
            },
        ),
)

Parameters
`state: TextFieldState`	`TextFieldState` object that holds the internal editing state of the text field.
`enabled: Boolean`	the enabled state of the text field. When `false`, this decorator will appear visually disabled. This must be the same value that is passed to `BasicTextField`.
`lineLimits: TextFieldLineLimits`	whether the text field is `SingleLine` or `MultiLine`. This must be the same value that is passed to `BasicTextField`.
`outputTransformation: OutputTransformation?`	`OutputTransformation` that transforms how the contents of the text field are presented. This must be the same value that is passed to `BasicTextField`.
`interactionSource: InteractionSource`	the read-only `InteractionSource` representing the stream of `Interaction`s for this text field. You must first create and pass in your own `remember`ed `MutableInteractionSource` instance to the `BasicTextField` for it to dispatch events. And then pass the same instance to this decorator to observe `Interaction`s and customize the appearance/behavior of the text field in different states.
`labelPosition: TextFieldLabelPosition = TextFieldLabelPosition.Attached()`	the position of the label. See `TextFieldLabelPosition`.
`label: (@Composable TextFieldLabelScope.() -> Unit)? = null`	the optional label to be displayed with this text field. The default text style uses `Typography.bodySmall` when minimized and `Typography.bodyLarge` when expanded.
`placeholder: (@Composable () -> Unit)? = null`	the optional placeholder to be displayed when the input text is empty. The default text style uses `Typography.bodyLarge`.
`leadingIcon: (@Composable () -> Unit)? = null`	the optional leading icon to be displayed at the beginning of the text field container.
`trailingIcon: (@Composable () -> Unit)? = null`	the optional trailing icon to be displayed at the end of the text field container.
`prefix: (@Composable () -> Unit)? = null`	the optional prefix to be displayed before the input text in the text field.
`suffix: (@Composable () -> Unit)? = null`	the optional suffix to be displayed after the input text in the text field.
`supportingText: (@Composable () -> Unit)? = null`	the optional supporting text to be displayed below the text field.
`isError: Boolean = false`	indicates if the text field's current value is in an error state. When `true`, this decorator will display its contents in an error color.
`colors: TextFieldColors = colors()`	`TextFieldColors` that will be used to resolve the colors used for this text field decorator in different states. See `TextFieldDefaults.colors`. Note: This parameter only affects the colors of elements in the decoration box. Elements of the `BasicTextField` (such as text color or cursor color) are unaffected and must be changed using the relevant parameters of `BasicTextField`.
`contentPadding: PaddingValues = if (label == null \|\| labelPosition is TextFieldLabelPosition.Above) { contentPaddingWithoutLabel() } else { contentPaddingWithLabel() }`	the padding between the input field and the surrounding elements of the decorator. Note that the padding values may not be respected if they are incompatible with the text field's size constraints or layout. See `TextFieldDefaults.contentPaddingWithLabel` and `TextFieldDefaults.contentPaddingWithoutLabel`.
`container: @Composable () -> Unit = { Container( enabled = enabled, isError = isError, interactionSource = interactionSource, colors = colors, shape = shape, focusedIndicatorLineThickness = FocusedIndicatorThickness, unfocusedIndicatorLineThickness = UnfocusedIndicatorThickness, ) }`	the container to be drawn behind the text field. By default, this uses `Container`. Default colors for the container come from the `colors`.

indicatorLine

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha11

fun Modifier.indicatorLine(
    enabled: Boolean,
    isError: Boolean,
    interactionSource: InteractionSource,
    colors: TextFieldColors? = null,
    textFieldShape: Shape? = null,
    focusedIndicatorLineThickness: Dp = FocusedIndicatorThickness,
    unfocusedIndicatorLineThickness: Dp = UnfocusedIndicatorThickness
): Modifier

A modifier to draw a default bottom indicator line for TextField. You can apply it to a BasicTextField to create a custom text field based on the styling of a Material filled text field.

Consider using Container, which automatically applies this modifier as well as other text field container styling.

Parameters
`enabled: Boolean`	whether the text field is enabled
`isError: Boolean`	whether the text field's current value is in error
`interactionSource: InteractionSource`	the `InteractionSource` of the text field. Used to determine if the text field is in focus or not
`colors: TextFieldColors? = null`	`TextFieldColors` used to resolve colors of the text field. If `null`, defaults to `TextFieldDefaults.colors`.
`textFieldShape: Shape? = null`	the shape of the text field container. Used for clipping the indicator. If `null`, defaults to `TextFieldDefaults.shape`.
`focusedIndicatorLineThickness: Dp = FocusedIndicatorThickness`	thickness of the indicator line when the text field is focused
`unfocusedIndicatorLineThickness: Dp = UnfocusedIndicatorThickness`	thickness of the indicator line when the text field is not focused

outlinedTextFieldPadding

Cmn

Added in 1.5.0-alpha11

Deprecated in 1.5.0-alpha11

fun outlinedTextFieldPadding(
    start: Dp = TextFieldPadding,
    top: Dp = TextFieldPadding,
    end: Dp = TextFieldPadding,
    bottom: Dp = TextFieldPadding
): PaddingValues

textFieldWithLabelPadding

Cmn

Added in 1.5.0-alpha11

Deprecated in 1.5.0-alpha11

fun textFieldWithLabelPadding(
    start: Dp = TextFieldPadding,
    end: Dp = TextFieldPadding,
    top: Dp = TextFieldWithLabelVerticalPadding,
    bottom: Dp = TextFieldWithLabelVerticalPadding
): PaddingValues

textFieldWithoutLabelPadding

Cmn

Added in 1.5.0-alpha11

Deprecated in 1.5.0-alpha11

fun textFieldWithoutLabelPadding(
    start: Dp = TextFieldPadding,
    top: Dp = TextFieldPadding,
    end: Dp = TextFieldPadding,
    bottom: Dp = TextFieldPadding
): PaddingValues

Public properties

FocusedBorderThickness

Cmn

Added in 1.0.0

Deprecated in 1.1.0

val FocusedBorderThickness: Dp

FocusedIndicatorThickness

Cmn

Added in 1.1.0

val FocusedIndicatorThickness: Dp

The default thickness of the indicator line in TextField in focused state.

MinHeight

Cmn

Added in 1.0.0

val MinHeight: Dp

The default min height applied to a TextField. Note that you can override it by applying Modifier.heightIn directly on a text field.

MinWidth

Cmn

Added in 1.0.0

val MinWidth: Dp

The default min width applied to a TextField. Note that you can override it by applying Modifier.widthIn directly on a text field.

UnfocusedBorderThickness

Cmn

Added in 1.0.0

Deprecated in 1.1.0

val UnfocusedBorderThickness: Dp

UnfocusedIndicatorThickness

Cmn

Added in 1.1.0

val UnfocusedIndicatorThickness: Dp

The default thickness of the indicator line in TextField in unfocused state.

filledShape

Cmn

Added in 1.0.0

Deprecated in 1.1.0

val filledShape: Shape

outlinedShape

Cmn

Added in 1.0.0

Deprecated in 1.1.0

val outlinedShape: Shape

shape

Cmn

Added in 1.1.0

val shape: Shape

Default shape for a TextField.