Picker 选择器

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

使用指南

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

代码演示

基础用法

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

禁用选项

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

  1. <van-picker :columns="columns" />
  1. export default {
  2. data() {
  3. return {
  4. columns: [
  5. { text: '杭州', disabled: true },
  6. { text: '宁波' },
  7. { text: '温州' }
  8. ]
  9. };
  10. }
  11. };

展示顶部栏

  1. <van-picker
  2. show-toolbar
  3. title="标题"
  4. :columns="columns"
  5. @cancel="onCancel"
  6. @confirm="onConfirm"
  7. />
  1. export default {
  2. data() {
  3. return {
  4. columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']
  5. }
  6. },
  7. methods: {
  8. onConfirm(value, index) {
  9. Toast(`当前值:- {value}, 当前索引:- {index}`);
  10. },
  11. onCancel() {
  12. Toast('取消');
  13. }
  14. }
  15. };

多列联动

  1. <van-picker :columns="columns" @change="onChange" />
  1. const citys = {
  2. '浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  3. '福建': ['福州', '厦门', '莆田', '三明', '泉州']
  4. };
  5. export default {
  6. data() {
  7. return {
  8. columns: [
  9. {
  10. values: Object.keys(citys),
  11. className: 'column1'
  12. },
  13. {
  14. values: citys['浙江'],
  15. className: 'column2',
  16. defaultIndex: 2
  17. }
  18. ]
  19. };
  20. },
  21. methods: {
  22. onChange(picker, values) {
  23. picker.setColumnValues(1, citys[values[0]]);
  24. }
  25. }
  26. };

加载状态

当 Picker 数据是通过异步获取时,可以通过 loading 属性显示加载提示

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

API

参数 说明 类型 默认值
columns 对象数组,配置每一列显示的数据 Array []
show-toolbar 是否显示顶部栏 Boolean false
title 顶部栏标题 String ''
loading 是否显示加载状态 Boolean false
value-key 选项对象中,文字对应的 key String text
item-height 选项高度 Number 44
confirm-button-text 确认按钮文字 String 确认
cancel-button-text 取消按钮文字 String 取消
visible-item-count 可见的选项个数 Number 5

Event

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

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

Columns 数据结构

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

key 说明
values 列中对应的备选值
defaultIndex 初始选中项的索引,默认为 0
className 为对应列添加额外的class

方法

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

方法名 参数 返回值 介绍
getValues - values 获取所有列选中的值
setValues values - 设置所有列选中的值
getIndexes - indexes 获取所有列选中值对应的索引
setIndexes indexes - 设置所有列选中值对应的索引
getColumnValue columnIndex value 获取对应列选中的值
setColumnValue columnIndex, value - 设置对应列选中的值
getColumnIndex columnIndex optionIndex 获取对应列选中项的索引
setColumnIndex columnIndex, optionIndex - 设置对应列选中项的索引
getColumnValues columnIndex values 获取对应列中所有选项
setColumnValue columnIndex, values - 设置对应列中所有选项

原文:

https://youzan.github.io/vant/#/zh-CN/picker