picker多选 vant_Vant Picker 选择器

介绍

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

引入import Vue from 'vue';

import { Picker } from 'vant';

Vue.use(Picker);

代码演示

基础用法

Picker 组件通过columns属性配置选项数据，columns是一个包含字符串或对象的数组import { Toast } from 'vant';

export default {

data() {

return {

columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']

};

},

methods: {

onChange(picker, value, index) {

Toast(`当前值：${value}, 当前索引：${index}`);

}

}

};

默认选中项

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

展示顶部栏

设置show-toolbar属性后会展示顶部操作栏，点击确认按钮触发confirm事件，点击取消按钮触发cancel事件

show-toolbar

title="标题"

:columns="columns"

@cancel="onCancel"

@confirm="onConfirm"

/>import { Toast } from 'vant';

export default {

data() {

return {

columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']

}

},

methods: {

onConfirm(value, index) {

Toast(`当前值：${value}, 当前索引：${index}`);

},

onCancel() {

Toast('取消');

}

}

};

多列选择

通过columns属性可以配置多列选择export default {

data() {

return {

columns: [

// 第一列

{

values: ['周一', '周二', '周三', '周四', '周五'],

defaultIndex: 2

},

// 第二列

{

values: ['上午', '下午', '晚上'],

defaultIndex: 1

}

]

};

}

};

级联选择

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

data() {

return {

columns: [{

text: '浙江',

children: [{

text: '杭州',

children: [{ text: '西湖区' }, { text: '余杭区' }]

}, {

text: '温州',

children: [{ text: '鹿城区' }, { text: '瓯海区' }]

}]

}, {

text: '福建',

children: [{

text: '福州',

children: [{ text: '鼓楼区' }, { text: '台江区' }]

}, {

text: '厦门',

children: [{ text: '思明区' }, { text: '海沧区' }]

}]

}]

};

}

};

禁用选项

选项可以为对象结构，通过设置 disabled 来禁用该选项export default {

data() {

return {

columns: [

{ text: '杭州', disabled: true },

{ text: '宁波' },

{ text: '温州' }

]

};

}

};

动态设置选项

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

'浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州'],

'福建': ['福州', '厦门', '莆田', '三明', '泉州']

};

export default {

data() {

return {

columns: [

{ values: Object.keys(citys) },

{ values: citys['浙江'] }

]

};

},

methods: {

onChange(picker, values) {

picker.setColumnValues(1, citys[values[0]]);

}

}

};

加载状态

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

data() {

return {

columns: [],

loading: true

};

},

created() {

setTimeout(() => {

this.loading = false;

this.columns = ['选项'];

}, 1000);

}

};

搭配弹出层使用

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

readonly

clickable

label="城市"

:value="value"

placeholder="选择城市"

@click="showPicker = true"

/>

show-toolbar

:columns="columns"

@cancel="showPicker = false"

@confirm="onConfirm"

/>

export default {

data() {

return {

value: '',

showPicker: false,

columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']

}

},

methods: {

onConfirm(value) {

this.value = value;

this.showPicker = false;

}

}

};

API

Props参数说明类型默认值columns对象数组，配置每一列显示的数据Column[][]

title顶部栏标题string-

confirm-button-text确认按钮文字string确认

cancel-button-text取消按钮文字string取消

value-key选项对象中，选项文字对应的键名stringtext

toolbar-position顶部栏位置，可选值为bottomstringtop

loading是否显示加载状态booleanfalse

show-toolbar是否显示顶部栏booleanfalse

allow-html v2.1.8是否允许选项内容中渲染 HTMLbooleantrue

default-index单列选择时，默认选中项的索引number | string0

item-height选项高度number | string44

visible-item-count可见的选项个数number | string5

swipe-duration v2.2.10快速滑动时惯性滚动的时长，单位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 事件--

常见问题

在桌面端无法操作组件？