Skip to content
API 风格:

Select 选择器 ​

LhSelect 用于从选项列表中选择一个值,支持禁用选项、清空和键盘操作。

基础用法 ​

基础用法
vue
<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>
vue
<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>

可清空与禁用 ​

可清空与禁用
vue
<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>
vue
<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>

自定义主题 ​

为选择器应用自定义主题色。

青花瓷主题
vue
<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>
vue
<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 函数实现国际化。

国际化
vue
<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>
vue
<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>

尺寸 ​

尺寸
vue
<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>
vue
<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 指定下拉面板的挂载容器。

无障碍与挂载容器
vue
<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>
vue
<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是否禁用booleanfalse
clearable是否显示清空按钮booleanfalse
size选择器尺寸"small" | "medium" | "large"'medium'
name—string—
ariaLabel无可见标签时的辅助文本string—
popperContainer—string | HTMLElement'body'
sxsx 快速布局属性LhSxProps—

Events ​

事件说明参数
update:modelValue值发生变化value: unknown
change选择发生变化value, option
clear点击清空—

Option ​

ts
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
ts
export type LhSelectSize = 'small' | 'medium' | 'large'
LhSelectProps
ts
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)
ts
export interface LhSelectOption {
  label: string
  value: unknown
  disabled?: boolean
}

Slots ​

插槽说明默认内容
empty选项为空时下拉面板的自定义空状态内容语言包 select.noData(中文「暂无数据」)