header-list

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.

Propriedades

customId

Atributo	custom-id
Descrição	Identificador único do componente. Quando omitido, um valor é gerado automaticamente. > Padrão: valor único gerado por generateUniqueId().
Tipo	string
Valor padrão	generateUniqueId()

listTitle

Atributo	list-title
Descrição	Título da lista.
Tipo	string
Valor padrão	null

Slots

Nome	Descrição
"default"	Slot para o conteúdo da lista de navegação no cabeçalho.

Eventos

Evento	Descrição	Depreciação	Propagação
headerListFocused	Evento disparado quando a lista recebe foco. O evento envia o ID do componente.	---	true
headerListUpdate	Evento disparado para indicar qual lista deve encolher primeiro. O evento envia o ID do componente pai e o nome da lista.	---	true

Métodos

closeList

Descrição	Fecha a lista.
Assinatura	closeList() => Promise<void>
Parâmetros	---

isListOpen

Descrição	Verifica se a lista está aberta.
Assinatura	isListOpen() => Promise<boolean>
Parâmetros	---

openList

Descrição	Abre a lista.
Assinatura	openList() => Promise<void>
Parâmetros	---

Dependências

Componente pai

• br-header

Depende de

• br-list
• br-button
• br-icon

Gráfico