Vue 2.x折騰記 - (8) 寫一個挺靠譜的多地區選擇組件

前言

這個不是三級聯動的地址組件,這是在這個基礎需求上增長多地區選擇的功能;

我也不想這麼個玩意的,可是產品需求就是有這麼個東東。

上基友社區找了下,又木有這類型的組件，只能本身動手豐衣足食了。

雖然過程遇到了許許多多的坑點,但總算是搞出來了。

效果圖

功能點:

• 支持不限城市,不限地區(這個東西的實現..真心死磕了挺久) -- 左右兩邊數據的同步
• 地區一次性多選,如果選擇了全部地區會自動轉爲不限地區
• 數據遷移箭頭的判斷..選中數據纔會有對應的按鈕能夠點擊
• 已選位置的數據同步響應調用的地方,固然也能夠外部傳入...(新增傳出,編輯依賴傳入再組合)
• 箭頭是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數據格式

• regionName: 項的名稱
• regionId: 項的ID
• child: 是否包含有子項

原本想寫個props映射下regionName,regionId,child; 可是感受做用不大,就沒寫了,(通常公司的地區JSON格式定下來了以後變更的可能性過低)

你能學到什麼?

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>
複製代碼

總結

寫的過程推倒了三版(三天三個版本),都是思路沒想對和理清，

有不對之處請留言，會及時修正，謝謝閱讀。