Ir para o conteúdo principal
WBC - GovBR-DS
Copiar página como Markdown para IA

Avatar

Componente estável e recomendada para novos projetos.
Anatomia, uso, comportamento visual e recomendações conceituais são mantidos pelo Padrão Digital de Governo. Esta página documenta a implementação Web Components e sua API executável.

Visão Geral

Para a documentação completa, incluindo diretrizes de uso, acessibilidade e exemplos visuais, consulte o Design System do GovBR.

Exemplo(s)

Padrão

Desktop (100%)
Tablet - 768px
iPhone (iOS) - 390x844
Android - 360x800
Compartilhar URL
Mudar fundo
Abrir no StackBlitz
Tela cheia
HTML
Controles
JS
CSS
Console
Angular (Somente leitura)
React (Somente leitura)
Vue (Somente leitura)
Acessibilidade
Recolher controles e código
Formatar código
Resetar código para o estado inicial
Copiar para a área de transferência

Status

Desktop (100%)
Tablet - 768px
iPhone (iOS) - 390x844
Android - 360x800
Compartilhar URL
Mudar fundo
Abrir no StackBlitz
Tela cheia
HTML
Controles
JS
CSS
Console
Angular (Somente leitura)
React (Somente leitura)
Vue (Somente leitura)
Acessibilidade
Expandir controles e código

Propriedades

alt

Atributoalt
DescriçãoTexto alternativo (alt) associado à imagem do avatar. Essencial para acessibilidade.
Deve descrever de forma clara e concisa o conteúdo da imagem, por exemplo: "Foto de perfil de João Silva".
Tipostring
Valor padrão'Foto de perfil do usuário'

bgColor

Atributobg-color
DescriçãoPermite definir a cor de fundo do componente.
Aceita os seguintes formatos de cor:
- Cores nomeadas do CSS: 'red', 'blue', 'green', 'yellow', etc.
- Códigos hexadecimais: '#ff0000', '#00ff00', '#0000ff', etc.
- Valores RGB: 'rgb(255, 0, 0)', 'rgb(0, 255, 0)', etc.
- Valores RGBA: 'rgba(255, 0, 0, 0.5)', 'rgba(0, 255, 0, 0.8)', etc.
- Valores HSL: 'hsl(0, 100%, 50%)', 'hsl(120, 100%, 50%)', etc.
- Valores HSLA: 'hsla(0, 100%, 50%, 0.5)', 'hsla(240, 100%, 50%, 0.7)', etc.
Se não especificada, usa a cor padrão do tema.
Tipostring
Valor padrão'#DBE8FB'

customId

Atributocustom-id
DescriçãoIdentificador único do componente.
Quando omitido, um valor é gerado automaticamente.

> Padrão: valor único gerado por generateUniqueId().
Tipostring
Valor padrãogenerateUniqueId()

density

Atributodensity
DescriçãoDefine a densidade visual do componente.

- small: Alta densidade (componente menor, mais compacto e com menos espaçamento).
- medium: Densidade intermediária, padrão recomendado para a maioria dos casos.
- large: Baixa densidade (componente maior, mais espaçamento e altura).
Tipo"large" | "medium" | "small"
Valor padrão'medium'

disabled

Atributodisabled
DescriçãoDesabilita a interação com o componente.
Tipoboolean
Valor padrãofalse

iconic

Atributoiconic
DescriçãoExibe a variação icônica. Quando informada, tem precedência sobre isIconic.
Tipoboolean
Valor padrão---

isIconic Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.

Atributois-iconic
DepreciaçãoUse iconic.
Descrição
Tipoboolean
Valor padrãofalse

src

Atributosrc
DescriçãoURL da imagem a ser exibida no avatar do tipo 'fotográfico'.
Deve ser uma URL válida que aponta para a imagem desejada.
Tipostring
Valor padrão''

status

Atributostatus
DescriçãoExibe um indicador de status no avatar.
Tipoboolean
Valor padrãofalse

statusBgColor

Atributostatus-bg-color
DescriçãoCor de fundo do indicador de status padrão.
Tipostring
Valor padrão'rgb(22, 136, 33)'

statusLabel

Atributostatus-label
DescriçãoRótulo acessível do indicador de status padrão.
Tipostring
Valor padrão'Status do usuário'

statusPosition

Atributostatus-position
DescriçãoPosição do indicador de status sobre o avatar.
Tipo"bottom-left" | "bottom-right" | "top-left" | "top-right"
Valor padrão'top-right'

statusSize

Atributostatus-size
DescriçãoTamanho do indicador de status padrão.
Tipostring
Valor padrão'12px'

text

Atributotext
DescriçãoConteúdo textual do avatar.
Apenas o primeiro caractere será exibido em maiúscula.
Tipostring
Valor padrão''

CSS Shadow Parts

NomeDescrição
"container"Elemento externo do avatar.
"content"Conteúdo interno do avatar (imagem, ícone ou texto).
"status"Indicador de status posicionado sobre o avatar.

Dependências

Depende de

Gráfico

Migração de <br-avatar> (1.x → 2.x)

Na branch 1.x, o avatar era um Vue Custom Element registrado como br-avatar. Na 2.x, o nome do elemento foi preservado, mas a API foi alinhada ao padrão dos Web Components atuais.

Propriedades

API 1.xAPI 2.xAção na migração
altInforme o texto alternativo quando houver imagem.
densitydensityMantenha o valor compatível.
iconiciconicMantenha; prefira o nome canônico atual em vez do alias legado is-iconic.
imagesrcRenomeie a propriedade.
nametextRenomeie a propriedade.

Exemplo

1.x:

<br-avatar name="Maria" image="/foto.jpg" iconic></br-avatar>

2.x:

<br-avatar text="Maria" src="/foto.jpg" iconic alt="Maria"></br-avatar>