对ElementPlus的el-select二次封装，添加分页和搜索功能，实现一个自定义的下拉选择框

tanxiaomi

已于 2024-10-15 19:12:42 修改

阅读量2.2k

点赞数 14

文章标签： vue.js 前端 javascript elementui

于 2024-10-12 13:37:44 首次发布

本文链接：https://blog.csdn.net/lfeishumomol/article/details/142875358

版权

组件展示效果图

在 Vue3 的 elementPlus项目中，我们经常需要使用下拉选择框 (el-select) 来展示大量数据。然而，默认情况下 el-select 不支持分页和搜索功能。本文将介绍如何通过二次封装 el-select 组件来实现这一需求，并使用自定义的 Hook 来简化开发流程。

1. 创建 useCustomOption.js Hook

首先，我们需要创建一个自定义 Hook，用于处理分页和搜索逻辑。

import {ref, reactive} from 'vue';
import {listRegion} from '@/api/manage/region'; // 示例 API 调用

/**
 * 自定义选项搜索钩子
 * 该钩子用于在给定的API列表中搜索特定项，通过提供的查询参数来筛选结果
 *
 */
export function useCustomOptionSearch(listApi, queryParamsKey, itemValue, selectPageInfo, selectDataList, queryParams) {

    // 查询数据列表
    function getDataList(searchQuery) {
        const data = {
            [itemValue]: searchQuery || undefined,
            ...selectPageInfo
        }
        listApi(data).then(response => {
            selectPageInfo.total = response.total;
            console.log(response.rows?.length > 0 && searchQuery !== '')
            if (response.rows?.length > 0 && searchQuery !== '') {
                // 设置默认值
                queryParams[queryParamsKey] = response.rows[0].id;
            }
            selectDataList.value = response.rows;
        });
    }

    // 处理分页器选中项变化事件
    function handleSelectChange(item) {
        queryParams[queryParamsKey] = item[queryParamsKey];
        queryParams[itemValue] = item[itemValue];
        selectDataList.value = [item]
        selectPageInfo.pageNum = 1
        selectPageInfo.total = 1
    }


    return {
        getDataList,
        handleSelectChange,
    };
}


export function usePageInfo() {
    const pageInfo = reactive({ // 分页信息
        pageNum: 1,
        pageSize: 5,
        total: 0,
    });

    function resetPageInfo(pageInfo) {
        pageInfo.pageNum = 1;
        pageInfo.pageSize = 5;
        pageInfo.total = 0;
    }

    return {pageInfo, resetPageInfo}
}

2. 创建 ElCustomOptionForSearch.vue 组件

接下来，我们将创建一个自定义的 el-select 组件，该组件将使用上述 Hook 实现分页和搜索功能。

<template>
  <!-- 引入Element UI的Select组件，用于创建一个支持分页的数据选择器 -->
  <el-select v-model="copyValue"
             :disabled="disabled"
             filterable
             clearable
             @clear="selectClear"
             :placeholder="placeholder"
             @change="updateValue"
             :filter-method="debounceFilterMethod"
             @focus="focusMethod"
             class="elPaginationSelect"
  >
    <!-- 为每个数据项生成一个Option，方便用户选择 -->
    <el-option
        v-for="item in dataList"
        :key="item.value"
        :label="item[labelKey]"
        :value="item[valueKey]"
    ></el-option>
    <template #footer>
      <!-- 自定义选择器的后缀，这里放置了一个分页器 -->
      <div  style="float: right; margin-right: 10px; padding-bottom: 10px;">
        <el-pagination
            @current-change="handleCurrentChange"
            :current-page="pageInfo.pageNum"
            :page-size="pageInfo.pageSize"
            layout="prev, pager, next, total"
            :total="pageInfo.total"
        ></el-pagination>
      </div>
    </template>
  </el-select>
</template>

<script setup>
import {ref} from 'vue';

// 定义组件属性
const props = defineProps({
  value: String,
  dataList: Array,
  labelKey: String,
  valueKey: String,
  pageInfo: Object,
  disabled: Boolean,
  elSelectClass: Boolean,
  placeholder:{type:String,default:"请选择"},
  queryParams:Object
});


// 定义组件事件发射器
const emit = defineEmits(['selectChange', 'selectPageChange']);

// 将父组件传入的value值拷贝一份，用于组件内部逻辑处理
const copyValue = ref(props.value);

// 当用户选择了一个不同的选项时触发，更新父组件的值
const updateValue = (select_key) => {
  props.dataList.forEach(item => {
    if (item[props.valueKey] === select_key) {
      props.dataList = item;
      emit('selectChange', item);
      // 避免选中选项后 ->下拉框 执行搜索的bug
      debounceFilterMethod(item[props.labelKey], false)
      return
    }
  })
};


