ATLTextInputBase
Para visitar a documentação de design, clique aqui
Props
value
onChange
errorText
helpText
leftAdornment
leftIcon
rightAdornment
rightButtonIcon
title
onPressRightIcon
disabled
disabledText
hideClearButton
isInputFocused
required
showCounter
showVisibilityToggle
autoCapitalize
keyboardType
maxLength
multiline
returnKeyType
boxColor
disabledOpacity
errorColor
focusColor
labelColor
leftIconColor
value
Valor de texto que será exibido no input.
Tipo | Obrigatório |
---|---|
string | Não |
onChange
Handler que será chamado quando o usuário mudar o texto.
Tipo | Obrigatório |
---|---|
function | Não |
errorText
Texto de erro que, caso fornecido, aparece no lugar do helpText
em vermelho. Também faz com que a linha divisora em baixo do input e o título do campo fiquem vermelhos.
Tipo | Obrigatório |
---|---|
string | Não |
helpText
Texto de ajuda para auxiliar o usuário no fornecimento de informações, aparece à esquerda abaixo da linha.
Tipo | Obrigatório |
---|---|
string | Não |
leftAdornment
Texto fixo que aparece à esquerda do campo, geralmente utilizado para exibir unidades.
Tipo | Obrigatório |
---|---|
string | Não |
leftIcon
Ícone decorativo que aparece à esquerda do campo e pode ajudar a indicar seu tipo ou função.
Tipo | Obrigatório |
---|---|
ImageSourcePropType | Não |
rightAdornment
Texto fixo que aparece à direita do campo, geralmente utilizado para exibir unidades.
Tipo | Obrigatório |
---|---|
string | Não |
rightButtonIcon
Imagem do botão opcional que aparece à direita do campo, em cima da linha divisora.
Tipo | Obrigatório |
---|---|
ImageSourcePropType | Não |
title
Título do campo que também serve como placeholder, caso fornecido.
Tipo | Obrigatório |
---|---|
string | Não |
onPressRightIcon
Handler que será chamado quando o usuário apertar o botão com ícone à direita do campo.
Tipo | Obrigatório |
---|---|
function | Não |
disabled
Se for true
, desabilita todas as interações com o componente.
Tipo | Obrigatório |
---|---|
boolean | Não |
disabledText
Se for true
, desabilita apenas as interações com o campo de texto, ou seja, não é possível digitar.
Tipo | Obrigatório |
---|---|
boolean | Não |
hideClearButton
Se for true
, deixa de exibir o botão de limpar quando a digitação é iniciada.
Tipo | Obrigatório |
---|---|
boolean | Não |
isInputFocused
Se for true
, inicia a tela com o campo focado.
Tipo | Obrigatório |
---|---|
boolean | Não |
required
Se for true
, adiciona um asterisco ao lado do título do campo.
Tipo | Obrigatório |
---|---|
boolean | Não |
showCounter
Se for true
, mostra um contador de caracteres digitados. Caso haja um número máximo de caracteres, mostra esse valor também.
Tipo | Obrigatório |
---|---|
boolean | Não |
showVisibilityToggle
Se for true
, mostra um botão de alterar visibilidade do campo.
Tipo | Obrigatório |
---|---|
boolean | Não |
autoCapitalize
Tipo de capitalização de caracteres para o campo.
Tipo | Obrigatório |
---|---|
AutoCapitalizeEnum | Não |
Os possíveis tipos de AutoCapitalizeEnum
são:
- characters
- words
- sentences
- none
keyboardType
Tipo de teclado que aparece para cada campo.
Tipo | Obrigatório |
---|---|
KeyboardTypeEnum | Não |
Os possíveis tipos de KeyboardTypeEnum
são:
- default
- numberPad
- decimalPad
- numeric
- emailAddress
- phonePad
Para uma referência visual dos tipos, clique aqui
maxLength
Número máximo de caracteres do campo. Quando o usuário atingir esse número, os próximos caracteres digitados são ignorados.
Tipo | Obrigatório |
---|---|
number | Não |
multiline
Se for true
, permite múltiplas linhas no campo. Caso contrário, a digitação rola para a direita.
Tipo | Obrigatório |
---|---|
boolean | Não |
returnKeyType
Tipo de tecla de retorno que aparece para cada campo.
Tipo | Obrigatório |
---|---|
ReturnKeyTypeEnum | Não |
Os possíveis tipos de ReturnKeyTypeEnum
são:
- done
- go
- next
- search
- send
boxColor
Cor da linha, do texto sendo escrito e do ícone da direita.
Tipo | Obrigatório |
---|---|
string | Não |
disabledOpacity
Porcentagem da opacidade com a qual o átomo será coberto caso esteja desabilitado.
Tipo | Obrigatório |
---|---|
number | Não |
errorColor
Cor da mensagem de erro. A linha divisora também fica dessa cor quando há um erro.
Tipo | Obrigatório |
---|---|
string | Não |
focusColor
Cor que a linha e o texto com o título do campo adotam quando ele está focado.
Tipo | Obrigatório |
---|---|
string | Não |
labelColor
Cor do placeholder, contador e mensagem de ajuda.
Tipo | Obrigatório |
---|---|
string | Não |
leftIconColor
Cor da imagem do ícone que fica à esquerda do campo.
Tipo | Obrigatório |
---|---|
string | Não |