Configura campos de texto

TextField permite a los usuarios ingresar y modificar texto. Existen dos tipos de campos de texto que puedes usar: campos de texto basados en el estado y campos de texto basados en valores. Selecciona el tipo para el que deseas mostrar contenido:

Te recomendamos que uses campos de texto basados en el estado, ya que proporcionan un enfoque más completo y confiable para administrar el estado de un TextField. En la siguiente tabla, se describen las diferencias entre estos tipos de campos de texto y se incluyen las ventajas clave que ofrecen los campos de texto basados en el estado:

Función

Campos de texto basados en valores

Campos de texto basados en el estado

Beneficios basados en el estado

Administración de estado

Actualiza el estado del campo de texto con la devolución de llamada onValueChange. Eres responsable de actualizar el value en tu propio estado según los cambios que informa onValueChange.

Usa explícitamente un objeto TextFieldState para administrar el estado de entrada de texto (valor, selección, composición). Este estado se puede recordar y compartir.
  • Se quitó la devolución de llamada onValueChange, lo que te impide introducir comportamientos asíncronos.
  • El estado sobrevive a la recomposición, la configuración y el cierre del proceso.

Transformación visual

Usa VisualTransformation para modificar cómo aparece el texto que se muestra. Por lo general, controla el formato de entrada y salida en un solo paso.

Usa InputTransformation para modificar la entrada del usuario antes de que se confirme en el estado y OutputTransformation para dar formato al contenido del campo de texto sin cambiar los datos de estado subyacentes.
  • Ya no necesitas proporcionar la asignación de offset entre el texto sin formato original y el texto transformado con OutputTransformation.

Límites de líneas

Acepta singleLine: Boolean, maxLines: Int y minLines: Int para controlar la cantidad de líneas.

Usa lineLimits: TextFieldLineLimits para configurar la cantidad mínima y máxima de líneas que puede ocupar el campo de texto.
  • Quita la ambigüedad cuando se configuran los límites de línea proporcionando un parámetro lineLimits de tipo TextFieldLineLimits.

Campo de texto seguro

N/A

SecureTextField es un elemento componible creado sobre campos de texto basados en el estado para escribir un campo de contraseña.
  • Te permite realizar optimizaciones para la seguridad en segundo plano y viene con una IU predefinida con textObfuscationMode.

En esta página, se describe cómo puedes implementar TextField, aplicar diseño a la entrada de TextField y configurar otras opciones de TextField, como las opciones del teclado y la transformación visual de la entrada del usuario.

Elige la implementación de TextField

Existen dos niveles de implementación de TextField:

  1. TextField es la implementación de Material Design. Te recomendamos que elijas esta implementación, ya que sigue los lineamientos de Material Design:
    • El estilo predeterminado está relleno.
    • OutlinedTextField es la versión de diseño con contorno.
  2. BasicTextField permite a los usuarios editar texto con el teclado en pantalla o físico, pero no proporciona decoraciones como sugerencias o marcadores de posición.

TextField(
    state = rememberTextFieldState(initialText = "Hello"),
    label = { Text("Label") }
)
StateBasedText.kt

Un campo de texto editable que contiene la palabra 

OutlinedTextField(
    state = rememberTextFieldState(),
    label = { Text("Label") }
)
StateBasedText.kt

Campo de texto editable, con la etiqueta y un borde púrpura.

Estilo TextField

TextField y BasicTextField comparten muchos parámetros comunes de personalización. La lista completa para TextField está disponible en el código fuente de TextField. Esta es una lista no exhaustiva de algunos de los parámetros útiles:

  • textStyle
  • lineLimits

TextField(
    state = rememberTextFieldState("Hello\nWorld\nInvisible"),
    lineLimits = TextFieldLineLimits.MultiLine(maxHeightInLines = 2),
    placeholder = { Text("") },
    textStyle = TextStyle(color = Color.Blue, fontWeight = FontWeight.Bold),
    label = { Text("Enter text") },
    modifier = Modifier.padding(20.dp)
)
StateBasedText.kt

