Picker 选择器

介绍

提供多个选项集合供用户选择,支持单列选择和多列级联,通常与弹出层组件配合使用

引入

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

代码演示

基础用法

选项配置

Picker 组件通过columns属性配置选项数据,columns是一个包含字符串或对象的数组。

顶部栏

设置show-toolbar属性后会展示顶部操作栏,顶部栏包含标题、确认按钮和取消按钮,点击确认按钮触发confirm事件,点击取消按钮触发cancel事件

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

默认选中项

单列选择时,可以通过default-index属性设置初始选中项的索引

  1. <van-picker show-toolbar title="标题" :columns="columns" :default-index="2" />

多列选择

columns属性可以通过对象数组的形式配置多列选择,对象中可以配置选项数据、初始选中项等,详细格式见下方表格

  1. <van-picker show-toolbar title="标题" :columns="columns" />
  1. export default {
  2. data() {
  3. return {
  4. columns: [
  5. // 第一列
  6. {
  7. values: ['周一', '周二', '周三', '周四', '周五'],
  8. defaultIndex: 2,
  9. },
  10. // 第二列
  11. {
  12. values: ['上午', '下午', '晚上'],
  13. defaultIndex: 1,
  14. },
  15. ],
  16. };
  17. },
  18. };

级联选择

使用columnschildren字段可以实现选项级联的效果(从 2.4.5 版本开始支持)

  1. <van-picker show-toolbar title="标题" :columns="columns" />
  1. export default {
  2. data() {
  3. return {
  4. columns: [
  5. {
  6. text: '浙江',
  7. children: [
  8. {
  9. text: '杭州',
  10. children: [{ text: '西湖区' }, { text: '余杭区' }],
  11. },
  12. {
  13. text: '温州',
  14. children: [{ text: '鹿城区' }, { text: '瓯海区' }],
  15. },
  16. ],
  17. },
  18. {
  19. text: '福建',
  20. children: [
  21. {
  22. text: '福州',
  23. children: [{ text: '鼓楼区' }, { text: '台江区' }],
  24. },
  25. {
  26. text: '厦门',
  27. children: [{ text: '思明区' }, { text: '海沧区' }],
  28. },
  29. ],
  30. },
  31. ],
  32. };
  33. },
  34. };

级联选择的数据嵌套深度需要保持一致,如果部分选项没有子选项,可以使用空字符串进行占位

禁用选项

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

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

动态设置选项

通过 Picker 上的实例方法可以更灵活地控制选择器,比如使用setColumnValues方法实现多列联动

  1. <van-picker show-toolbar :columns="columns" @change="onChange" />
  1. const cities = {
  2. 浙江: ['杭州', '宁波', '温州', '嘉兴', '湖州'],
  3. 福建: ['福州', '厦门', '莆田', '三明', '泉州'],
  4. };
  5. export default {
  6. data() {
  7. return {
  8. columns: [{ values: Object.keys(cities) }, { values: cities['浙江'] }],
  9. };
  10. },
  11. methods: {
  12. onChange(picker, values) {
  13. picker.setColumnValues(1, cities[values[0]]);
  14. },
  15. },
  16. };

加载状态

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

  1. <van-picker show-toolbar :columns="columns" :loading="loading" />
  1. export default {
  2. data() {
  3. return {
  4. columns: [],
  5. loading: true,
  6. };
  7. },
  8. created() {
  9. setTimeout(() => {
  10. this.loading = false;
  11. this.columns = ['选项'];
  12. }, 1000);
  13. },
  14. };

搭配弹出层使用

在实际场景中,Picker 通常作为用于辅助表单填写,可以搭配 Popup 和 Field 实现该效果

  1. <van-field
  2. readonly
  3. clickable
  4. label="城市"
  5. :value="value"
  6. placeholder="选择城市"
  7. @click="showPicker = true"
  8. />
  9. <van-popup v-model="showPicker" round position="bottom">
  10. <van-picker
  11. show-toolbar
  12. :columns="columns"
  13. @cancel="showPicker = false"
  14. @confirm="onConfirm"
  15. />
  16. </van-popup>
  1. export default {
  2. data() {
  3. return {
  4. value: '',
  5. showPicker: false,
  6. columns: ['杭州', '宁波', '温州', '绍兴', '湖州', '嘉兴', '金华', '衢州'],
  7. };
  8. },
  9. methods: {
  10. onConfirm(value) {
  11. this.value = value;
  12. this.showPicker = false;
  13. },
  14. },
  15. };

API

Props

参数说明类型默认值
columns对象数组,配置每一列显示的数据Column[][]
title顶部栏标题string-
confirm-button-text确认按钮文字string确认
cancel-button-text取消按钮文字string取消
value-key选项对象中,选项文字对应的键名stringtext
toolbar-position顶部栏位置,可选值为bottomstringtop
loading是否显示加载状态booleanfalse
readonly v2.10.5是否为只读状态,只读状态下无法切换选项booleanfalse
show-toolbar是否显示顶部栏booleanfalse
allow-html是否允许选项内容中渲染 HTMLbooleantrue
default-index单列选择时,默认选中项的索引number | string0
item-height v2.8.6选项高度,支持 px vw rem 单位,默认 pxnumber | string44
visible-item-count可见的选项个数number | string6
swipe-duration快速滑动时惯性滚动的时长,单位 msnumber | string1000

Events

当选择器有多列时,事件回调参数会返回数组

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

Slots

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

Column 数据结构

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

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

方法

通过 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