Pular para o conteúdo
Formulário

NumberField

/componentes/number-field.mdmarkdown cru, para quem lê com agent em vez de olho

Com rótulo

De 1 a 12, sem juros.

Desabilitado

Importar
import { NumberField } from '@rivocode/ui'

Quando usar

Campo de número com mais e menos.

Use quando o valor tem passo e limite conhecidos: quantidade, parcelas, dias de prazo. Dinheiro não é daqui, e a seção "Quando não usar" diz para onde vai.

O Input cru continua servindo para número solto. A diferença aqui é que seta do teclado, rolagem e os botões respeitam min, max e step, o campo nunca chega num valor que o formulário rejeita depois.

A moldura tem a altura do Input do mesmo size, e o campo veste [−][número][+] com o número no meio: é a exceção escrita do padrão do campo, que põe o texto na coluna do Input. Com um botão de cada lado, o polegar acha o menos e o mais sem mirar, e o celular desenha igual.

<Field>
  <FieldLabel>Parcelas</FieldLabel>
  <NumberField defaultValue={3} min={1} max={12} />
  <FieldDescription>De 1 a 12, sem juros.</FieldDescription>
</Field>

Quando não usar

Para dinheiro, use CurrencyInput: ele entra e sai em centavos inteiros e digita da direita para a esquerda, e o mais e o menos não têm sentido num valor em reais. Número que é documento ou código (CPF, CEP, telefone) não é quantidade, e vai em MaskedInput: ninguém soma um ao CEP.

Para uma faixa contínua, em que a posição importa mais que o valor exato, o Slider lê melhor. E a nota em estrelas é Rating.

iOS e Android

No iOS, com min negativo, o campo abre o teclado de números e pontuação, porque o teclado numérico do iOS não tem sinal de menos; no Android abre o numérico, que tem o sinal. É o único ponto em que os dois sistemas ficam diferentes, e é limite do teclado, não da peça. Para os dois ficarem iguais, use os botões de mais e menos da peça para cruzar o zero.

No React Native

Traduz, e vira stepper: menos, valor, mais, que é o idioma do toque. O min nasce em 0, e no web ele nasce sem piso. Não é descuido: o teclado numérico do iPhone (number-pad) não tem sinal de menos, então o número negativo só chegaria pelo botão de menos, e um campo que desce abaixo de zero por toque e não deixa digitar o mesmo valor é pior do que um campo que para no zero. Para aceitar negativo, passe min negativo: o stepper desce até ele, o campo aceita o sinal de menos digitado e troca para um teclado que tem o sinal.

Digitando, o max vale a cada tecla e o min só na saída do campo: com min={10}, digitar 25 passa pelo 2 sem virar 10. Com step fracionário o teclado vira decimal-pad, vírgula e ponto valem como separador, como no web, e o passo sai com as casas dele: 0,2 mais 0,1 dá 0,3. O mais e o menos partem do que está digitado, e um valor que chega de fora no meio da digitação aparece na hora. O resto da API também muda (no nativo tudo é controlado), e a tabela de paridade diz o que muda peça a peça.

API

PropTipoPadrão
allowOutOfRange0.4.0

Com `true`, o texto digitado pode sair do intervalo `min`/`max` sem ser cortado, e a validação nativa de faixa acusa.

booleanfalse
allowWheelScrub0.4.0

Se a roda do mouse muda o valor com o campo em foco e o ponteiro sobre ele.

booleanfalse
defaultValue0.4.0

O valor inicial do campo, no modo não controlado.

numbersem padrão
disabled0.4.0

Se a peça deve ignorar a interação do usuário.

booleanfalse
form0.4.0

Identifica o formulário dono do campo oculto.

stringsem padrão
inputRef0.4.0

Uma ref para acessar o campo oculto.

Ref<HTMLInputElement>sem padrão
labels

Os textos da peca, para trocar o idioma: `decrement` e `increment` sao os nomes dos dois botoes de passo.

Partial<NumberFieldLabels>sem padrão
largeStep0.4.0

O passo grande, usado com a tecla Shift apertada.

number10
locale0.4.0

O idioma do campo.

LocalesArgumentsem padrão
max0.4.0

O maior valor do campo.

numbersem padrão
min0.4.0

O menor valor do campo.

numbersem padrão
name0.4.0

Identifica o campo quando o formulário é enviado.

stringsem padrão
numberFormat0.5.0

As opcoes do `Intl.NumberFormat`.

NumberFormatOptionssem padrão
onValueChange0.4.0

Chamado quando o número muda.

((value: number | null, eventDetails: NumberFieldRootChangeEventDetails) => void)sem padrão
onValueCommitted0.4.0

Chamado quando o valor é confirmado.

((value: number | null, eventDetails: NumberFieldRootCommitEventDetails) => void)sem padrão
placeholder0.4.0stringsem padrão
readOnly0.4.0

Se o usuário fica impedido de mudar o valor do campo.

booleanfalse
render0.4.0

Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente.

ComponentRenderFn<HTMLProps, NumberFieldRootState> | ReactElement<unknown, string | JSXElementConstructor<any>>sem padrão
required0.4.0

Se o usuário precisa preencher um valor antes de enviar o formulário.

booleanfalse
size0.4.0"lg""md""sm""md"
smallStep0.4.0

O passo pequeno, usado com a tecla Alt apertada.

number0.1
snapOnStep0.4.0

Se o valor se ajusta ao passo mais próximo ao somar ou subtrair.

booleanfalse
step0.4.0

Quanto soma ou subtrai com os botões, com as setas ou arrastando o ponteiro na área de arraste.

number | "any"1
value0.4.0

O número cru do campo.

number | nullsem padrão

Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.

@rivocode/ui, 149 peças no catálogo. Esta página é gerada dos mesmos arquivos que alimentam o design system, então ela não envelhece sozinha.

Feito por RivoCode.