TextField
Outlined text input to get an input value from the user.
Parameters
the input TextFieldValue to be shown in the text field
the callback that is triggered when the input service updates values in TextFieldValue. An updated TextFieldValue comes as a parameter of the callback
a Modifier for this text field
True controls the enabled state of the TextField. When false, the text field will be neither editable nor focusable, the input of the text field will not be selectable, visually text field will appear in the disabled UI state
controls the editable state of the TextField. 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
add an asterisk to the label to indicate that this field is required and read it as "label mandatory" but doesn't do anything else so it's up to the developer to handle the behavior.
the optional label to be displayed inside the text field container. The default text style for internal Text is SparkTypography.body2 when the text field is in focus and SparkTypography.body1 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 SparkTypography.body1
The optional helper text to be displayed at the bottom outside the text input container that give some information about expected text
The optional counter to be displayed the the end bottom outside the text input container
the optional leading icon to be displayed at the beginning of the text field container
the optional trailing icon to be displayed at the end of the text field container
indicates the validation state of the text field. The label, outline, leading & trailing content are tinted by the state color.
the optional state text to be displayed at the helper position that give more information about the state, it's displayed only when state is not null.
transforms the visual representation of the input value For example, you can use 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
the MutableInteractionSource representing the stream of Interactions for this TextField. You can create and pass in your own remembered MutableInteractionSource if you want to observe Interactions and customize the appearance / behavior of this TextField in different Interactions.
See also
Outlined text input to get an input value from the user.
Parameters
the input 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
a Modifier for this text field
True controls the enabled state of the TextField. When false, the text field will be neither editable nor focusable, the input of the text field will not be selectable, visually text field will appear in the disabled UI state
controls the editable state of the TextField. 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
add an asterisk to the label to indicate that this field is required and read it as "label mandatory" but doesn't do anything else so it's up to the developer to handle the behavior.
the optional label to be displayed inside the text field container. The default text style for internal Text is SparkTypography.body2 when the text field is in focus and SparkTypography.body1 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 SparkTypography.body1
The optional helper text to be displayed at the bottom outside the text input container that give some information about expected text
The optional counter to be displayed the the end bottom outside the text input container
the optional leading icon to be displayed at the beginning of the text field container, note that
the optional trailing icon to be displayed at the end of the text field container
indicates the validation state of the text field. The label, outline, leading & trailing content are tinted by the state color.
the optional state text to be displayed at the helper position that give more information about the state, it's displayed only when state is not null.
transforms the visual representation of the input value For example, you can use 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
the MutableInteractionSource representing the stream of Interactions for this TextField. You can create and pass in your own remembered MutableInteractionSource if you want to observe Interactions and customize the appearance / behavior of this TextField in different Interactions.
See also
Outlined text input to get an input value from the user using the new TextFieldState API. All the editing state of this composable is hoisted through state. Whenever the contents of
this composable change via user input or semantics, TextFieldState.text gets updated.
Similarly, all the programmatic updates made to state also reflect on this composable.
Parameters
the TextFieldState that manages the text field's state
a Modifier for this text field
True controls the enabled state of the TextField. When false, the text field will be neither editable nor focusable, the input of the text field will not be selectable, visually text field will appear in the disabled UI state
controls the editable state of the TextField. 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
Optional InputTransformation that will be used to transform changes to the TextFieldState made by the user. The transformation will be applied to changes made by hardware and software keyboard events, pasting or dropping text, accessibility services, and tests. The transformation will not be applied when changing the state programmatically, or when the transformation is changed. If the transformation is changed on an existing text field, it will be applied to the next user edit. the transformation will not immediately affect the current state.
the style to be applied to the input text
software keyboard options that contains configuration such as KeyboardType and ImeAction
Called when the user presses the action button in the input method editor (IME), or by pressing the enter key on a hardware keyboard. By default this parameter is null, and would execute the default behavior for a received IME Action e.g., ImeAction.Done would close the keyboard, ImeAction.Next would switch the focus to the next focusable item on the screen.
the limits for the number of lines in the text field
callback that is executed when the text layout is calculated
the MutableInteractionSource representing the stream of Interactions for this TextField. You can create and pass in your own remembered MutableInteractionSource if you want to observe Interactions and customize the appearance / behavior of this TextField in different Interactions.
transforms the output text before it is displayed
the scroll state for the text field