Vue 2.x折腾记 - (8) 写一个挺靠谱的多地区选择组件

时间 2019-12-05

标签 vue 2.x 折腾一个靠谱地区选择组件繁體版

原文原文链接

前言

这个不是三级联动的地址组件,这是在这个基础需求上增长多地区选择的功能;css

我也不想这么个玩意的,可是产品需求就是有这么个东东。html

上基友社区找了下,又木有这类型的组件，只能本身动手丰衣足食了。vue

虽然过程遇到了许许多多的坑点,但总算是搞出来了。react

效果图

功能点:web

支持不限城市,不限地区(这个东西的实现..真心死磕了挺久) -- 左右两边数据的同步
地区一次性多选,如果选择了全部地区会自动转为不限地区
数据迁移箭头的判断..选中数据才会有对应的按钮能够点击
已选位置的数据同步响应调用的地方,固然也能够外部传入...(新增传出,编辑依赖传入再组合)
箭头是iconfont,支持外部传入,默认是我这边的cdn的啦....

!!!这是一个独立的组件,css预处理是用的scss;后端

写的过程遇到的问题:数组

由于这个功能会屡次须要切换省份城市这些,因此我一次性拉取全部数据存储到localstorage,否则请求接口次数太多了
一开始的不限城市和不限地区我想并入JSON(重组JSON),可是发现虽然能下降处理麻烦,可是数据更乱了...很是很差维护,也有其余组件调用这个JSON的地方(好比其余组件有个地址的三级联动也是依赖这个JSON)
还有一个就是要考虑两边有不限制这东东的时候,要剔除不能存在的数据,好比你不限制城市,那全部该省份的城市都要干掉,不限制地区也是相似
写左右两边数据的对比是最恶心的,为何这么说呢?
左边三级联动的,每一个子项都有本身的id和name, 而选择的是组合成的(看GIF图),中间是中划线隔开,这对于推入和推出就带来一堆遍历和比较
咱们这边的后端大佬说不限制的id均为0(城市或者地区),因此这个须要自行组合,最后就是动态图那格式的ID就是后台接受的,,多地区再拼接成字符串....'3-13-2,2-44-3,4-0-0'这种提交到后台..

联动JSON数据格式app

regionName: 项的名称
regionId: 项的ID
child: 是否包含有子项

原本想写个props映射下regionName,regionId,child; 可是感受做用不大,就没写了,(通常公司的地区JSON格式定下来了以后变更的可能性过低)this

你能学到什么?spa

1: 数组的比对,数组的遍历,数组的组合及响应判断 2: vue一些内置指令的使用 3: 组件功能细节的考虑,不限制地区,所有这些按钮在什么状况下能点击 4: 清空数据以后各个状态的恢复和重置等等

代码

manyAreaSelect.vue

<template>
  <div class="manyAreaSelect">
    <div class="item">
      <div class="item-title">
        <span> 选择省</span>
      </div>
      <div class="item-content">
        <ul>
          <li v-for="(item,index) in chinaArea" :class="item.selected?'active':''" :key="index" @click="getCityList(item)">{{item.regionName}}</li>
        </ul>
      </div>
      <div class="item-footer"></div>
    </div>
    <div class="item">
      <div class="item-title">
        <span>选择市</span>
      </div>
      <div class="item-content">
        <ul v-show="cityList.length===0">
          <li><<请选择省份</li>
        </ul>
        <ul v-show="!notLimitButton.notLimitCity &&cityList.length!==0">
          <li v-for="(item,index) in cityList" :class="item.selected ? 'active':''" :key="index" @click="getDistricList(item)">{{item.regionName}}</li>
        </ul>
      </div>
      <div class="item-footer">
        <button type="button" class="button" :class="notLimitButton.notLimitCity?'success':''" @click="cityNotLitmit({regionName:'不限',regionId:'0'})"  :disabled="!selectItem.province.regionName">不限城市</button>
      </div>
    </div>
    <div class="item">
      <div class="item-title">
        <span>选择地区</span>
      </div>
      <div class="item-content">
        <ul v-show="districList.length===0">
          <li>
            <<请选择城市</li>
        </ul>
        <ul v-show="!notLimitButton.notLimitCity && !notLimitButton.notLimitDistrict && districList.length!==0">
          <li v-for="(item,index) in districList" :class="item.selected?'active':''" :key="index" @click="getAreaCombineID(item)">{{item.regionName}}</li>
        </ul>
      </div>
      <div class="item-footer">
        <button type="button" class="button" :class="notLimitButton.notLimitDistrict ?'success':''" @click="districNotLitmit({regionName:'不限',regionId:'0'})" :disabled="!selectItem.city.regionName ||!selectItem.province.regionName || notLimitButton.notLimitCity ">不限地区</button>
      </div>
    </div>
    <div class="trangle">
      <div class="trangle-wrap">
        <div class="left">
          <button type="button" class="button" @click="transferToRight" :disabled="direactionStatusToRight">
            <i :class="this.iconDirection.right"></i>
          </button>
        </div>
        <div class="right">
          <button type="button" class="button" @click="transferToLeft" :disabled="direactionStatusToLeft">
            <i :class="this.iconDirection.left"></i>
          </button>
        </div>
      </div>
    </div>
    <div class=" item ">
      <div class="item-title ">
        <span>已选位置</span>
      </div>
      <div class="item-content ">
        <ul class="selectedContent">
          <li v-for="(item,index) in selectedList" :class="item.selected?'active':''" :key="index" @click="selectedAreaSingle(item)">{{item.regionName}}</li>
        </ul>
      </div>
      <div class="item-footer">
        <button type="button" class="button" @click="selectedAllArea()" :disabled="rightDataList.length=== 0" :class="selectedAllButtonStatus?'success':''">{{selectedAllButtonStatus?'反选':'所有'}}</button>
      </div>
    </div>
  </div>