Un TextField de varias líneas, con dos líneas editables más la etiqueta

Recomendamos usar TextField en lugar de BasicTextField cuando el diseño llame a un TextField o OutlinedTextField de Material. Sin embargo, BasicTextField debe usarse cuando se crean diseños que no necesitan las decoraciones de la especificación de Material.

Aplica estilo a la entrada con la API de Brush

Puedes usar la API de Brush para aplicar estilos más avanzados en tu TextField. En la siguiente sección, se describe cómo puedes usar un pincel para agregar un gradiente coloreado a la entrada de TextField.

Para obtener más información sobre el uso de la API de Brush para aplicar diseño al texto, consulta Habilita el diseño avanzado con la API de Brush.

Implementa gradientes de colores con TextStyle

Para implementar un gradiente de color mientras escribes en un TextField, configura el pincel que elijas como un TextStyle para tu TextField. En este ejemplo, usamos un pincel integrado con un linearGradient para ver el efecto de gradiente de arco iris a medida que se escribe el texto en TextField.

val brush = remember {
    Brush.linearGradient(
        colors = listOf(Color.Red, Color.Yellow, Color.Green, Color.Blue, Color.Magenta)
    )
}
TextField(
    state = rememberTextFieldState(), textStyle = TextStyle(brush = brush)
)
StateBasedText.kt

Usar buildAnnotatedString y SpanStyle, junto con linearGradient, para personalizar solo un fragmento de texto
Figura 1: Un efecto de gradiente de arcoíris para el contenido de TextField.

Administra el estado del campo de texto

TextField usa una clase de contenedor de estado dedicada llamada TextFieldState para su contenido y selección actual. TextFieldState está diseñado para elevarse dondequiera que se adapte a tu arquitectura. TextFieldState proporciona 2 propiedades principales:

  • initialText: Es el contenido de TextField.
  • initialSelection: Indica dónde se encuentra el cursor o la selección en ese momento.

Lo que diferencia a TextFieldState de otros enfoques, como la devolución de llamada onValueChange, es que TextFieldState encapsula por completo todo el flujo de entrada. Esto incluye usar las estructuras de datos de respaldo correctas, intercalar filtros y formateadores, y también sincronizar todos los cambios que provienen de diferentes fuentes.

Puedes usar TextFieldState() para elevar el estado en TextField. Para ello, te recomendamos que uses la función rememberTextFieldState(). rememberTextFieldState() crea la instancia de TextFieldState en tu elemento componible, garantiza que se recuerde el objeto de estado y proporciona la funcionalidad de guardar y restablecer integrada:

val usernameState = rememberTextFieldState()
TextField(
    state = usernameState,
    lineLimits = TextFieldLineLimits.SingleLine,
    placeholder = { Text("Enter Username") }
)
StateBasedText.kt

rememberTextFieldState puede tener un parámetro en blanco o un valor inicial que se pasa para representar el valor del texto en la inicialización. Si se pasa un valor diferente en una recomposición posterior, no se actualiza el valor del estado. Para actualizar el estado después de que se inicialice, llama a los métodos de edición en TextFieldState.

TextField(
    state = rememberTextFieldState(initialText = "Username"),
    lineLimits = TextFieldLineLimits.SingleLine,
)
StateBasedText.kt

Un TextField con el texto Username que aparece dentro del campo de texto.
Figura 2: TextField con "Nombre de usuario" como texto inicial.

Modifica el texto con TextFieldBuffer

Un TextFieldBuffer funciona como un contenedor de texto editable, similar en función a un StringBuilder. Contiene el contenido de texto y la información sobre la selección actual.

A menudo, se encuentra TextFieldBuffer como un alcance del receptor en funciones como TextFieldState.edit, InputTransformation.transformInput o OutputTransformation.transformOutput. En estas funciones, puedes leer o actualizar el TextFieldBuffer según sea necesario. Luego, estos cambios se confirman en TextFieldState o se pasan a la canalización de renderización en el caso de OutputTransformation.

