Componentes

Badge

Badge é um pequeno texto usado para representar situação, propriedade e outras informações.

índice

Demo interativa

Uma versão de interativa do componente desenvolvido. Por ser um componente em fase Beta, algumas variações e especificações do componente podem não estar disponíveis ainda.

badge default

propriedades*

propertydescriptionrequireddefault valuetype

variation

Badge style variation

falseprimaryneutralprimaryinfosuccessalerterror

showIcon

show icon at render

falsetrueboolean

icon

An Icon component from @olist/design-system-icons to be used in the badge. Can not be used with children prop

falseundefinedElementType<any>

*valores gerados automaticamente.

badge filter

badge filter ( close button )

propriedades*

propertydescriptionrequireddefault valuetype

selected

Indicates if the badge is selected.

falsefalseboolean

disabled

Indicates if the badge is disabled.

falsefalseboolean

id

falseundefinedstring

isOpen

Indicates if the badge is displayed.

falsetrueboolean

onClose

Event fired when user clicks on close button

falseundefined() => void

onChange

Event fired when user clicks on close button

falseundefined() => void

*valores gerados automaticamente.

badge notification

propriedades*

propertydescriptionrequireddefault valuetype

countNotifications

The number of notifications.

falseundefinednumber

*valores gerados automaticamente.

Formatação

Ilustração da badge em cinza. Marcação de número 1 destacando o texto da badge.
  1. Icon: ícone que auxília na identificação do estado da badge.
  2. Label: texto que trás a característica do componente associado à badge.

Uso

É utilizada para usado para representar situação, propriedade e outras informações.

variações

variaçãoutilização
status badgePara alertar a situação em que um objeto se encontra.
category badgePara enquadrar um elemento a uma categoria.
filterPara facilitar a identificação de um objeto reduzindo o número de opções na tela.
notificationPara alertar o número de eventos relacionados a um objeto.

grupos e alinhamento

Normalmente a badge é usada próxima a um outro componente ao qual ela se refere, como um produto, uma linha da tabela ou mesmo um link de menu.

Guia de conteúdo

  • Pequeno texto que descreva a categoria ou situação do objeto;
  • Número de eventos relacionado a badge;
  • Ícone que reforça o status da badge;
  • Círculo vazio quando há necessidade de informar que algo mudou, sem especificar o que, mas há pouco espaço disponível na tela.

Guia de design

  • Tem guia de uso.
  • Tem guia de conteúdo.
  • Usa os design tokens.
  • Tem símbolo no Figma.
  • Possui motion.
  • Possui versão web.
  • Possui versão responsiva.
  • Possui versão mobile.
  • É acessível via leitor de tela.
  • Texto possui contraste acessível (WCAG 2.0 - Nível AA).

conteúdo relacionado