OTPField
Preenchido
Vazio
Enviamos por SMS. Colar o código inteiro funciona.
import { OTPField } from '@rivocode/ui'Quando usar
Código de verificação, uma casa por dígito.
Colar o código inteiro funciona: a Base UI espalha os dígitos pelas casas em vez de jogar tudo na primeira. É quase sempre assim que o código chega, vindo do SMS ou do e-mail.
O teclado de números e o preenchimento pelo SMS já vêm prontos, num input escondido que guarda o código inteiro. As casas visíveis só mostram.
<Field className="w-fit max-w-full">
<FieldLabel>Código de verificação</FieldLabel>
<OTPField length={6} onValueChange={(codigo) => conferir(codigo)} />
</Field>
O FieldLabel em volta dá nome ao primeiro dígito, que é o que recebe o código
colado: a Base UI reserva o rótulo dele para o rótulo do campo, e as outras
casas se anunciam pela posição ("Dígito 2 de 6"). Na tela estreita as casas
encolhem até 32 pixels cada, em vez de empurrar a página para o lado.
Quando não usar
Só para código de uso único, que chega por SMS ou e-mail e vale por pouco
tempo. Senha, PIN guardado e qualquer segredo que a pessoa sabe de cor vão em
PasswordInput: as casas daqui mostram cada dígito, e o olho que revela e
esconde de novo é de lá.
Número longo com molde, como a linha digitável de um boleto ou o número do
cartão, é MaskedInput: uma casa por dígito, em quarenta e sete dígitos, vira
uma fila que ninguém confere.
No React Native
Traduz: o @rivocode/ui-native exporta OTPField - caixas visíveis, um campo escondido: teclado, autofill de SMS e leitor veem um só; o dígito aparece crescendo; label nomeia o campo. A API não é a mesma do web (no nativo tudo é controlado), e a tabela de paridade diz o que muda peça a peça.
O código que chega por SMS é sugerido pelo sistema: no iOS, acima do teclado; no Android, pelo preenchimento automático do Google. A peça pede os dois (textContentType e autoComplete).
API
| Prop | Tipo | Padrão |
|---|---|---|
autoComplete0.4.0O atributo `autocomplete` do campo. | string | "one-time-code" |
autoSubmit0.4.0Se o formulário é enviado quando o código fica completo. | boolean | false |
defaultValue0.4.0O código inicial, no modo não controlado. | string | sem padrão |
disabled0.4.0Se a peça deve ignorar a interação do usuário. | boolean | false |
form0.4.0O `form` ao qual o campo oculto está associado. | string | sem padrão |
inputMode0.4.0A dica de teclado virtual das casas e do campo oculto de validação. | "decimal""email""none""numeric""search""tel""text""url" | sem padrão |
labelsOs textos da peca, para trocar o idioma: `digit` e o nome de cada casa depois da primeira, que recebe a posicao contando de 1 e o total. | Partial<OTPFieldLabels> | sem padrão |
length0.4.0Quantas casas o codigo tem. | number | 6 |
mask0.4.0Se as casas escondem os caracteres digitados. | boolean | false |
name0.4.0Identifica o campo quando o formulário é enviado. | string | sem padrão |
normalizeValue0.4.0Função que normaliza o código depois de tirar os espaços e aplicar o `validationType`. | ((value: string) => string) | sem padrão |
onValueChange0.4.0Chamado quando o código muda. | ((value: string, eventDetails: OTPFieldRootChangeEventDetails) => void) | sem padrão |
onValueComplete0.4.0Chamado quando o código fica completo, ou quando se cola um código completo sobre outro já completo. | ((value: string, eventDetails: OTPFieldRootCompleteEventDetails) => void) | sem padrão |
onValueInvalid0.4.0Chamado quando o texto digitado tem caracteres que a validação ou a normalização recusam, antes de o código mudar. | ((value: string, eventDetails: OTPFieldRootInvalidEventDetails) => void) | sem padrão |
readOnly0.4.0Se o usuário fica impedido de mudar o valor do campo. | boolean | false |
render0.4.0Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente. | ComponentRenderFn<HTMLProps, OTPFieldRootState> | ReactElement<unknown, string | JSXElementConstructor<any>> | sem padrão |
required0.4.0Se o usuário precisa preencher um valor antes de enviar o formulário. | boolean | false |
validationType0.4.0O tipo de validação aplicada ao código. | OTPValidationType | "numeric" |
value0.4.0O código. | string | sem padrão |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.