// todo 实时过滤方法，用户在输入框输入内容时会调用，以更新当前页和搜索关键词
import {throttle} from "lodash";
// 根据第二个参数判断是否执行
// is_exec默认为true
const filterMethod = (query, is_exec = true) => {
  // 解决当用户选中下拉选项时，会触发两次请求，一次是搜索，一次是选中，所以需要判断是否执行
  if (!is_exec||query==='') {
    return
  }
  // 区分focusMethod 和 输入框输入时为空字符串调用
  if (query === 'focusMethod'){
    query = ''
  }
  copyValue.value = query;
  props.pageInfo.pageNum = 1
  emit('selectPageChange', query);
};

// debounceFilterMethod是通过lodash 的 throttle 函数对 filterMethod 进行节流处理后返回的一个新方法
const debounceFilterMethod = throttle(filterMethod, 300, {
  leading: true, // 延长开始后调用
  trailing: false, // 延长结束前调用
})


// 当选择器聚焦时调用，如果数据列表为空，则清空搜索关键词
const focusMethod = () => {
  if (!props.dataList || (props.dataList && props.dataList.length === 0)) {
    debounceFilterMethod('focusMethod');
  }
};

// 当用户清空选择器时调用，重置当前页和搜索关键词
const selectClear = () => {
  props.pageInfo.pageNum = 1
  emit('selectPageChange');
};

// 分页器的当前页发生改变时调用，更新父组件的当前页码
const handleCurrentChange = (pageNum) => {
  props.pageInfo.pageNum = pageNum
  let searchVal = copyValue.value

  // 解决分页器bug :当选中选项 -> 查询 -> 会修改pageSize,当前组件的handleCurrentChange->触发多个渲染事件
  emit('selectPageChange', searchVal);
};
</script>

<style scoped lang="scss">
// 为选择器自定义样式，去除默认边框，使其更适合分页数据选择的场景
.elPaginationSelect {
  width: 100%;
  border: none !important;
}

// 自定义输入框样式，去除默认边框，设置宽度以适应内容
.elPaginationSelect .el-input__inner {
  border: none !important;
  width: 100%;
}
</style>

3.使用 ElCustomOptionForSearch.vue 组件

现在，您可以在任何 Vue 组件中使用 ElCustomOptionForSearch 组件来实现带有分页和搜索功能的下拉选择框。

<template>
  <div class="app-container">
    <el-form :model="queryParams" ref="queryRef" :inline="true" v-show="showSearch" label-width="68px">
      <el-form-item label="点位名称" prop="nodeName">
        <el-input
            v-model="queryParams.nodeName"
            placeholder="请输入点位名称"
            clearable
            @keyup.enter="handleQuery"
        />
      </el-form-item>

      <el-form-item label="区域搜索" prop="regionId">
        <el-custom-option-for-search
            v-model="queryParams.regionId"
            :data-list="selectDataList"
            :label-key="'regionName'"
            :value-key="'id'"
            :pageInfo="selectPageInfo"
            :disabled="false"
            :el-select-class="true"
            @selectChange="handleRegionChange"
            @selectPageChange="getRegionDataList"
            :queryParams="queryParams"
            placeholder="请选择区域"
        />
      </el-form-item>

      <el-form-item>
        <el-button type="primary" icon="Search" @click="handleQuery">搜索</el-button>
        <el-button icon="Refresh" @click="resetQuery">重置</el-button>
      </el-form-item>
    </el-form>

    <el-row :gutter="10" class="mb8">
      <el-col :span="1.5">
        <el-button
            type="primary"
            plain
            icon="Plus"
            @click="handleAdd"
            v-hasPermi="['manage:node:add']"
        >新增
        </el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
            type="success"
            plain
            icon="Edit"
            :disabled="single"
            @click="handleUpdate"
            v-hasPermi="['manage:node:edit']"
        >修改
        </el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
            type="danger"
            plain
            icon="Delete"
            :disabled="multiple"
            @click="handleDelete"
            v-hasPermi="['manage:node:remove']"
        >删除
        </el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
            type="warning"
            plain
            icon="Download"
            @click="handleExport"
            v-hasPermi="['manage:node:export']"
        >导出
        </el-button>
      </el-col>
      <right-toolbar v-model:showSearch="showSearch" @queryTable="getList"></right-toolbar>
    </el-row>

    <el-table v-loading="loading" :data="nodeList" @selection-change="handleSelectionChange">
      <el-table-column type="selection" width="55" align="center"/>
      <el-table-column label="序号" width="55" type="index" align="center" prop="id"/>
      <el-table-column label="点位名称" align="center" prop="nodeName"/>
      <el-table-column label="详细地址" align="center" prop="address"/>
      <el-table-column label="商圈类型" align="center" prop="businessType">
        <template #default="scope">
          <dict-tag :options="business_type" :value="scope.row.businessType"/>
        </template>
      </el-table-column>
      <el-table-column label="区域名称" align="center" prop="regionId"/>
      <el-table-column label="合作商名称" align="center" prop="partnerId"/>
      <el-table-column label="备注" align="center" prop="remark"/>
      <el-table-column label="操作" align="center" class-name="small-padding fixed-width">
        <template #default="scope">
          <el-button link type="primary" icon="Edit" @click="handleUpdate(scope.row)" v-hasPermi="['manage:node:edit']">
            修改
          </el-button>
          <el-button link type="primary" icon="Delete" @click="handleDelete(scope.row)"
                     v-hasPermi="['manage:node:remove']">删除
          </el-button>
        </template>
      </el-table-column>
    </el-table>

    <pagination
        v-show="total>0"
        :total="total"
        v-model:page="queryParams.pageNum"
        v-model:limit="queryParams.pageSize"
        @pagination="getList"
    />

    <!-- 添加或修改点位管理对话框 -->
    <el-dialog :title="title" v-model="open" width="500px" append-to-body>
      <el-form ref="nodeRef" :model="form" :rules="rules" label-width="80px">
        <el-form-item label="点位名称" prop="nodeName">
          <el-input v-model="form.nodeName" placeholder="请输入点位名称"/>
        </el-form-item>

        <el-form-item label="商圈类型" prop="businessType">
          <el-select v-model="form.businessType" placeholder="请选择商圈类型">
            <el-option
                v-for="dict in business_type"
                :key="dict.value"
                :label="dict.label"
                :value="parseInt(dict.value)"
            ></el-option>
          </el-select>
        </el-form-item>
        <el-form-item label="区域名称" prop="regionId">
