【组件封装】改造 Element-UI 多选框组件 (el-checkbox)

code.jpg

el-checkbox多选框组件

element-ui官网的多选框组件,是采用简单数组进行配置的,显示的lable值与勾选后的值是同一个

el-checkbox.jpg

实际业务场景

在实际业务开发中,我们更多遇到是如下数组对象的格式。

我们需要额外将数组进行label、value的拆分才能使用 el-checkbox 。

如果要实现勾选、全选、默认赋值的场景,将需要更加复杂的代码处理。


[

  { label: '小红', value: '1' },

  { label: '小明', value: '2' },

  { label: '小芳', value: '3' }

]

组件设计(简易版本)

调用效果及代码

show1.png

<!--

 * @Date: 2020-12-09 17:52:54

 * @Author: surewinT 840325271@qq.com

 * @LastEditTime: 2022-05-09 14:22:01

 * @LastEditors: surewinT 840325271@qq.com

 * @Description: 调用页面

-->

<template>

    <div class="">

        <Test :checkboxList="checkboxList" v-model="result" />

    </div>

</template>

<script>

import Test from "./test.vue";

export default {

    components: {

        Test,

    },

    props: [],

    data() {

        return {

            checkboxList: [

                { label: "小红", value: "1" },

                { label: "小明", value: "2" },

                { label: "小芳", value: "3" },

            ],

            result: [],

        };

    },

    mounted() {},

    watch: {

        result() {

            console.log("变化了:", this.result);

        },

    },

    methods: {},

};

</script>

<style lang='scss' scoped>

</style>

改造后的组件(test.vue)


<!--

 * @Date: 2022-05-09 11:52:02

 * @Author: surewinT 840325271@qq.com

 * @LastEditTime: 2022-05-09 14:22:10

 * @LastEditors: surewinT 840325271@qq.com

 * @Description: 改造后的组件

-->

<template>

    <div class="">

        <el-checkbox-group v-model="labelResult">

            <el-checkbox v-for="(item, index) in labelList" :key="index" :label="item"> </el-checkbox>

        </el-checkbox-group>

    </div>

</template>

<script>

export default {

    components: {},

    props: {

        checkboxList: {

            type: Array,

            default: () => {

                return [];

            },

        },

    },

    data() {

        return {

            labelResult: [],

            labelList: [],

            labelMap: {},

        };

    },

    mounted() {

        this.loadData();

    },

    watch: {},

    methods: {

        // 初始化数据

        loadData() {

            this.checkboxList.forEach((res) => {

                this.labelList.push(res["label"]);

                this.labelMap[res["label"]] = res["value"];

            });

        },

    },

};

</script>

<style lang='scss' scoped>

</style>

组件设计(完整版)

组件简介

p-el-checkbox.png

调用效果及代码

show2.png

<!--

 * @Date: 2020-12-09 17:52:54

 * @Author: surewinT 840325271@qq.com

 * @LastEditTime: 2022-05-09 14:49:13

 * @LastEditors: surewinT 840325271@qq.com

 * @Description: 调用页面

-->

<template>

    <div class="">

        <p-el-checkbox

            v-model="result"

            resultType="Array"

            label="name"

            prop="id"

            :defaultCheck="defaultCheck"

            :checkboxList="checkboxList"

        />

    </div>

</template>

<script>

import Pelcheckbox from "./p-el-checkbox.vue";

export default {

    components: {

        "p-el-checkbox": Pelcheckbox,

    },

    props: [],

    data() {

        return {

            defaultCheck: ["1", "3"],

            checkboxList: [

                { name: "小红", id: "1" },

                { name: "小明", id: "2" },

                { name: "小芳", id: "3" },

            ],

            result: {},

        };

    },

    mounted() {},

    watch: {

        result: function () {

            console.log("变化了:", this.result);

        },

    },

    methods: {},

};

</script>

<style lang='scss' scoped>

</style>

组件源码(p-el-checkbox.vue)


<!--

 * @Author: surewinT 840325271@qq.com

 * @LastEditTime: 2022-05-09 14:57:09

 * @LastEditors: surewinT 840325271@qq.com

 * @Description: 改造 Element-UI 多选框组件 (el-checkbox)

-->

<template>

    <div :class="customClass">

        <el-checkbox

            v-if="showCheckAll"

            :indeterminate="isIndeterminate"

            v-model="checkAll"

            @change="handleCheckAllChange"

        >

            全选

        </el-checkbox>

        <el-checkbox-group v-model="labelResult" :class="inline ? '' : 'al_checkbox'">

            <span v-for="(item, index) in labelList" :key="index">

                <el-checkbox :label="item" :class="labelClass" @change="handleCheckChange" v-if="judgeHidden(item)">

                    <span>

                        <slot

                            name="label"

                            :index="index"

                            :label="item"

                            :checkboxList="checkboxList"

                            :disabled="checkboxMap[item] && checkboxMap[item].disabled"

                            :data="checkboxList[index] ? JSON.parse(JSON.stringify(checkboxList[index])) : {}"

                        >

                            <span> {{ item }} </span>

                        </slot>

                    </span>

                </el-checkbox>

            </span>

        </el-checkbox-group>

    </div>

</template>

<script>

/**

 * @description:props说明

 * @param {Boolean} showCheckAll -是否显示全选按钮

 * @param {Boolean} inline -是否是行内表单

 * @param {Array<Object>} checkboxList -多选框组件的数据配置

 * @param {String} label -label对应的字段

 * @param {String} prop -value对应的字段

 * @param {Array} defaultCheck -默认勾选的项

 * @param {String} resultType -绑定值的类型(支持对象、数组两种格式)

 * @param {String} labelClass -单个选项绑定类名,可用于自定义样式

 * @param {String} customClass -多选框的绑定类型,可用于自定义样式

 * @param {Array} checkboxHidden -隐藏的表单项,元素对应checkboxList中prop的值

 */