Puedes usar funciones de edición estándar, como append, insert, replace o delete, para modificar el contenido del búfer. Para cambiar el estado de selección, configura directamente su variable selection: TextRange o usa funciones de utilidad, como placeCursorAtEnd o selectAll. La selección en sí está representada por un TextRange, en el que el índice de inicio es inclusivo y el índice de finalización es exclusivo. Un TextRange con valores de inicio y finalización idénticos, como (3, 3), indica una posición del cursor sin caracteres seleccionados actualmente.

val phoneNumberState = rememberTextFieldState()

LaunchedEffect(phoneNumberState) {
    phoneNumberState.edit { // TextFieldBuffer scope
        append("123456789")
    }
}

TextField(
    state = phoneNumberState,
    inputTransformation = InputTransformation { // TextFieldBuffer scope
        if (asCharSequence().isDigitsOnly()) {
            revertAllChanges()
        }
    },
    outputTransformation = OutputTransformation {
        if (length > 0) insert(0, "(")
        if (length > 4) insert(4, ")")
        if (length > 8) insert(8, "-")
    }
)
StateBasedText.kt

Editar texto en TextFieldState

Existen varios métodos que te permiten editar el estado directamente a través de tu variable de estado:

  • edit: Te permite editar el contenido del estado y te brinda funciones TextFieldBuffer para que puedas usar métodos como insert, replace, append y mucho más.

    val usernameState = rememberTextFieldState("I love Android")
// textFieldState.text : I love Android
// textFieldState.selection: TextRange(14, 14)
usernameState.edit { insert(14, "!") }
// textFieldState.text : I love Android!
// textFieldState.selection: TextRange(15, 15)
usernameState.edit { replace(7, 14, "Compose") }
// textFieldState.text : I love Compose!
// textFieldState.selection: TextRange(15, 15)
usernameState.edit { append("!!!") }
// textFieldState.text : I love Compose!!!!
// textFieldState.selection: TextRange(18, 18)
usernameState.edit { selectAll() }
// textFieldState.text : I love Compose!!!!
// textFieldState.selection: TextRange(0, 18)
    StateBasedText.kt

  • setTextAndPlaceCursorAtEnd: Borra el texto actual, lo reemplaza por el texto determinado y establece el cursor al final.

    usernameState.setTextAndPlaceCursorAtEnd("I really love Android")
// textFieldState.text : I really love Android
// textFieldState.selection : TextRange(21, 21)
    StateBasedText.kt

  • clearText: Borra todo el texto.

    usernameState.clearText()
// textFieldState.text :
// textFieldState.selection : TextRange(0, 0)
    StateBasedText.kt

Para ver otras funciones de TextFieldState, consulta la referencia de TextFieldState.

Cómo modificar la entrada del usuario

En las siguientes secciones, se describe cómo modificar la entrada del usuario. La transformación de entrada te permite filtrar la entrada TextField mientras el usuario escribe, mientras que la transformación de salida formatea la entrada del usuario antes de que se muestre en pantalla.

Filtra la entrada del usuario con transformaciones de entrada

Una transformación de entrada te permite filtrar la entrada del usuario. Por ejemplo, si tu TextField recibe un número de teléfono estadounidense, solo debes aceptar 10 dígitos. Los resultados de InputTransformation se guardan en TextFieldState.

Existen filtros integrados para casos de uso comunes de InputTransformation. Para limitar la longitud, llama a InputTransformation.maxLength():

TextField(
    state = rememberTextFieldState(),
    lineLimits = TextFieldLineLimits.SingleLine,
    inputTransformation = InputTransformation.maxLength(10)
)
StateBasedText.kt

Transformaciones de entrada personalizadas

InputTransformation es una interfaz de una sola función. Cuando implementes tu InputTransformation personalizado, deberás anular TextFieldBuffer.transformInput:

