Select 選擇器

LhSelect 用於從選項列表中選擇一個值，支援停用選項、清空和鍵盤操作。

基礎用法

基礎用法

北京⌄

<script setup lang="ts">
import { ref } from 'vue'
import { LhSelect } from '@lh-ui/vue3'

const selectedCity = ref('beijing')
const cityOptions = [
  { label: '北京', value: 'beijing' },
  { label: '上海', value: 'shanghai' },
  { label: '深圳', value: 'shenzhen' },
]
</script>

<template>
  <!-- 基礎用法 -->
  <LhSelect v-model="selectedCity" :options="cityOptions" placeholder="请选择城市" />
</template>

<script>
import { LhSelect } from '@lh-ui/vue3'

export default {
  components: { LhSelect },
  data() {
    return {
      selectedCity: 'beijing',
      cityOptions: [
        { label: '北京', value: 'beijing' },
        { label: '上海', value: 'shanghai' },
        { label: '深圳', value: 'shenzhen' },
      ],
    }
  },
}
</script>

<template>
  <!-- 基礎用法 -->
  <LhSelect v-model="selectedCity" :options="cityOptions" placeholder="请选择城市" />
</template>

可清空與停用

可清空與停用

請選擇地區⌄

華北⌄

<script setup lang="ts">
import { ref } from 'vue'
import { LhSelect } from '@lh-ui/vue3'

const selectedRegion = ref('')
const selectedDisabled = ref('north')
const regionOptions = [
  { label: '华北', value: 'north' },
  { label: '华东', value: 'east' },
  { label: '华南', value: 'south' },
]
const disabledOptions = [
  { label: '华北', value: 'north', disabled: true },
  { label: '华东', value: 'east' },
  { label: '华南', value: 'south' },
]
</script>

<template>
  <!-- 可清空 -->
  <LhSelect v-model="selectedRegion" :options="regionOptions" clearable placeholder="请选择地区" />
  <!-- 已停用 -->
  <LhSelect v-model="selectedDisabled" :options="disabledOptions" disabled placeholder="已禁用" />
</template>

<script>
import { LhSelect } from '@lh-ui/vue3'

export default {
  components: { LhSelect },
  data() {
    return {
      selectedRegion: '',
      selectedDisabled: 'north',
      regionOptions: [
        { label: '华北', value: 'north' },
        { label: '华东', value: 'east' },
        { label: '华南', value: 'south' },
      ],
      disabledOptions: [
        { label: '华北', value: 'north', disabled: true },
        { label: '华东', value: 'east' },
        { label: '华南', value: 'south' },
      ],
    }
  },
}
</script>

<template>
  <!-- 可清空 -->
  <LhSelect v-model="selectedRegion" :options="regionOptions" clearable placeholder="请选择地区" />
  <!-- 已停用 -->
  <LhSelect v-model="selectedDisabled" :options="disabledOptions" disabled placeholder="已禁用" />
</template>

自訂主題

為選擇器應用自訂主題色。

青花瓷主題

北京⌄

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhSelect } from '@lh-ui/vue3'

const selectedTheme = ref('beijing')
const cityOptions = [
  { label: '北京', value: 'beijing' },
  { label: '上海', value: 'shanghai' },
]
const cerblueTheme = {
  'primary-color': '#2B4C7C',
  'primary-color-hover': '#3D649E',
  'primary-color-bg': '#E8EDF3',
}
</script>

<template>
  <LhConfigProvider :theme-vars="cerblueTheme">
    <!-- 青花瓷主題 -->
    <LhSelect v-model="selectedTheme" :options="cityOptions" placeholder="请选择" />
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhSelect } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhSelect },
  data() {
    return {
      selectedTheme: 'beijing',
      cityOptions: [
        { label: '北京', value: 'beijing' },
        { label: '上海', value: 'shanghai' },
      ],
      cerblueTheme: {
        'primary-color': '#2B4C7C',
        'primary-color-hover': '#3D649E',
        'primary-color-bg': '#E8EDF3',
      },
    }
  },
}
</script>

<template>
  <LhConfigProvider :theme-vars="cerblueTheme">
    <!-- 青花瓷主題 -->
    <LhSelect v-model="selectedTheme" :options="cityOptions" placeholder="请选择" />
  </LhConfigProvider>
</template>

更多主題請參考主題定製。

國際化

選擇器可以透過 LhConfigProvider 和 t 函式實現國際化。

國際化

北京⌄

<script setup lang="ts">
import { ref, computed } from 'vue'
import { LhConfigProvider, LhSelect, LhButton, zhCN, enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
const selected = ref('beijing')
const cityOptions = [
  { label: '北京', value: 'beijing' },
  { label: '上海', value: 'shanghai' },
  { label: '深圳', value: 'shenzhen' },
]
const messages = computed(() => (locale.value === 'zh-CN' ? zhCN : enUS))
</script>

<template>
  <LhConfigProvider :locale="messages">
    <!-- 城市選擇 -->
    <LhSelect
      v-model="selected"
      :options="cityOptions"
      :placeholder="locale === 'zh-CN' ? '请选择城市' : 'Please select city'"
    />
    <!-- 切換語言 -->
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换至英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhSelect, LhButton, zhCN, enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhSelect, LhButton },
  data() {
    return {
      locale: 'zh-CN',
      selected: 'beijing',
      cityOptions: [
        { label: '北京', value: 'beijing' },
        { label: '上海', value: 'shanghai' },
        { label: '深圳', value: 'shenzhen' },
      ],
    }
  },
  computed: {
    messages() {
      return this.locale === 'zh-CN' ? zhCN : enUS
    },
  },
}
</script>

