Vitral 0.2
Formulário

Select

Escolha uma opção de uma lista, com um filtro opcional que ignora maiúsculas e acentos.

Importação

main.ts
import { Select } from '@vitral/vue';

Básico

Value: null
<script setup lang="ts">import { Label, Select, StackPanel } from '@vitral/vue';import { ref } from 'vue'; const cities = [    { name: 'São Paulo', code: 'SP' },    { name: 'Rio de Janeiro', code: 'RJ' },    { name: 'Belo Horizonte', code: 'BH' },    { name: 'Brasília', code: 'BSB' },    { name: 'Curitiba', code: 'CWB' },    { name: 'Florianópolis', code: 'FLN', disabled: true },    { name: 'Porto Alegre', code: 'POA' },    { name: 'Recife', code: 'REC' },    { name: 'Salvador', code: 'SSA' },    { name: 'Manaus', code: 'MAO' }]; const city = ref<string | null>(null);</script> <template>    <StackPanel spacing="0.375rem" style="min-width: 16rem">        <Label for="sel-city">City</Label>        <Select id="sel-city" v-model="city" :options="cities" option-label="name" option-value="code" option-disabled="disabled" placeholder="Select a city" show-clear checkmark />        <small style="color: var(--vt-text-muted-color)">Value: {{ city ?? 'null' }}</small>    </StackPanel></template>

Filtro

<script setup lang="ts">import { Label, Select, StackPanel } from '@vitral/vue';import { ref } from 'vue'; const cities = [    { name: 'São Paulo', code: 'SP' },    { name: 'Rio de Janeiro', code: 'RJ' },    { name: 'Belo Horizonte', code: 'BH' },    { name: 'Brasília', code: 'BSB' },    { name: 'Curitiba', code: 'CWB' },    { name: 'Florianópolis', code: 'FLN' },    { name: 'Porto Alegre', code: 'POA' },    { name: 'Recife', code: 'REC' },    { name: 'Salvador', code: 'SSA' },    { name: 'Manaus', code: 'MAO' }]; const city = ref<string | null>('REC');</script> <template>    <StackPanel spacing="0.375rem" style="min-width: 16rem">        <Label for="sel-search">City (searchable)</Label>        <Select id="sel-search" v-model="city" :options="cities" option-label="name" option-value="code" filter placeholder="Search…" />    </StackPanel></template>

Grupos

<script setup lang="ts">import { Label, Select, StackPanel } from '@vitral/vue';import { ref } from 'vue'; const groups = [    { label: 'Brazil', items: [{ name: 'São Paulo' }, { name: 'Recife' }] },    { label: 'Portugal', items: [{ name: 'Lisboa' }, { name: 'Porto' }] },    { label: 'Angola', items: [{ name: 'Luanda' }] }]; const city = ref<unknown>(null);</script> <template>    <StackPanel spacing="0.375rem" style="min-width: 16rem">        <Label for="sel-group">City by country</Label>        <Select id="sel-group" v-model="city" :options="groups" option-group-label="label" option-label="name" placeholder="Pick a city" />    </StackPanel></template>

Tamanhos e estados

<script setup lang="ts">import { Select } from '@vitral/vue'; const cities = [{ name: 'São Paulo' }, { name: 'Rio de Janeiro' }, { name: 'Brasília' }, { name: 'Curitiba' }, { name: 'Recife' }];</script> <template>    <Select :options="cities" option-label="name" placeholder="Small" size="small" aria-label="Small" />    <Select :options="cities" option-label="name" placeholder="Filled" variant="filled" aria-label="Filled" />    <Select :options="cities" option-label="name" placeholder="Invalid" invalid aria-label="Invalid" />    <Select :options="cities" option-label="name" placeholder="Loading" loading aria-label="Loading" />    <Select :options="cities" option-label="name" placeholder="Disabled" disabled aria-label="Disabled" /></template>

API

Lido de packages/vue/src/components/Select/types.ts, então diz o que o componente aceita de fato.

Props

NomeTipoDescrição
optionsany[]—
optionLabelstringCampo (caminho com pontos) com o texto de uma opção. Sem ele, as opções são mostradas como estão.
optionValuestringCampo com o valor que o v-model recebe. Sem ele, a opção inteira é o valor.
optionDisabledstring—
optionGroupLabelstringTransforma `options` em grupos: este campo é o rótulo de cada grupo…
optionGroupChildrenstring…e este, as suas opções. O padrão é `items`.
dataKeystringCompara valores de objeto por este campo em vez de pela estrutura.
placeholderstring—
disabledboolean—
invalidboolean—
sizeSize—
variantInputVariant—
fluidboolean—
filterbooleanAdiciona uma caixa de busca ao painel: o combobox.
filterPlaceholderstring—
filterFieldsstring[]Campos a buscar em vez do rótulo.
filterMatchModestringQualquer modo de comparação registrado; por padrão, `contains` sem distinguir acentos nem maiúsculas.
showClearboolean—
loadingboolean—
checkmarkbooleanMarca a opção selecionada com um visto, além do destaque.
emptyMessagestring—
emptyFilterMessagestring—
placementOverlayPlacement—
appendTostring`'body'` (o padrão), `'self'` para renderizar no lugar, ou um seletor.

Mais pt, dt e unstyled de BaseProps; veja pass-through e modo sem estilo.

Emits

EventoPayloadDescrição
changeevent: SelectChangeEvent—
show——
hide——
filterquery: string—
focusevent: FocusEvent—
blurevent: FocusEvent—

Slots

NomeProps do slotDescrição
value(props: { value: unknown; option: unknown; placeholder?: string })—
option(props: { option: unknown; index: number; selected: boolean; focused: boolean })—
optiongroup(props: { group: unknown })—
header——
footer——
empty——
dropdownicon(props: { open: boolean })—