SelectList

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

Design System

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

Exemplos

Propriedades

activeOptionIndex

Atributo	active-option-index
Descrição	Índice da opção atualmente ativa para navegação por teclado.
Tipo	number
Valor padrão	-1

itemHeight

Atributo	item-height
Descrição	Informa a altura base usada no cálculo de posicionamento das opções.
Tipo	number
Valor padrão	56

loading

Atributo	loading
Descrição	Indica que os resultados remotos estão sendo carregados.
Tipo	boolean
Valor padrão	false

options

Atributo	---
Descrição	Coleção de opções exibidas pela lista.
Tipo	SelectOptionData[]
Valor padrão	[]

overscan

Atributo	overscan
Descrição	Define quantas opções extras são renderizadas fora da viewport quando o virtual scroll está ativo.
Tipo	number
Valor padrão	0

searchTerm

Atributo	search-term
Descrição	Termo usado para filtrar opções por rótulo ou valor.
Tipo	string
Valor padrão	''

selectAllLabel

Atributo	select-all-label
Descrição	Rótulo apresentado para a ação de selecionar todos no modo múltiplo.
Tipo	string
Valor padrão	SelectList.SELECT_ALL_LABEL

unselectAllLabel

Atributo	unselect-all-label
Descrição	Rótulo apresentado quando todas as opções já estão selecionadas no modo múltiplo.
Tipo	string
Valor padrão	SelectList.DESELECT_ALL_LABEL

visibleItems

Atributo	visible-items
Descrição	Define quantas opções permanecem visíveis na viewport da lista.
Tipo	number
Valor padrão	6

Métodos

close

Descrição	Fecha a lista de opções.
Assinatura	close() => Promise<void>
Parâmetros	---

focusOption

Descrição	Garante visibilidade e foco para uma opção específica.
Assinatura	focusOption(index: number) => Promise<boolean>
Parâmetros	index: Índice lógico da opção alvo.

getOptions

Descrição	Retorna uma cópia das opções atualmente controladas pela lista.
Assinatura	getOptions() => Promise<SelectOptionData[]>
Parâmetros	---

open

Descrição	Abre a lista e agenda a medição das opções quando necessário.
Assinatura	open() => Promise<void>
Parâmetros	---

scrollFirstSelectedOptionToTop

Descrição	Posiciona no topo a primeira opção selecionada na ordem visual da lista. A opção auxiliar de selecionar tudo não participa dessa escolha.
Assinatura	scrollFirstSelectedOptionToTop() => Promise<boolean>
Parâmetros	---

scrollOptionToTop

Descrição	Posiciona uma opção no topo da viewport virtual, respeitando o limite final da lista.
Assinatura	scrollOptionToTop(index: number) => Promise<boolean>
Parâmetros	index: Índice lógico da opção alvo.

setMultiple

Descrição	Alterna a lista entre modo simples e múltiplo.
Assinatura	setMultiple(isMultiple: boolean) => Promise<void>
Parâmetros	isMultiple: Define se a lista deve operar em seleção múltipla.

setOption

Descrição	Adiciona ou atualiza uma única opção na coleção atual.
Assinatura	setOption(option: SelectOptionData) => Promise<void>
Parâmetros	option: Opção que deve ser persistida na lista.

setOptionSelected

Descrição	Aciona a seleção programática de uma opção específica.
Assinatura	setOptionSelected(index: number, selected?: boolean) => Promise<boolean>
Parâmetros	index: Índice lógico da opção alvo. selected: Estado desejado para a opção. Quando omitido, a própria opção alterna o valor atual.

setOptions

Descrição	Substitui todas as opções renderizadas pela lista.
Assinatura	setOptions(options: SelectOptionData[]) => Promise<void>
Parâmetros	options: Nova coleção de opções normalizadas.

setSearchTerm

Descrição	Atualiza o termo de busca e reinicia a janela virtual no topo.
Assinatura	setSearchTerm(term: string) => Promise<void>
Parâmetros	term: Termo que deve filtrar a coleção. String vazia restaura todas as opções.

Dependências

Componente pai

• br-select

Usado por

• br-select

Depende de

• br-select-option
• br-loading

Gráfico

Migração: Vue 1.x → Stencil 2.x

Propriedades

🟦 Propriedades renomeadas

Propriedade Vue	Propriedade Stencil	Descrição	Tipo	Padrão

🟥 Propriedades removidas

Propriedade	Descrição	Tipo	Padrão

🟩 Novas propriedades

Propriedade	Descrição	Tipo	Padrão

Eventos

🟦 Eventos renomeados

Evento Vue	Evento Stencil	Descrição

🟥 Eventos removidos

Propriedade	Descrição	Tipo	Padrão

🟩 Novos eventos

Evento	Descrição

Slots

🟦 Slots renomeados

Slot Vue	Slot Stencil	Descrição

🟥 Eventos removidos

Propriedade	Descrição	Tipo	Padrão

🟩 Slots criados

Slot	Descrição