Configurar campos de texto

TextField permite que os usuários insiram e modifiquem o texto. Há dois tipos de campos de texto que podem ser usados: campos de texto com base em estado e campos de texto com base em valor. Selecione o tipo de conteúdo que você quer exibir:

Campos de texto baseados em estado Campos de texto baseados em valor

Recomendamos usar campos de texto baseados em estado, porque eles oferecem uma abordagem mais completa e confiável para gerenciar o estado de um TextField. A tabela a seguir descreve as diferenças entre esses tipos de campos de texto e inclui as principais vantagens que os campos de texto baseados em estado oferecem:

Experimental: os campos de texto baseados em estado dependem da versão 1.4.0-alpha14 do Material 3. Informe bugs no Issue Tracker.

Recurso	Campos de texto com base no valor	Campos de texto baseados em estado	Benefício estadual
Gerenciamento do estado	Atualiza o estado do campo de texto com o callback onValueChange. Você é responsável por atualizar o value no seu próprio estado com base nas mudanças informadas por onValueChange.	Usa explicitamente um objeto TextFieldState para gerenciar o estado de entrada de texto (valor, seleção, composição). Esse estado pode ser lembrado e compartilhado.	O callback onValueChange foi removido, o que impede a introdução de comportamentos assíncronos. O estado sobrevive à recomposição, à configuração e ao encerramento do processo.
Transformação visual	Usa VisualTransformation para modificar a aparência do texto exibido. Isso geralmente processa a formatação de entrada e saída em uma única etapa.	Usa InputTransformation para modificar a entrada do usuário antes de ela ser confirmada no estado e OutputTransformation para formatar o conteúdo do campo de texto sem mudar os dados de estado subjacentes.	Não é mais necessário fornecer o mapeamento de deslocamento entre o texto bruto original e o texto transformado com OutputTransformation.
Limites de linha	Aceita singleLine: Boolean, maxLines: Int e minLines: Int para controlar o número de linhas.	Usa lineLimits: TextFieldLineLimits para configurar o número mínimo e máximo de linhas que o campo de texto pode ocupar.	Remove a ambiguidade ao configurar limites de linha fornecendo um parâmetro lineLimits do tipo TextFieldLineLimits.
Campo de texto seguro	N/A	SecureTextField é um elemento combinável criado com base em campos de texto baseados em estado para escrever um campo de senha.	Permite otimizar a segurança por baixo dos panos e vem com uma interface predefinida com textObfuscationMode.

Nesta página, descrevemos como implementar TextField, estilizar a entrada de TextField e configurar outras opções de TextField, como opções de teclado e transformação visual da entrada do usuário.

Escolher a implementação do TextField

Há dois níveis de implementação do TextField:

1. TextField é a implementação do Material Design. Recomendamos que você escolha essa implementação, que segue as diretrizes do Material Design (link em inglês):
   • O estilo padrão é sólido
   • OutlinedTextField é a versão de estilo delineada.
2. O BasicTextField permite que os usuários editem o texto usando o teclado de software ou hardware, mas não oferece decorações como dicas ou marcadores de posição.

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

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

Estilo TextField

TextField e BasicTextField compartilham muitos parâmetros comuns para personalização. A lista completa do TextField está disponível no código-fonte do TextField. Confira uma lista não exaustiva de alguns parâmetros úteis:

• 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

Recomendamos o uso de TextField em vez de BasicTextField quando o design chama um TextField ou OutlinedTextField do Material. No entanto, use BasicTextField ao criar designs que não precisam das decorações da especificação do Material Design.

Configurar limites de linha

Os elementos combináveis TextField oferecem suporte à rolagem em um único eixo. O comportamento de rolagem é determinado pelo parâmetro lineLimits. Os TextFields configurados para uma única linha rolam horizontalmente, enquanto os TextFields de várias linhas rolam verticalmente.

Use TextFieldLineLimits para escolher a configuração de linha adequada para seu TextField:

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

A configuração SingleLine tem as seguintes características:

