Cascader 级联选择

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

基础用法

级联选择组件可以搭配 Field 和 Popup 组件使用,示例如下:

  1. v-model="fieldValue"
  2. is-link
  3. readonly
  4. label="地区"
  5. placeholder="请选择所在地区"
  6. @click="show = true"
  7. />
  8. <van-popup v-model:show="show" round position="bottom">
  9. <van-cascader
  10. v-model="cascaderValue"
  11. title="请选择所在地区"
  12. :options="options"
  13. @close="show = false"
  14. @finish="onFinish"
  15. />
  16. </van-popup>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const fieldValue = ref('');
  6. const cascaderValue = ref('');
  7. // 选项列表,children 代表子选项,支持多级嵌套
  8. const options = [
  9. {
  10. text: '浙江省',
  11. value: '330000',
  12. children: [{ text: '杭州市', value: '330100' }],
  13. },
  14. {
  15. text: '江苏省',
  16. value: '320000',
  17. children: [{ text: '南京市', value: '320100' }],
  18. ];
  19. // 全部选项选择完毕后,会触发 finish 事件
  20. const onFinish = ({ selectedOptions }) => {
  21. show.value = false;
  22. fieldValue.value = selectedOptions.map((option) => option.text).join('/');
  23. };
  24. return {
  25. show,
  26. options,
  27. onFinish,
  28. fieldValue,
  29. cascaderValue,
  30. };
  31. },
  32. };

自定义颜色

可以监听 change 事件并动态设置 ,实现异步加载选项。

  1. <van-field
  2. v-model="fieldValue"
  3. is-link
  4. readonly
  5. label="地区"
  6. placeholder="请选择所在地区"
  7. @click="show = true"
  8. />
  9. <van-popup v-model:show="show" round position="bottom">
  10. <van-cascader
  11. v-model="cascaderValue"
  12. title="请选择所在地区"
  13. :options="options"
  14. @close="show = false"
  15. @change="onChange"
  16. @finish="onFinish"
  17. />
  18. </van-popup>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const fieldValue = ref('');
  6. const cascaderValue = ref('');
  7. const options = ref([
  8. {
  9. text: '浙江省',
  10. value: '330000',
  11. children: [],
  12. },
  13. ]);
  14. const onChange = ({ value }) => {
  15. if (value === options.value[0].value) {
  16. options.value[0].children = [
  17. { text: '杭州市', value: '330100' },
  18. { text: '宁波市', value: '330200' },
  19. ];
  20. }, 500);
  21. }
  22. };
  23. const onFinish = ({ selectedOptions }) => {
  24. show.value = false;
  25. fieldValue.value = selectedOptions.map((option) => option.text).join('/');
  26. };
  27. return {
  28. show,
  29. options,
  30. onFinish,
  31. fieldValue,
  32. cascaderValue,
  33. },
  34. };

自定义字段名

通过 field-names 属性可以自定义 options 里的字段名称。

  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const code = ref('');
  5. const fieldNames = {
  6. text: 'name',
  7. value: 'code',
  8. children: 'items',
  9. };
  10. const options = [
  11. {
  12. name: '浙江省',
  13. code: '330000',
  14. items: [{ name: '杭州市', code: '330100' }],
  15. },
  16. {
  17. name: '江苏省',
  18. code: '320000',
  19. items: [{ name: '南京市', code: '320100' }],
  20. },
  21. ];
  22. return {
  23. code,
  24. options,
  25. fieldNames,
  26. };
  27. },

Props

Option 数据结构

Slots

类型定义

组件导出以下类型定义:

  1. import type { CascaderOption, CascaderFieldNames } from 'vant';

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 。