export default {

    name: "p-el-checkbox",

    props: {

        showCheckAll: {

            type: Boolean,

            default: true,

        },

        inline: {

            type: Boolean,

            default: true,

        },

        checkboxList: {

            type: Array,

            default: () => {

                return [];

            },

        },

        label: {

            type: String,

            default: "label",

        },

        prop: {

            type: String,

            default: "value",

        },

        defaultCheck: {

            type: Array,

            default: () => {

                return [];

            },

        },

        resultType: {

            type: String,

            default: "Array", // 可选:Array 、Object

        },

        labelClass: {

            type: String,

            default: "",

        },

        customClass: {

            type: String,

            default: "",

        },

        checkboxHidden: {

            type: Array,

            default: function () {

                return [];

            },

        },

    },

    data() {

        return {

            labelList: [],

            labelResult: [],

            labelMap: {}, // label与res的映射(res指checkboxList每一项元素)

            isIndeterminate: false,

            checkAll: false,

            currentLabel: null,

            currentValue: null,

        };

    },

    mounted() {

        this.loadData();

    },

    computed: {

        arrayRusult: function () {

            let result = [];

            if (this.resultType == "Array") {

                this.labelResult.forEach((res) => {

                    result.push(this.labelMap[res]);

                });

            }

            return result;

        },

        objectRusult: function () {

            let obj = {};

            if (this.resultType == "Object") {

                for (let item in this.labelMap) {

                    if (this.checkboxHidden.indexOf(this.labelMap[item]) != -1) {

                        continue;

                    }

                    if (this.labelResult.indexOf(item) == -1) {

                        obj[this.labelMap[item]] = false;

                    } else {

                        obj[this.labelMap[item]] = true;

                    }

                }

            }

            return obj;

        },

        // 名字映射

        checkboxMap() {

            let obj = {};

            for (let res of this.checkboxList) {

                obj[res[this.label]] = res;

            }

            return obj;

        },

    },

    watch: {

        checkboxList() {

            this.loadData();

        },

        labelResult() {

            this.isIndeterminate = true;

            this.checkAll = false;

            if (this.labelResult.length == 0) {

                this.isIndeterminate = false;

                this.checkAll = false;

            } else if (this.labelResult.length == this.labelList.length - this.checkboxHidden.length) {

                this.isIndeterminate = false;

                this.checkAll = true;

            }

            // 返回数组结果

            if (this.resultType == "Array") {

                this.$emit("input", this.arrayRusult);

            }

            // 返回对象结果

            if (this.resultType == "Object") {

                this.$emit("input", this.objectRusult);

            }

        },

        defaultCheck() {

            this.labelResult = [];

            this.checkboxList.forEach((res) => {

                if (this.defaultCheck.indexOf(res[this.prop]) != -1) {

                    this.labelResult.push(res[this.label]);

                }

            });

        },

    },

    methods: {

        // 初始化数据

        loadData() {

            this.checkboxList.forEach((res) => {

                this.labelList.push(res[this.label]);

                this.labelMap[res[this.label]] = res[this.prop];

                if (this.defaultCheck.indexOf(res[this.prop]) != -1) {

                    this.labelResult.push(res[this.label]);

                }

            });

        },

        // 全选按钮

        handleCheckAllChange(val) {

            this.isIndeterminate = false;

            if (val) {

                this.isIndeterminate = false;

                this.checkAll = true;

                this.labelResult = JSON.parse(JSON.stringify(this.labelList));

                // 过滤隐藏选项

                this.labelResult = this.labelResult.filter((res) => {

                    let exist = this.checkboxHidden.indexOf(this.labelMap[res]);

                    return exist == -1;

                });

            } else {

                this.checkAll = false;

                this.labelResult = [];

            }

        },

        // 单击多选框

        handleCheckChange(val, e) {

            this.currentLabel = this.labelMap[e.target.value];

            this.currentValue = val;

            // 返回数组结果:(勾选结果,点击的prop,点击的prop是否勾选)

            if (this.resultType == "Array") {

                this.$emit("change", this.arrayRusult, this.currentLabel, this.currentValue);

            }

            // 返回对象结果:(勾选结果,点击的prop,点击的prop是否勾选)

            if (this.resultType == "Object") {

                this.$emit("change", this.objectRusult, this.currentLabel, this.currentValue);

            }

        },

        // 隐藏判断

        judgeHidden(name) {

            let show = this.checkboxHidden.indexOf(this.labelMap[name]) == -1 ? true : false;

            return show;

        },

    },

};

</script>

<style lang="scss" scoped>

.el-checkbox {

    display: inline-block;

    padding-right: 10px;

}

.al_checkbox {

    .el-checkbox {

        display: block;

        margin-right: 0;

    }

}

// 滚动条样式修改

::-webkit-scrollbar {

    width: 5px;

}

::-webkit-scrollbar-track {

    -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3);

    box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3);

    -webkit-border-radius: 10px;

    border-radius: 10px;

}

::-webkit-scrollbar-thumb {

    -webkit-border-radius: 10px;

    border-radius: 10px;

    background: rgba(155, 155, 155, 0.8);

    -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.2);

    box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.2);

}

::-webkit-scrollbar-thumb:window-inactive {

    background: rgba(155, 155, 155, 0.1);

}

</style>

仓库源码

改造el-checkbox

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容