• O texto nunca é quebrado e não permite novas linhas.
• TextField sempre tem uma altura fixa.
• Se o texto transbordar, ele vai rolar horizontalmente.

TextField(
    state = rememberTextFieldState("Hello\nWorld\nHello\nWorld"),
    lineLimits = TextFieldLineLimits.MultiLine(1, 4)
)
StateBasedText.kt

A configuração MultiLine tem as seguintes características:

• Aceita dois parâmetros: minHeightInLines e maxHeightInLines.
• O campo de texto tem pelo menos minHeightInLines de altura.
• Se o texto transbordar, ele será quebrado.
• Se o texto precisar de mais linhas, o campo vai crescer até ter uma altura de maxHeightInLines e rolar verticalmente.

Estilizar entrada com a API Brush

Use a API Brush para estilização mais avançada no seu TextField. A seção a seguir descreve como usar um pincel para adicionar um gradiente colorido à entrada TextField.

Para mais informações sobre como usar a API Brush para estilizar texto, consulte Ativar a estilização avançada com a API Brush.

Implementar gradientes coloridos usando TextStyle

Para implementar um gradiente colorido enquanto você digita em um TextField, defina o pincel de sua escolha como um TextStyle para seu TextField. Neste exemplo, usamos um pincel integrado com um linearGradient para conferir o efeito de gradiente de arco-íris à medida que o texto é digitado no 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

Figura 1. Um efeito gradiente de arco-íris para conteúdo de TextField.

Gerenciar o estado do campo de texto

O TextField usa uma classe de detentor de estado dedicada chamada TextFieldState para o conteúdo e a seleção atual. O TextFieldState foi projetado para ser içado onde quer que se encaixe na sua arquitetura. Há duas propriedades principais fornecidas por TextFieldState:

• initialText: conteúdo do TextField.
• initialSelection: indica onde o cursor ou a seleção está no momento.

O que diferencia o TextFieldState de outras abordagens, como o callback onValueChange, é que o TextFieldState encapsula totalmente todo o fluxo de entrada. Isso inclui usar as estruturas de dados de suporte corretas, filtros e formatadores em linha e também sincronizar todas as edições de diferentes fontes.

Observação: embora TextFieldState pertença ao módulo Foundation do Compose, ele não tem dependências de UI e foi projetado para ser um holder de estado eficiente. O TextFieldState usa apenas estruturas de dados fornecidas pelo sistema de snapshots do Compose. É recomendável instanciar e manter instâncias de TextFieldState nos ViewModels.

Você pode usar TextFieldState() para elevar o estado em TextField. Para isso, recomendamos usar a função rememberTextFieldState(). O rememberTextFieldState() cria a instância TextFieldState no seu elemento combinável, garante que o objeto de estado seja lembrado e oferece funcionalidade integrada de salvar e restaurar:

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

rememberTextFieldState pode ter um parâmetro em branco ou um valor inicial transmitido para representar o valor do texto na inicialização. Se um valor diferente for transmitido em uma recomposição subsequente, o valor do estado não será atualizado. Para atualizar o estado depois que ele é inicializado, chame os métodos de edição em TextFieldState.

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

Figura 2. TextField com "Nome de usuário" como o texto inicial.

Modificar texto com o TextFieldBuffer

Um TextFieldBuffer funciona como um contêiner de texto editável, semelhante em função a um StringBuilder. Ele contém o conteúdo do texto e informações sobre a seleção atual.

É comum encontrar TextFieldBuffer como um escopo de receptor em funções como TextFieldState.edit, InputTransformation.transformInput ou OutputTransformation.transformOutput. Nessas funções, é possível ler ou atualizar o TextFieldBuffer conforme necessário. Depois, essas mudanças são confirmadas em TextFieldState ou transmitidas para o pipeline de renderização no caso de OutputTransformation.

É possível usar funções de edição padrão, como append, insert, replace ou delete, para modificar o conteúdo do buffer. Para mudar o estado de seleção, defina diretamente a variável selection: TextRange ou use funções utilitárias, como placeCursorAtEnd ou selectAll. A seleção em si é representada por um TextRange, em que o índice inicial é inclusivo e o índice final é exclusivo. Um TextRange com valores inicial e final idênticos, como (3, 3), significa uma posição do cursor sem caracteres selecionados no momento.

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 em TextFieldState