</template>

<script>
  import _ from 'lodash';
  export default {
    name: 'manyAreaSelect',
    data: function () {
      return {
        chinaArea: JSON.parse(window.localStorage.getItem('chinaArea')) || [], // 这是地区联动的JSON
        notLimitButton: {
          notLimitCity: false,  // 城市不限
          notLimitDistrict: false,  // 地区不限
        },
        selectedAllButtonStatus: false, // 已选位置列表所有按钮的状态
        selectItem: {
          province: {},
          city: {},
          distric: {}
        },
        cityList: [], // 城市列表
        districList: [], // 区域列表
        rightDataList: [], // 选中项目组合成的渲染列表
        rightData: [], // 选中须要移除的
        leftData: [], // 左边选中的转发
      }
    },
    props: {
      selectedData: {
        type: [String, Object, Array]
      },
      iconDirection: {
        type: Object,
        default: function () { // 箭头图标
          return {
            left: 'fzicon fz-ad-you',
            right: 'fzicon fz-ad-right'
          }
        }
      }
    },
    computed: {
      selectedList () {  // 已选中列表
        if (this.selectedData && this.selectedData !== '') {
          this.rightDataList = this.selectedData;
          return this.rightDataList;
        } else {
          return this.rightDataList;
        }

      },
      direactionStatusToRight () { // 控制能够转移的箭头状态
        if (this.notLimitButton.notLimitCity || this.notLimitButton.notLimitDistrict) {
          if (this.notLimitButton.notLimitCity) {
            this.removeAllSelected(this.cityList);
            this.removeAllSelected(this.districList);
            return false;
          } else {
            if (this.notLimitButton.notLimitDistrict) {
              this.removeAllSelected(this.districList);
              return false;
            }
          }
          return false;
        } else {
          if (this.selectItem.distric.regionName) {
            return false;
          }
          return true;
        }
      },
      direactionStatusToLeft () { // 控制能够转移的箭头状态
        if (this.rightData.length === 0) {
          return true
        } else {
          return false
        }
      }
    },
    methods: {
      mapSelect (list, value, type) {  // 高亮选中
        if (type) {
          return list.map(pitem => {
            if (pitem.regionId === value.regionId) {
              if (value.selected && value.selected === true) {
                this.$delete(pitem, 'selected');
              } else {
                this.$set(pitem, 'selected', true)
              }
            }
          })
        } else {
          return list.map(pitem => {
            if (pitem.regionId === value.regionId) {
              if (value.selected && value.selected === true) {
                this.$delete(pitem, 'selected');
              } else {
                this.$set(pitem, 'selected', true)
              }
            } else {
              this.$delete(pitem, 'selected');
            }
          })
        }
      },
      resetToDefault () {
        this.leftData = []; // 清空须要转移的数组
        this.notLimitButton = {  // 重置按钮状态
          notLimitCity: false,  // 城市不限
          notLimitDistrict: false,  // 地区不限
        };
        this.selectItem.city = {};
        this.selectItem.distric = {}
        this.removeAllSelected(this.cityList);  // 清除选中状态
        this.removeAllSelected(this.districList); // 清除选中状态
        this.cityList = [];
        this.districList = [];
      },
      getCityList (item) {
        this.resetToDefault();
        if (item) {
          this.cityList = item.child;  // 获取城市列表
          this.selectItem.province = item;  // 保存省份对象
          this.mapSelect(this.chinaArea, item); // 高亮选择,单选
        }
      },
      getDistricList (item) {
        this.leftData = []; // 清空须要转移的数组
        this.notLimitButton.notLimitDistrict = false; // 重置按钮状态
        this.removeAllSelected(this.districList); // 清除选中状态
        this.selectItem.distric = {};
        this.districList = [];
        if (item) {
          this.districList = item.child; // 获取区域列表
          this.selectItem.city = item; // 保存省份对象
          this.mapSelect(this.cityList, item); // 高亮选择,单选
        }

      },
      getAreaCombineID (item) {  // 获取组合ID
        console.log(this.leftData)
        if (item) {
          this.selectItem.distric = item;
          this.mapSelect(this.districList, item, 'manySelect'); // 区域高亮选择,多选

          this.leftData.push({
            regionName: this.selectItem.province.regionName + '-' + this.selectItem.city.regionName + '-' + item.regionName,
            regionId: this.selectItem.province.regionId + '-' + this.selectItem.city.regionId + '-' + item.regionId
          })
          this.leftData = _.uniqBy(this.leftData, 'regionId');
          if (this.leftData.length === this.districList.length) {
            this.leftData = [];
            this.selectItem.distric = {};
            this.notLimitButton.notLimitDistrict = true; // 转为不限制地区
            this.leftData.push({
              regionName: this.selectItem.province.regionName + '-' + this.selectItem.city.regionName + '-不限',
              regionId: this.selectItem.province.regionId + '-' + this.selectItem.city.regionId + '-0'
            })
          }
        }

      },
      cityNotLitmit (item) {  // 城市不限
        this.leftData = []; // 请空数组
        this.selectItem.distric = {};
        this.removeAllSelected(this.districList);
        this.notLimitButton.notLimitCity = !this.notLimitButton.notLimitCity; // 不限按钮状态
        this.leftData.push({
          regionName: this.selectItem.province.regionName + '-不限-不限',
          regionId: this.selectItem.province.regionId + '-0-0'
        })
      },
      districNotLitmit (item) { // 区域不限
        this.leftData = []; // 请空数组
        this.notLimitButton.notLimitDistrict = !this.notLimitButton.notLimitDistrict; // 不限按钮状态
        this.leftData.push({
          regionName: this.selectItem.province.regionName + '-' + this.selectItem.city.regionName + '-不限',
          regionId: this.selectItem.province.regionId + '-' + this.selectItem.city.regionId + '-0'
        })
        if (!this.notLimitButton.notLimitDistrict) {
          this.leftData = [];
        }
      },
      transferToRight () { // 选中推入到已选中列表区域
        if (this.leftData && this.leftData.length !== 0) {
          if (this.leftData.length === 1) {  // 长度只有1,那就只有不限城市或者地区了
            let limitId = this.leftData[0].regionId.split('-');  // 比对比对,切割成数组
            this.rightDataList.map(item => {
              let id = item.regionId.split('-');
              if (limitId[0] === id[0]) {
                if (limitId[1] === '0') {  // 不限城市
                  this.rightDataList = this.rightDataList.filter(ritem => {
                    let rid = ritem.regionId.split('-');
                    if (limitId[0] !== rid[0]) {
                      return ritem;
                    }
                  })
                } else {
                  if (limitId[2] === '0') { // 不限地区
                    this.rightDataList = this.rightDataList.filter(ritem => {
                      let rid = ritem.regionId.split('-');
                      if ((limitId[0] === rid[0] && limitId[1] === rid[1])) {
                        if (ritem[2] === '0') {
                          return ritem;
                        }
                      } else {
                        if (limitId[0] !== rid[0] || limitId[1] !== rid[1]) {
                          return ritem;
                        }
                      }
                    })
                  } else {
                    this.rightDataList = this.rightDataList.filter(ritem => {
                      let rid = ritem.regionId.split('-');
                      if (limitId[0] === rid[0]) {
                        if (limitId[1] === rid[1]) {
                          if (!(rid[2] === '0')) {
                            return ritem;
                          }
                        } else {
                          if (!(rid[1] === '0')) {
                            return ritem
                          }
                        }
                      } else {
                        return ritem
                      }
                    })
                  }
                }

              }
            })
          } else {
            let limitId = this.leftData[0].regionId.split('-');  // 比对比对,切割成数组
            this.rightDataList = this.rightDataList.filter(ritem => {
              let rid = ritem.regionId.split('-');
              if (limitId[0] === rid[0]) {
                if (limitId[1] === rid[1]) {
                  if (!(rid[2] === '0')) {
                    return ritem;
                  }
                } else {
                  if (!(rid[1] === '0')) {
                    return ritem
                  }
                }
              } else {
                return ritem
              }
            })
          }
          this.leftData.map(item => {
            this.rightDataList.push(item);
          })
          this.rightDataList = _.uniqBy(this.rightDataList, 'regionId');
          this.resetToDefault();
        }


      },
      selectedAreaSingle (item) {  // 已选择区域单个选择
        if (item) {
          this.rightData = [];
          this.mapSelect(this.rightDataList, item, 'manySelect'); // 区域高亮选择,多选
          this.rightDataList.map(item => {
            if (item.selected) {
              this.rightData.push(item)
            }
          })
        }

      },
      selectedAllArea () { // 已选中区域全选反选
        if (this.selectedAllButtonStatus) {
          this.removeAllSelected(this.rightDataList);
          this.rightData = [];
        } else {
          this.rightDataList.map(item => this.$set(item, 'selected', true));
          this.rightData = this.rightDataList;
        }
        this.selectedAllButtonStatus = !this.selectedAllButtonStatus;
      },
      transferToLeft () {  // 从已选中列表区域退回待转发区域
        if (this.rightData && this.rightData.length !== 0) {
          this.rightDataList = this.rightDataList.filter(item => {
            if (!item.selected) {
              return item;
            }
          })
          this.rightData = [];
        }
      },
      removeAllSelected (list) {  // 清空选中状态
        list.map(item => this.$delete(item, 'selected'));
      }
    },
    watch: {
      'rightDataList' (newValue, oldValue) {  // 选择列表的值变更响应外部值的变更
        if (newValue.length !== this.rightData.length) {
          this.selectedAllButtonStatus = false;
        } else {
          if (newValue.length === 0) {
            this.selectedAllButtonStatus = false;
          } else {
            this.selectedAllButtonStatus = true;
          }
        }
        this.$emit('update:selectedData', newValue);
      }
    }
  }
