Pular para o conteúdo
Feedback

Meter

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

Capacidade

Projetos do plano
x
Espaço de arquivos
x
Assentos da equipe
x
Importar
import { Meter } from '@rivocode/ui'

Quando usar

Medida de quanto de uma capacidade está em uso: espaço, cota, limite.

<Meter value={72} max={100} label="Espaço de arquivos" showValue />

showValue mostra o valor ao lado do rótulo, e format diz como ele é escrito: o nome de um formatador da casa (percent, currencyShort, compact) ou uma função sua. Ele recebe o valor real: a barra prende no max, e o texto não. Com a meta de R$ 5.000 batida em R$ 5.600, a barra sai cheia e o texto diz R$ 5,6K, e não a meta; sem format, a porcentagem passa de 100% (112%). O mesmo vale abaixo do min. Sem rótulo visível, passe aria-label.

Movimento

A barra enche do zero na montagem (animate-fill, --rc-duration-slow), o mesmo do Progress, e depois anda pela largura quando o valor muda. Com "reduzir movimento", nasce no valor.

Quando não usar

Para tarefa que anda e termina (enviar um arquivo, gerar um relatório), use Progress. Parece a mesma barra e não é. O progresso caminha para um fim; a medida fica parada mostrando um estado que pode subir e descer.

Trocar um pelo outro faz o leitor de tela anunciar "carregando" para algo que não carrega, e quem ouve fica esperando o fim de uma operação que não existe.

No React Native

Portado. O texto do valor sai de format, com os mesmos nomes de formatador do web (percent, currencyShort, integer...) ou uma função, e vale na tela e no anúncio. Só daqui há o valueLabel, para a medida que já chega escrita, e ele ganha do format quando os dois vêm. O papel de acessibilidade muda, e por uma razão: o React Native não tem equivalente de meter, então a peça se anuncia como texto com valor, e nunca como progressbar, que é justamente o erro que ela existe para evitar.

As partes vestem pelo mesmo classNames do web: label, value, track e indicator.

API

PropTipoPadrão
valueobrigatória0.4.0

O valor atual.

numbersem padrão
aria-valuetext0.4.0

O texto legível que dá nome ao `aria-valuenow`, o valor atual do medidor.

stringsem padrão
classNames0.5.0

Classe por parte: `label`, `value`, `track`, `indicator`.

Partial<Record<"indicator" | "label" | "track" | "value", string>>sem padrão
format0.4.0

Como o numero e escrito: nome de formatador da casa (`percent`, `currencyShort`, `integer`...) ou funcao propria.

Formatsem padrão
getAriaValueText0.4.0

Função que devolve o texto legível que substitui o `aria-valuenow`, o valor atual do medidor.

((formattedValue: string, value: number) => string)sem padrão
label0.4.0ReactNodesem padrão
locale0.4.0

O idioma que o `Intl.NumberFormat` usa para formatar o valor.

LocalesArgumentsem padrão
max0.4.0

O maior valor.

number100
min0.4.0

O menor valor.

number0
numberFormat0.5.0

As opcoes do `Intl.NumberFormat`, para quem precisa delas.

NumberFormatOptionssem padrão
render0.4.0

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

ComponentRenderFn<HTMLProps, MeterRootState> | ReactElement<unknown, string | JSXElementConstructor<any>>sem padrão
showValue0.4.0booleansem 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.