Vant Checkbox 復選框

引入

import Vue from 'vue';
import { Checkbox, CheckboxGroup } from 'vant';

Vue.use(Checkbox);
Vue.use(CheckboxGroup);

代碼演示

基礎用法

通過v-model綁定復選框的勾選狀態(tài)

<van-checkbox v-model="checked">復選框</van-checkbox>

export default {
  data() {
    return {
      checked: true
    };
  }
};

禁用狀態(tài)

通過設置disabled屬性可以禁用復選框

<van-checkbox v-model="checked" disabled>復選框</van-checkbox>

禁用文本點擊

設置icon-disabled屬性后，點擊復選框圖標以外的內(nèi)容不會觸發(fā)切換

<van-checkbox v-model="checked" icon-disabled>復選框</van-checkbox>

自定義形狀

將shape屬性設置為square，復選框的形狀會變成方形

<van-checkbox v-model="checked" shape="square">復選框</van-checkbox>

自定義顏色

通過checked-color屬性可以自定義選中狀態(tài)下的圖標顏色

<van-checkbox v-model="checked" checked-color="#07c160">復選框</van-checkbox>

自定義大小

通過icon-size屬性可以自定義圖標的大小

<van-checkbox v-model="checked" icon-size="24px">復選框</van-checkbox>

自定義圖標

通過 icon 插槽自定義圖標，可以通過slotProps判斷是否為選中狀態(tài)

<van-checkbox v-model="checked">
  自定義圖標
  <img
    slot="icon"
    slot-scope="props"
    :src="props.checked ? activeIcon : inactiveIcon"
  >
</van-checkbox>

export default {
  data() {
    checked: true,
    activeIcon: 'https://img.yzcdn.cn/vant/user-active.png',
    inactiveIcon: 'https://img.yzcdn.cn/vant/user-inactive.png'
  }
}

復選框組

復選框可以與復選框組一起使用，選中值是一個數(shù)組，通過v-model綁定在CheckboxGroup上，數(shù)組中的值為選中的復選框的name

<van-checkbox-group v-model="result">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
  <van-checkbox name="c">復選框 c</van-checkbox>
</van-checkbox-group>

export default {
  data() {
    return {
      result: ['a', 'b']
    };
  }
};

設置最大可選數(shù)

通過max屬性可以限制最大可選數(shù)

<van-checkbox-group v-model="result" :max="2">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
  <van-checkbox name="c">復選框 c</van-checkbox>
</van-checkbox-group>

全選與反選

通過CheckboxGroup實例上的toggleAll方法可以實現(xiàn)全選與反選

<van-checkbox-group v-model="result" ref="checkboxGroup">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
  <van-checkbox name="c">復選框 c</van-checkbox>
</van-checkbox-group>

<van-button type="primary" @click="checkAll">全選</van-button>
<van-button type="info" @click="toggleAll">反選</van-button>

export default {
  data() {
    return {
      result: []
    }
  },

  methods: {
    checkAll() {
      this.$refs.checkboxGroup.toggleAll(true);
    },
    toggleAll() {
      this.$refs.checkboxGroup.toggleAll();
    }
  }
}

搭配單元格組件使用

此時你需要再引入Cell和CellGroup組件，并通過Checkbox實例上的 toggle 方法觸發(fā)切換

<van-checkbox-group v-model="result">
  <van-cell-group>
    <van-cell
      v-for="(item, index) in list"
      clickable
      :key="item"
      :title="`復選框 ${item}`"
      @click="toggle(index)"
    >
      <van-checkbox
        :name="item"
        ref="checkboxes"
        slot="right-icon"
      />
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

export default {
  methods: {
    toggle(index) {
      this.$refs.checkboxes[index].toggle();
    }
  }
}

API

Checkbox Props

CheckboxGroup Props

Checkbox Events

CheckboxGroup Events

Checkbox Slots

CheckboxGroup 方法

通過 ref 可以獲取到 CheckboxGroup 實例并調用實例方法，詳見 組件實例方法

Checkbox 方法

通過 ref 可以獲取到 Checkbox 實例并調用實例方法，詳見 組件實例方法