</script>

<style scoped lang="scss">
  ul {
    padding: 0;
    margin: 0;
    max-height: 100%;
    overflow-y: auto;
    li {
      cursor: pointer;
      text-align: center;
      padding: 5px;
      &.active,
      &:hover {
        background: #e4e8f1;
        color: #48576a;
      }
    }
  }

  .manyAreaSelect {
    position: relative;
    z-index: 2005;
    .item {
      border: 1px solid #d1dbe5;
      background: #fff;
      box-shadow: 0 2px 4px rgba(0, 0, 0, .12), 0 0 6px rgba(0, 0, 0, .04);
      display: inline-block;
      vertical-align: middle;
      min-width: 180px;
      box-sizing: border-box;
      position: relative;
      height: 100%;
      min-height: 260px;
      margin: 5px;
    }
    .item-title {
      height: 36px;
      line-height: 36px;
      background: #fbfdff;
      margin: 0;
      border-bottom: 1px solid #d1dbe5;
      box-sizing: border-box;
      color: #1f2d3d;
      text-align: center;
    }
    .trangle {
      background: transparent;
      display: inline-block;
      vertical-align: middle;
      width: 40px;
      box-sizing: border-box;
      height: 100%;
      position: relative;
      .trangle-wrap {
        position: absolute;
        top: 50%;
        left: 50%;
        transform: translate(-50%, -50%);
      }
      .left,
      .right {
        margin: 10px 5px;
      }
      ;
    }

    .item-content {
      font-size: 13px;
      height: 190px;
      padding: 8px 2px;
    }
    .item-footer {
      padding: 5px 0;
      height: 40px;
      text-align: center;
    }
  }

  .selectedContent {
    li {
      text-align: left;
      padding-left: 25px;
    }
  }



  .button {
    display: inline-block;
    line-height: 1;
    white-space: nowrap;
    cursor: pointer;
    background: #fff;
    border: 1px solid #c4c4c4;
    color: #1f2d3d;
    margin: 0;
    border-radius: 4px;
    padding: 4px;
    font-size: 12px;
    border-radius: 4px;
    -webkit-appearance: button;
    outline: none;
    &.success {
      background: #42d885;
      border-color: #42d885;
      color: #fff;
    }

    &:disabled {
      color: #bfcbd9;
      cursor: not-allowed;
      background-image: none;
      background-color: #eef1f6;
      border-color: #d1dbe5;
    }
  }
</style>

复制代码

用法

<!--selectedData就是响应的数据.sync是2.3回归的语法糖-->
<!--能够绑定iconDirection传入箭头的iconfont,Object-->

<many-area-select :selectedData.sync="manyAreaValue"></many-area-select>
复制代码

总结

写的过程推倒了三版(三天三个版本),都是思路没想对和理清，

有不对之处请留言，会及时修正，谢谢阅读。