Progress
Com rótulo
Sem fim conhecido
import { Progress } from '@rivocode/ui'Quando usar
Barra de progresso de tarefa com fim conhecido: enviar arquivo, gerar relatório.
Sem value ela vira indeterminada; nesse caso prefira o Spinner, que ocupa
menos e não promete um fim que ninguém sabe medir.
format escreve o número do showValue: o nome de um formatador da casa, ou
uma função sua. Ele recebe o valor limitado a min e max, o mesmo que a
barra desenha, e não é chamado quando a barra está indeterminada.
Movimento
A barra enche do zero na montagem, pela escala horizontal a partir da esquerda (animate-fill, --rc-duration-slow), e depois anda até cada valor novo pela largura. O indeterminado troca a entrada pelo vaivem dele. Com "reduzir movimento", a barra nasce no valor.
Quando não usar
Para quanto de uma capacidade está em uso (espaço em disco, cota de envios do
mês, limite de crédito), use Meter. A diferença não é de aparência, é do que
o número faz: o progresso anda para o fim e termina, a medida fica parada e pode
subir e descer.
Trocar um pelo outro chega ao leitor de tela: a barra de progresso é anunciada como algo que carrega, e "carregando 72%" para um disco que não está carregando nada faz quem ouve esperar por um fim que nunca vem.
No React Native
Traduz: o @rivocode/ui-native exporta Progress - value de 0 a 100 e label; showValue e format como no web; a barra anda até o valor novo; classNames com as quatro partes do web. 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.
API
| Prop | Tipo | Padrão |
|---|---|---|
valueobrigatória0.4.0O valor atual. | number | null | sem padrão |
aria-valuetext0.4.0O texto legível que dá nome ao `aria-valuenow`, o valor atual da barra de progresso. | string | sem padrão |
classNames0.5.0Classe por parte: `label`, `value`, `track`, `indicator`. | Partial<Record<"indicator" | "label" | "track" | "value", string>> | sem padrão |
format0.4.0Como o numero e escrito: nome de formatador da casa (`percent`, `currencyShort`, `integer`...) ou funcao propria. | Format | sem padrão |
getAriaValueText0.4.0Função que devolve o texto legível que substitui o valor atual da barra de progresso. | ((formattedValue: string, value: number | null) => string) | sem padrão |
label0.4.0Texto acima da barra. | ReactNode | sem padrão |
locale0.4.0O idioma que o `Intl.NumberFormat` usa para formatar o valor. | LocalesArgument | sem padrão |
max0.4.0O maior valor. | number | 100 |
min0.4.0O menor valor. | number | 0 |
numberFormat0.5.0As opcoes do `Intl.NumberFormat`, para quem precisa delas. | NumberFormatOptions | sem padrão |
render0.4.0Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente. | ComponentRenderFn<HTMLProps, ProgressRootState> | ReactElement<unknown, string | JSXElementConstructor<any>> | sem padrão |
showValue0.4.0Mostra a porcentagem ao lado do rotulo. | boolean | sem padrão |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.