Há vários métodos que permitem editar o estado diretamente pela variável de estado:

• edit: permite editar o conteúdo do estado e oferece funções TextFieldBuffer para que você possa usar métodos como insert, replace, append e muito mais.

  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: limpa o texto atual, substitui pelo texto fornecido e define o cursor no final.

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

• clearText: limpa todo o texto.

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

Para outras funções TextFieldState, consulte a referência TextFieldState.

Modificar a entrada do usuário

As seções a seguir descrevem como modificar a entrada do usuário. A transformação de entrada permite filtrar a entrada TextField enquanto o usuário digita, e a transformação de saída formata a entrada do usuário antes de ela ser exibida na tela.

Filtrar a entrada do usuário com transformações de entrada

Com uma transformação de entrada, é possível filtrar a entrada do usuário. Por exemplo, se o TextField aceitar um número de telefone americano, você só vai querer aceitar 10 dígitos. Os resultados do InputTransformation são salvos no TextFieldState.

Observação: não mude o estado dentro da chamada InputTransformation.transformInput(). Em vez disso, use o escopo do receptor TextFieldBuffer para editar o texto.

Há filtros integrados para casos de uso comuns do InputTransformation. Para limitar o tamanho, chame InputTransformation.maxLength():

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

Transformações de entrada personalizadas

InputTransformation é uma interface de função única. Ao implementar seu InputTransformation personalizado, você precisa substituir TextFieldBuffer.transformInput:

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

Para um número de telefone, adicione uma transformação de entrada personalizada que permita apenas dígitos serem digitados no TextField:

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

Encadear transformações de entrada

Para adicionar vários filtros à entrada de texto, encadeie InputTransformations usando a função de extensão then. Os filtros são executados em sequência. Como prática recomendada, aplique primeiro os filtros mais seletivos para evitar transformações desnecessárias em dados que seriam filtrados.

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

Depois de adicionar transformações de entrada, a entrada TextField aceita no máximo 10 dígitos.

Formatar a entrada antes da exibição

Os OutputTransformations permitem formatar a entrada do usuário antes de ela ser renderizada na tela. Ao contrário do InputTransformation, a formatação feita pelo OutputTransformation não é salva no TextFieldState. Com base no exemplo anterior de número de telefone, adicione parênteses e traços nos lugares apropriados:

Figura 3. Um número de telefone americano com formatação adequada e índices correspondentes.

Essa é a maneira atualizada de processar VisualTransformations em TextFields baseados em valor. A principal diferença é que você não precisa calcular os mapeamentos de deslocamento.

OutputTransformation é uma interface de método abstrato único. Para implementar um OutputTransformation personalizado, substitua o método transformOutput:

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

Para formatar um número de telefone, adicione um parêntese de abertura no índice 0, um de fechamento no índice 4 e um traço no índice 8 ao seu 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

Em seguida, adicione seu OutputTransformation ao TextField:

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

Como as transformações funcionam juntas

O diagrama a seguir mostra o fluxo da entrada de texto até a transformação e a saída:

Figura 4. Um diagrama mostrando como a entrada de texto passa por transformações antes de se tornar uma saída de texto.

1. A entrada é recebida da fonte de entrada.
2. A entrada é filtrada por um InputTransformation, que é salvo no TextFieldState.
3. A entrada é transmitida por um OutputTransformation para formatação.
4. A entrada é apresentada no TextField.

Definir opções do teclado

O TextField permite definir opções de configuração do teclado, como o layout dele, ou ativar a correção automática, caso haja suporte. Algumas opções podem não ser garantidas se o teclado de software não estiver de acordo com as opções apresentadas aqui. Confira a lista de opções de teclado com suporte:

• capitalization
• autoCorrect
• keyboardType
• imeAction

