Picker 选择器

介绍

选择器组件通常与 弹出层 组件配合使用

引入

  1. import Vue from 'vue';
  2. import { Picker } from 'vant';
  3. Vue.use(Picker);

代码演示

基础用法

对于单列选择器,传入数值格式的 columns 即可,同时可以监听选项改变的 change 事件

  1. <van-picker :columns="columns" @change="onChange" />
  1. import { Toast } from 'vant';
  2. export default {
  3. data() {
  4. return {
  5. columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']
  6. };
  7. },
  8. methods: {
  9. onChange(picker, value, index) {
  10. Toast(`当前值:${value}, 当前索引:${index}`);
  11. }
  12. }
  13. };

默认选中项

单列选择器可以直接通过default-index属性设置初始选中项的索引值

  1. <van-picker
  2. :columns="columns"
  3. :default-index="2"
  4. @change="onChange"
  5. />

展示顶部栏

通常选择器组件会传入show-toolbar属性以展示顶部操作栏,并可以监听对应的confirmcancel事件

  1. <van-picker
  2. show-toolbar
  3. title="标题"
  4. :columns="columns"
  5. @cancel="onCancel"
  6. @confirm="onConfirm"
  7. />
import { Toast } from 'vant';

export default {
  data() {
    return {
      columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']
    }
  },
  methods: {
    onConfirm(value, index) {
      Toast(`当前值:${value}, 当前索引:${index}`);
    },
    onCancel() {
      Toast('取消');
    }
  }
};

搭配弹出层使用

<van-field
  readonly
  clickable
  label="城市"
  :value="value"
  placeholder="选择城市"
  @click="showPicker = true"
/>

<van-popup v-model="showPicker" position="bottom">
  <van-picker
    show-toolbar
    :columns="columns"
    @cancel="showPicker = false"
    @confirm="onConfirm"
  />
</van-popup>
export default {
  data() {
    return {
      value: '',
      showPicker: false,
      columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']
    }
  },
  methods: {
    onConfirm(value) {
      this.value = value;
      this.showPicker = false;
    }
  }
};

禁用选项

选项可以为对象结构,通过设置 disabled 来禁用该选项

<van-picker :columns="columns" />
export default {
  data() {
    return {
      columns: [
        { text: '杭州', disabled: true },
        { text: '宁波' },
        { text: '温州' }
      ]
    };
  }
};

多列联动

<van-picker :columns="columns" @change="onChange" />
const citys = {
  '浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  '福建': ['福州', '厦门', '莆田', '三明', '泉州']
};

export default {
  data() {
    return {
      columns: [
        {
          values: Object.keys(citys),
          className: 'column1'
        },
        {
          values: citys['浙江'],
          className: 'column2',
          defaultIndex: 2
        }
      ]
    };
  },
  methods: {
    onChange(picker, values) {
      picker.setColumnValues(1, citys[values[0]]);
    }
  }
};

加载状态

若选择器数据是异步获取的,可以通过 loading 属性显示加载提示

<van-picker :columns="columns" loading />

API

Props

参数说明类型默认值
columns对象数组,配置每一列显示的数据Column[][]
show-toolbar是否显示顶部栏booleanfalse
toolbar-position顶部栏位置,可选值为bottomstringtop
title顶部栏标题string''
loading是否显示加载状态booleanfalse
value-key选项对象中,文字对应的 keystringtext
item-height选项高度number44
confirm-button-text确认按钮文字string确认
cancel-button-text取消按钮文字string取消
visible-item-count可见的选项个数number5
allow-html v2.1.8是否允许选项内容中渲染 HTMLbooleantrue
default-index单列选择器的默认选中项索引,多列选择器请参考下方的 Columns 配置number0
swipe-duration v2.2.10快速滑动时惯性滚动的时长,单位msnumber1000

Events

Picker 组件的事件会根据 columns 是单列或多列返回不同的参数

事件名说明回调参数
confirm点击完成按钮时触发单列:选中值,选中值对应的索引多列:所有列选中值,所有列选中值对应的索引
cancel点击取消按钮时触发单列:选中值,选中值对应的索引多列:所有列选中值,所有列选中值对应的索引
change选项改变时触发单列:Picker 实例,选中值,选中值对应的索引多列:Picker 实例,所有列选中值,当前列对应的索引

Slots

名称说明
default自定义顶部栏内容
title自定义标题内容
columns-top自定义选项上方内容
columns-bottom自定义选项下方内容

Column 数据结构

当传入多列数据时,columns为一个对象数组,数组中的每一个对象配置每一列,每一列有以下key

键名说明类型
values列中对应的备选值string[]
defaultIndex初始选中项的索引,默认为 0number
className为对应列添加额外的类名any

方法

通过 ref 可以获取到 Picker 实例并调用实例方法

方法名说明参数返回值
getValues获取所有列选中的值-values
setValues设置所有列选中的值values-
getIndexes获取所有列选中值对应的索引-indexes
setIndexes设置所有列选中值对应的索引indexes-
getColumnValue获取对应列选中的值columnIndexvalue
setColumnValue设置对应列选中的值columnIndex, value-
getColumnIndex获取对应列选中项的索引columnIndexoptionIndex
setColumnIndex设置对应列选中项的索引columnIndex, optionIndex-
getColumnValues获取对应列中所有选项columnIndexvalues
setColumnValues设置对应列中所有选项columnIndex, values-
confirm v2.4.0停止惯性滚动并触发 confirm 事件--

常见问题

在桌面端无法操作组件?

参见在桌面端使用

Picker 选择器 - 图1