Pular para o conteúdo
UI

Rating

Componente de avaliação com estrelas que permite ao usuário dar feedback ou exibir avaliações.

Exemplos

Básico

Selecionado: 0 estrelas

Meias estrelas

Com labels

RuimExcelente
InsatisfeitoSatisfeito
PéssimoÓtimo

Somente leitura

Número máximo de estrelas personalizado

API

Rating

O componente Rating funciona nos modos controlado e não controlado:

  • Controlado: passe value e onChange para gerenciar o estado de fora.
  • Não controlado: omita value e o componente gerencia o próprio estado interno. Você ainda pode usar onChange para ser avisado das mudanças.
PropriedadeTipoPadrãoDescrição
valuenumber-Valor atual da avaliação (de 0 a maxStars, aceita incrementos de 0.5 para meias estrelas). Quando informado, o componente é controlado.
onChange(value: number) => void-Função chamada quando o usuário clica em uma estrela. Funciona nos modos controlado e não controlado.
maxStarsnumber5Número máximo de estrelas exibidas.
readOnlybooleanfalseQuando true, impede o usuário de interagir com a avaliação.
labels[string, string]-Labels exibidos abaixo das estrelas. O primeiro aparece à esquerda e o segundo, à direita.
size"sm" | "md" | "lg""md"Tamanho das estrelas.
classNamestring-Classes CSS adicionais aplicadas ao elemento raiz.
classNameContainerstring-Classes CSS adicionais aplicadas ao container das estrelas.
classNameLabelsstring-Classes CSS adicionais aplicadas ao container dos labels.
labelstring"Avaliação"Nome acessível do grupo de rádio interativo. As setas do teclado mudam o valor.
getValueLabel(value: number, maxStars: number) => string(value, max) => `Nota ${value} de ${max}`Monta o label acessível de cada estrela e, quando readOnly, da avaliação inteira (exposta como role="img").

Estados da estrela

EstadoDescrição
emptyEstrela com fundo transparente e borda gray-stroke-emphasis.
halfEstrela preenchida pela metade com a cor feedback-warning-background-soft.
fullEstrela totalmente preenchida com a cor feedback-warning-background-soft.