<template>
  <LhConfigProvider :locale="messages">
    <!-- 城市選擇 -->
    <LhSelect
      v-model="selected"
      :options="cityOptions"
      :placeholder="locale === 'zh-CN' ? '请选择城市' : 'Please select city'"
    />
    <!-- 切換語言 -->
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换至英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

尺寸

尺寸

選項一⌄

選項一⌄

選項一⌄

<script setup lang="ts">
import { ref } from 'vue'
import { LhSelect } from '@lh-ui/vue3'

const demoSizeSmall = ref('a')
const demoSizeMedium = ref('a')
const demoSizeLarge = ref('a')
const sizeOptions = [
  { label: '选项一', value: 'a' },
  { label: '选项二', value: 'b' },
  { label: '选项三', value: 'c' },
]
</script>

<template>
  <!-- small -->
  <LhSelect v-model="demoSizeSmall" :options="sizeOptions" size="small" placeholder="small" />
  <!-- medium -->
  <LhSelect v-model="demoSizeMedium" :options="sizeOptions" size="medium" placeholder="medium" />
  <!-- large -->
  <LhSelect v-model="demoSizeLarge" :options="sizeOptions" size="large" placeholder="large" />
</template>

<script>
import { LhSelect } from '@lh-ui/vue3'

export default {
  components: { LhSelect },
  data() {
    return {
      demoSizeSmall: 'a',
      demoSizeMedium: 'a',
      demoSizeLarge: 'a',
      sizeOptions: [
        { label: '选项一', value: 'a' },
        { label: '选项二', value: 'b' },
        { label: '选项三', value: 'c' },
      ],
    }
  },
}
</script>

<template>
  <!-- small -->
  <LhSelect v-model="demoSizeSmall" :options="sizeOptions" size="small" placeholder="small" />
  <!-- medium -->
  <LhSelect v-model="demoSizeMedium" :options="sizeOptions" size="medium" placeholder="medium" />
  <!-- large -->
  <LhSelect v-model="demoSizeLarge" :options="sizeOptions" size="large" placeholder="large" />
</template>

無障礙與掛載容器

aria-label 用於無障礙描述，name 為原生表單名稱，popper-container 指定下拉麵板的掛載容器。

無障礙與掛載容器

aria-label 與 name⌄

掛載到 body⌄

<script setup lang="ts">
import { ref } from 'vue'
import { LhSelect } from '@lh-ui/vue3'

const demoA11y = ref('')
const demoContainer = ref('')
const sizeOptions = [
  { label: '选项一', value: 'a' },
  { label: '选项二', value: 'b' },
  { label: '选项三', value: 'c' },
]
</script>

<template>
  <!-- aria-label 與 name -->
  <LhSelect v-model="demoA11y" :options="sizeOptions" aria-label="请选择城市" name="city" placeholder="aria-label 与 name" />
  <!-- 掛載到 body -->
  <LhSelect v-model="demoContainer" :options="sizeOptions" popper-container="body" placeholder="挂载到 body" />
</template>

<script>
import { LhSelect } from '@lh-ui/vue3'

export default {
  components: { LhSelect },
  data() {
    return {
      demoA11y: '',
      demoContainer: '',
      sizeOptions: [
        { label: '选项一', value: 'a' },
        { label: '选项二', value: 'b' },
        { label: '选项三', value: 'c' },
      ],
    }
  },
}
</script>

<template>
  <!-- aria-label 與 name -->
  <LhSelect v-model="demoA11y" :options="sizeOptions" aria-label="请选择城市" name="city" placeholder="aria-label 与 name" />
  <!-- 掛載到 body -->
  <LhSelect v-model="demoContainer" :options="sizeOptions" popper-container="body" placeholder="挂载到 body" />
</template>

Select API

Props

屬性	說明	類型	預設值
modelValue	當前值	unknown	—
options	選項列表	[LhSelectOption](#type-LhSelectOption)[]	() => []
placeholder	佔位文字（未傳時取語言包 select.placeholder，中文「請選擇」）	string	''
disabled	是否停用	boolean	false
clearable	是否顯示清空按鈕	boolean	false
size	選擇器尺寸	"small" | "medium" | "large"	'medium'
name	—	string	—
ariaLabel	無可見標籤時的輔助文字	string	—
popperContainer	—	string | HTMLElement	'body'
sx	sx 快速版面配置屬性	LhSxProps	—

Events

事件	說明	參數
update:modelValue	值發生變化	value: unknown
change	選擇發生變化	value, option
clear	點選清空	—

Option

type LhSelectOption = {
  label: string
  value: unknown
  disabled?: boolean
}

支援 ArrowUp、ArrowDown 移動高亮項，Enter 確認選擇，Escape 關閉下拉選單。

類型定義

本元件對外匯出的 TypeScript 類型結構如下（自動提取自 packages/components/select/src/types.ts 與 @lh-ui/share/core/* 原始碼，點選各條目展開檢視完整定義；屬性說明見上方 Props 表）：

LhSelectSize

export type LhSelectSize = 'small' | 'medium' | 'large'

LhSelectProps

export interface LhSelectProps {
  modelValue?: unknown
  options?: LhSelectOption[]
  placeholder?: string
  disabled?: boolean
  clearable?: boolean
  size?: LhSelectSize
  name?: string
  ariaLabel?: string
  popperContainer?: 'body' | HTMLElement | string
  /** sx 快速版面配置屬性 */
  sx?: LhSxProps
}

LhSelectOption _{（來自 @lh-ui/share/core/select）}

export interface LhSelectOption {
  label: string
  value: unknown
  disabled?: boolean
}

Slots

插槽	說明	預設內容
empty	選項為空時下拉麵板的自訂空狀態內容	語言包 select.noData（中文「暫無資料」）