Skip to content

字典组件

字典组件包含 DictSelect(字典选择器)和 DictLabel(字典标签)两个独立组件,用于简化字典数据的展示和选择。

DictSelect 字典选择器

基于 Element Plus 封装的字典选择器组件,支持下拉选择、单选框、复选框三种展示类型。

下拉选择(默认)

vue
<template>
  <DictSelect v-model="gender" code="gender" />
</template>

<script setup lang="ts">
const gender = ref(1)
</script>

单选框类型

vue
<template>
  <DictSelect v-model="gender" type="radio" code="gender" />
</template>

<script setup lang="ts">
const gender = ref(1)
</script>

复选框类型(多选)

vue
<template>
  <DictSelect v-model="hobbies" type="checkbox" code="hobby" />
</template>

<script setup lang="ts">
const hobbies = ref([1, 2])
</script>

Props

参数说明类型默认值
modelValue绑定值(支持 v-model)string | number | Array-
code字典类型编码string-
type组件类型:select(下拉)、radio(单选)、checkbox(复选)string'select'
placeholder占位文本string'请选择'

Events

事件名说明回调参数
update:modelValue值变化时触发(value: string | number | Array)

DictLabel 字典标签

字典值翻译组件,在列表和详情页中将字典值转换为字典文本显示。

基本用法

vue
<template>
  <DictLabel v-model="genderValue" code="gender" />
</template>

<script setup lang="ts">
const genderValue = ref(1)
</script>

表格中使用

vue
<template>
  <el-table :data="tableData">
    <el-table-column label="性别" prop="gender">
      <template #default="{ row }">
        <DictLabel :model-value="row.gender" code="gender" />
      </template>
    </el-table-column>
  </el-table>
</template>

<script setup lang="ts">
const tableData = ref([
  { name: '张三', gender: 1 },
  { name: '李四', gender: 2 }
])
</script>

Props

参数说明类型默认值
modelValue字典值(支持 v-model)string | number-
code字典类型编码string-

功能特性

  • ✅ 多种类型(下拉选择、单选框、复选框)
  • ✅ 自动加载(自动从后端加载字典数据)
  • ✅ 数据缓存(字典数据自动缓存,避免重复请求)
  • ✅ 值翻译(支持将字典值翻译为文本显示)
  • ✅ 双向绑定(支持 v-model)

使用场景

表单中使用

vue
<template>
  <el-form :model="form" label-width="100px">
    <el-form-item label="性别">
      <DictSelect v-model="form.gender" code="gender" />
    </el-form-item>

    <el-form-item label="爱好">
      <DictSelect v-model="form.hobbies" type="checkbox" code="hobby" />
    </el-form-item>

    <el-form-item label="状态">
      <DictSelect v-model="form.status" type="radio" code="status" />
    </el-form-item>
  </el-form>
</template>

<script setup lang="ts">
const form = reactive({
  gender: 1,
  hobbies: [1, 2],
  status: 1
})
</script>

搜索条件

vue
<template>
  <el-form :model="queryParams" inline>
    <el-form-item label="性别">
      <DictSelect v-model="queryParams.gender" code="gender" placeholder="全部" />
    </el-form-item>
    <el-form-item>
      <el-button type="primary" @click="handleQuery">查询</el-button>
    </el-form-item>
  </el-form>
</template>

注意事项

1. 字典编码

字典编码 code 必须与后端定义的字典类型编码一致,否则无法正确加载字典数据。

2. 组件名称

  • DictSelect:字典选择器,用于表单输入
  • DictLabel:字典标签,用于只读展示

3. 数据类型

不同类型的字典组件,v-model 绑定的数据类型不同:

  • selectradio:绑定单个值(string | number
  • checkbox:绑定数组(Array

相关链接

基于 MIT 许可发布