class CustomInputTransformation : InputTransformation {
    override fun TextFieldBuffer.transformInput() {
    }
}
StateBasedText.kt

Para un número de teléfono, agrega una transformación de entrada personalizada que solo permita que se escriban dígitos en TextField:

class DigitOnlyInputTransformation : InputTransformation {
    override fun TextFieldBuffer.transformInput() {
        if (!TextUtils.isDigitsOnly(asCharSequence())) {
            revertAllChanges()
        }
    }
}
StateBasedText.kt

Encadena transformaciones de entrada

Para agregar varios filtros a tu entrada de texto, encadena InputTransformation con la función de extensión then. Los filtros se ejecutan de forma secuencial. Como recomendación, aplica primero los filtros más selectivos para evitar transformaciones innecesarias en los datos que, en última instancia, se filtrarían.

TextField(
    state = rememberTextFieldState(),
    inputTransformation = InputTransformation.maxLength(6)
        .then(CustomInputTransformation()),
)
StateBasedText.kt

Después de agregar transformaciones de entrada, la entrada TextField acepta 10 dígitos como máximo.

Dale formato a la entrada antes de que se muestre

Los OutputTransformation te permiten dar formato a la entrada del usuario antes de que se renderice en la pantalla. A diferencia de InputTransformation, el formato que se realiza a través de OutputTransformation no se guarda en TextFieldState. En función del ejemplo de número de teléfono anterior, debes agregar paréntesis y guiones en los lugares adecuados:

Un número de teléfono estadounidense con el formato correcto, con paréntesis, guiones y los índices correspondientes.
Figura 3: Un número de teléfono estadounidense con el formato correcto y los índices correspondientes.

Esta es la forma actualizada de controlar los VisualTransformation en los TextField basados en valores, con la diferencia clave de que no tienes que calcular sus asignaciones de offset.

OutputTransformation es una interfaz de método abstracto único. Para implementar un OutputTransformation personalizado, debes anular el método transformOutput:

class CustomOutputTransformation : OutputTransformation {
    override fun TextFieldBuffer.transformOutput() {
    }
}
StateBasedText.kt

Para dar formato a un número de teléfono, agrega un paréntesis de apertura en el índice 0, un paréntesis de cierre en el índice 4 y un guion en el índice 8 a tu OutputTransformation:

class PhoneNumberOutputTransformation : OutputTransformation {
    override fun TextFieldBuffer.transformOutput() {
        if (length > 0) insert(0, "(")
        if (length > 4) insert(4, ")")
        if (length > 8) insert(8, "-")
    }
}
StateBasedText.kt

Luego, agrega tu OutputTransformation a TextField:

TextField(
    state = rememberTextFieldState(),
    outputTransformation = PhoneNumberOutputTransformation()
)
StateBasedText.kt

Cómo funcionan las transformaciones en conjunto

En el siguiente diagrama, se muestra el flujo de entrada de texto a la transformación y, luego, a la salida:

Una visualización de cómo la entrada de texto pasa por transformaciones antes de convertirse en salida de texto.
Figura 4: Un diagrama que muestra cómo la entrada de texto pasa por transformaciones antes de convertirse en salida de texto.
  1. La entrada se recibe de la fuente de entrada.
  2. La entrada se filtra a través de un InputTransformation, que se guarda en TextFieldState.
  3. La entrada se pasa a través de un OutputTransformation para aplicarle formato.
  4. La entrada se presenta en TextField.

Cómo configurar las opciones del teclado

TextField te permite establecer opciones de configuración del teclado, como el diseño, o bien habilitar la autocorrección si es compatible con el teclado. Es posible que algunas opciones no estén garantizadas si el teclado en pantalla no cumple con las opciones que se proporcionan aquí. Esta es la lista de las opciones de teclado compatibles:

  • capitalization
  • autoCorrect
  • keyboardType
  • imeAction

Recursos adicionales