A classe KeyboardOptions agora inclui um novo parâmetro booleano, showKeyboardOnFocus, que você usa especificamente para componentes TextField integrados ao TextFieldState. Essa opção controla o comportamento do teclado de software quando o TextField recebe o foco por meios diferentes da interação direta do usuário (por exemplo, de forma programática).

Quando KeyboardOptions.showKeyboardOnFocus é definido como verdadeiro, o teclado virtual não aparece automaticamente se o TextField ganha foco indiretamente. Nesses casos, o usuário precisa tocar explicitamente no TextField para abrir o teclado.

Definir a lógica de interação do teclado

O botão de ação no teclado de software do Android permite respostas interativas no seu aplicativo. Para mais informações sobre como configurar o botão de ação, consulte a seção Definir opções de teclado.

Figura 5. Botão de ação do teclado de software.

Para definir o que acontece quando um usuário toca nesse botão de ação, use o parâmetro onKeyboardAction. Esse parâmetro aceita uma interface funcional opcional chamada KeyboardActionHandler. A interface KeyboardActionHandler contém um único método, onKeyboardAction(performDefaultAction: () -> Unit). Ao fornecer uma implementação para esse método onKeyboardAction, você pode introduzir uma lógica personalizada que é executada quando um usuário pressiona o botão de ação do teclado.

Vários tipos de ações padrão do teclado vêm com comportamentos padrão integrados. Por exemplo, selecionar ImeAction.Next ou ImeAction.Previous como o tipo de ação muda o foco para o campo de entrada seguinte ou anterior, respectivamente. Da mesma forma, um botão de ação definido como ImeAction.Done geralmente dispensa o teclado virtual. Essas funcionalidades padrão são executadas automaticamente e não exigem que você forneça um KeyboardActionHandler.

Além dessas ações padrão, também é possível implementar um comportamento personalizado. Quando você fornece seu KeyboardActionHandler, o método onKeyboardAction dele recebe uma função performDefaultAction. Você pode chamar essa função performDefaultAction() a qualquer momento na sua lógica personalizada para também acionar o comportamento padrão associado à ação do IME atual.

TextField(
    state = textFieldViewModel.usernameState,
    keyboardOptions = KeyboardOptions(imeAction = ImeAction.Next),
    onKeyboardAction = { performDefaultAction ->
        textFieldViewModel.validateUsername()
        performDefaultAction()
    }
)
StateBasedText.kt

Este snippet ilustra um caso de uso comum em uma tela de registro com um campo de nome de usuário. Para esse campo, ImeAction.Next é selecionado para o botão de ação do teclado. Essa escolha permite uma navegação rápida e perfeita para o campo de senha seguinte.

Além dessa navegação padrão, é necessário iniciar um processo de validação em segundo plano para o nome de usuário à medida que o usuário insere a senha. Para garantir que o comportamento padrão de troca de foco inerente ao ImeAction.Next seja mantido junto com essa lógica de validação personalizada, a função performDefaultAction() é invocada. Chamar performDefaultAction() aciona implicitamente o sistema de gerenciamento de foco subjacente para mover o foco para o próximo elemento de interface adequado, preservando o fluxo de navegação esperado.

Criar um campo de senha segura

SecureTextField é um elemento combinável criado com base em campos de texto baseados em estado para escrever um campo de senha. Recomendamos usar SecureTextField para criar campos de texto de senha, porque ele oculta a entrada de caracteres por padrão e desativa as ações de cortar e copiar.

SecureTextField tem um textObfuscationMode, que controla como o usuário vê a entrada de caracteres. textObfuscationMode tem as seguintes opções:

• Hidden: oculta toda a entrada. Comportamento padrão em plataformas para computador.

  

• Visible: mostra toda a entrada.

  

• RevealLastTyped: oculta toda a entrada, exceto o último caractere. Comportamento padrão em dispositivos móveis.

  

Outros recursos

• Formatar automaticamente um número de telefone em um campo de texto
• Mostrar ou ocultar a senha com base em uma alternância do usuário
• Validar a entrada enquanto o usuário digita