<!--          todo-->
          <el-custom-option-for-search
              v-model="queryRegionParams.regionId"
              :data-list="formRegionList"
              :label-key="'regionName'"
              :value-key="'id'"
              :pageInfo="formRegionPageInfo"
              :disabled="false"
              :el-select-class="true"
              @selectChange="handleFormRegionChange"
              @selectPageChange="getFormRegionList"
              :queryParams="queryRegionParams"
              placeholder="请选择区域"
          />
        </el-form-item>
<!--        todo 合作商-->
        <el-form-item label="合作商名称" prop="partnerId" label-width="95px">
              <el-custom-option-for-search
              v-model="queryPartnerParams.partnerId"
              :data-list="formPartnerList"
              :label-key="'partnerName'"
              :value-key="'id'"
              :pageInfo="formPartnerPageInfo"
              :disabled="false"
              :el-select-class="true"
              @selectChange="handleFormPartnerChange"
              @selectPageChange="getFormPartnerList"
              :queryParams="queryPartnerParams"
              placeholder="请选择合作商"
          />
        </el-form-item>
        <el-form-item label="详细地址" prop="address">
          <el-input v-model="form.address" placeholder="请输入详细地址"/>
        </el-form-item>
      </el-form>
      <template #footer>
        <div class="dialog-footer">
          <el-button type="primary" @click="submitForm">确 定</el-button>
          <el-button @click="cancel">取 消</el-button>
        </div>
      </template>
    </el-dialog>
  </div>
</template>

<script setup name="Node">
import {listNode, getNode, delNode, addNode, updateNode} from "@/api/manage/node";
import ElCustomOptionForSearch from "@/components/ElCustomOptionForSearch"
import {listRegion} from "@/api/manage/region.js";
import {useCustomOptionSearch, usePageInfo} from "@/components/ElCustomOptionForSearch/hook/useCustomOption.js";
import {listPartner} from "@/api/manage/partner.js";

const {proxy} = getCurrentInstance();
const {business_type} = proxy.useDict('business_type');

const nodeList = ref([]);
const open = ref(false);
const loading = ref(true);
const showSearch = ref(true);
const ids = ref([]);
const single = ref(true);
const multiple = ref(true);
const total = ref(0);
const title = ref("");

const data = reactive({
  form: {

  },
  queryParams: {
    pageNum: 1,
    pageSize: 10,
    nodeName: null,
    regionId: null,
    partnerId: null,
  },


  rules: {
    nodeName: [
      {required: true, message: "点位名称不能为空", trigger: "blur"}
    ],
    address: [
      {required: true, message: "详细地址不能为空", trigger: "blur"}
    ],
    businessType: [
      {required: true, message: "商圈类型不能为空", trigger: "change"}
    ],
    regionId: [
      {required: true, message: "区域名称不能为空", trigger: "blur"}
    ],
    partnerId: [
      {required: true, message: "合作商名称不能为空", trigger: "blur"}
    ],
  }
});
let {queryParams, form, rules} = toRefs(data);


/** 查询点位管理列表 */
function getList() {
  loading.value = true;
  listNode(queryParams.value).then(response => {
    nodeList.value = response.rows;
    total.value = response.total;
    loading.value = false;
  });
}

// 取消按钮
function cancel() {
  open.value = false;
  reset();
}
/* 修改和新增表单的区域名称查询和合作商名称查询 */
// todo
let formRegionList = ref([])
let formPartnerList = ref([])
let queryRegionParams = ref({
    regionId:null,
    pageNum:1,
    pageSize:10
})
let  queryPartnerParams = ref({
    PartnerId:null,
    pageNum:1,
    pageSize:10
})
const {pageInfo:formRegionPageInfo,resetPageInfo} =  usePageInfo()
const {pageInfo:formPartnerPageInfo} =  usePageInfo()
const {
  getDataList:getFormRegionList,
  handleSelectChange:handleFormRegionChange
} = useCustomOptionSearch(listRegion, 'regionId', 'regionName', formRegionPageInfo, formRegionList,queryRegionParams)
const {
  getDataList:getFormPartnerList,
  handleSelectChange:handleFormPartnerChange
} = useCustomOptionSearch(listPartner,'partnerId','partnerName',formPartnerPageInfo,formPartnerList,queryPartnerParams)
// 重置表单查询条件
function resetFormQuery() {
  queryRegionParams.value = {
    pageNum: 1,
    pageSize: 10,
    regionId: null,
  };
  queryPartnerParams.value = {
    pageNum: 1,
    pageSize: 10,
    partner: null,
  };
  formRegionList.value = []
  formPartnerList.value = []
  resetPageInfo(formRegionPageInfo)
  resetPageInfo(formPartnerPageInfo)

}

watchEffect(() => {
  form.value.regionId = queryRegionParams.value.regionId
  form.value.partnerId = queryPartnerParams.value.partnerId
})
// 表单重置
function reset() {
  form.value = {
    id: null,
    nodeName: null,
    address: null,
    businessType: null,
    regionId: null,
    partnerId: null,
    createTime: null,
    updateTime: null,
    createBy: null,
    updateBy: null,
    remark: null,
  };
  resetFormQuery()

  proxy.resetForm("nodeRef");
}

/** 搜索栏查询区域列表操作 */

// todo
const selectDataList = ref([])
const {pageInfo:selectPageInfo} = usePageInfo()
const {
  getDataList:getRegionDataList,
  handleSelectChange:handleRegionChange
} = useCustomOptionSearch(listRegion, "regionId", 'regionName',selectPageInfo,selectDataList,queryParams)


/** 搜索按钮操作 */
function handleQuery() {
  queryParams.value.pageNum = 1;
  getList();
}

/** 重置按钮操作 */
function resetQuery() {
  proxy.resetForm("queryRef");
  handleQuery();
}

// 多选框选中数据
function handleSelectionChange(selection) {
  ids.value = selection.map(item => item.id);
  single.value = selection.length != 1;
  multiple.value = !selection.length;
}

/** 新增按钮操作 */
function handleAdd() {
  reset();
  open.value = true;
  title.value = "添加点位管理";
}

/** 修改按钮操作 */
function handleUpdate(row) {
  reset();
  const _id = row.id || ids.value
  getNode(_id).then(response => {
    form.value = response.data;
    // 回显区域名称
    queryRegionParams.value.regionId = response.data.regionId
    queryPartnerParams.value.partnerId = response.data.partnerId
    getFormRegionList('')
    getFormPartnerList('')
    open.value = true;
    title.value = "修改点位管理";
  });
}

/** 提交按钮 */
function submitForm() {
  proxy.$refs["nodeRef"].validate(valid => {
    if (valid) {
      if (form.value.id != null) {
        updateNode(form.value).then(response => {
          proxy.$modal.msgSuccess("修改成功");
          open.value = false;
          getList();
        });
      } else {
        addNode(form.value).then(response => {
          proxy.$modal.msgSuccess("新增成功");
          open.value = false;
          getList();
        });
      }
    }
  });
}

/** 删除按钮操作 */
function handleDelete(row) {
  const _ids = row.id || ids.value;
  proxy.$modal.confirm('是否确认删除点位管理编号为"' + _ids + '"的数据项？').then(function () {
    return delNode(_ids);
  }).then(() => {
    getList();
    proxy.$modal.msgSuccess("删除成功");
  }).catch(() => {
  });
}

/** 导出按钮操作 */
function handleExport() {
  proxy.download('manage/node/export', {
    ...queryParams.value
  }, `node_${new Date().getTime()}.xlsx`)
}

getList();
</script>