mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-23 18:00:27 +08:00
d8b6ad7d54
* fix: Tabbar icon line-height * [new feature] progress add showPivot prop * [new feature] TabItem support vue-router * [new feature] update document header style * [Doc] add toast english ducoment * [new feature] add i18n support * feat: Extract demos from markdown * feat: Base components demos * [new feature] complete demo extract & translate * [fix] text cases * fix: add deepAssign test cases * fix: changelog detail * [new feature] AddressEdit support i18n
130 lines
3.1 KiB
Markdown
130 lines
3.1 KiB
Markdown
## Picker 选择器
|
||
|
||
### 使用指南
|
||
``` javascript
|
||
import { Picker } from 'vant';
|
||
|
||
Vue.component(Picker.name, Picker);
|
||
```
|
||
|
||
### 代码演示
|
||
|
||
#### 基础用法
|
||
|
||
```html
|
||
<van-picker :columns="pickerColumns" @change="onChange" />
|
||
```
|
||
|
||
```javascript
|
||
const citys = {
|
||
'浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州', '绍兴', '金华', '衢州'],
|
||
'福建': ['福州', '厦门', '莆田', '三明', '泉州', '漳州', '南平', '龙岩']
|
||
};
|
||
|
||
export default {
|
||
data() {
|
||
return {
|
||
pickerColumns: [
|
||
{
|
||
values: Object.keys(citys),
|
||
className: 'column1'
|
||
},
|
||
{
|
||
values: citys['浙江'],
|
||
className: 'column2'
|
||
}
|
||
]
|
||
};
|
||
},
|
||
|
||
methods: {
|
||
onChange(picker, values) {
|
||
picker.setColumnValues(1, citys[values[0]]);
|
||
}
|
||
}
|
||
};
|
||
```
|
||
|
||
#### 带 toolbar 的 Picker
|
||
|
||
```html
|
||
<van-picker
|
||
showToolbar
|
||
:title="title"
|
||
:columns="pickerColumns"
|
||
@change="onChange"
|
||
@cancel="onCancel"
|
||
@confirm="onConfirm"
|
||
/>
|
||
```
|
||
|
||
```javascript
|
||
const citys = {
|
||
'浙江': ['杭州', '宁波', '温州', '嘉兴', '湖州', '绍兴', '金华', '衢州'],
|
||
'福建': ['福州', '厦门', '莆田', '三明', '泉州', '漳州', '南平', '龙岩']
|
||
};
|
||
|
||
export default {
|
||
data() {
|
||
return {
|
||
title: '地区选择',
|
||
pickerColumns: [
|
||
{
|
||
values: Object.keys(citys),
|
||
className: 'column1'
|
||
},
|
||
{
|
||
values: citys['浙江'],
|
||
className: 'column2'
|
||
}
|
||
]
|
||
};
|
||
},
|
||
|
||
methods: {
|
||
onChange(picker, values) {
|
||
picker.setColumnValues(1, citys[values[0]]);
|
||
},
|
||
onCancel() {
|
||
Toast('picker cancel');
|
||
},
|
||
onConfirm() {
|
||
Toast('picker confirm');
|
||
}
|
||
}
|
||
};
|
||
```
|
||
|
||
### API
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
||
|-----------|-----------|-----------|-------------|-------------|
|
||
| visibileColumnCount | 每一列可见备选元素的个数 | `Number` | `5` | - |
|
||
| itemHeight | 选中元素区高度 | `Number` | `44` | - |
|
||
| columns | 对象数组，配置每一列显示的数据 | `Array` | - | - |
|
||
| showToolbar | 是否在组件顶部显示一个toolbar | `Boolean` | `true` | - |
|
||
| title | 在toolbar上显示的标题文字 | `String` | - | - |
|
||
|
||
### columns
|
||
|
||
`API`中的`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`：
|
||
|
||
| key | 说明 |
|
||
|-----------|-----------|
|
||
| values | 列中对应的备选值 |
|
||
| defaultIndex | 初始选中值的索引，默认为0 |
|
||
| className | 为对应列添加特殊的`class` |
|
||
|
||
### change事件
|
||
|
||
在`change`事件中，可以获取到`picker`实例，对`picker`进行相应的更新等操作：
|
||
|
||
| 函数 | 说明 |
|
||
|-----------|-----------|
|
||
| getColumnValue(index) | 获取对应列中选中的值 |
|
||
| setColumnValue(index, value) | 设置对应列中选中的值 |
|
||
| getColumnValues(index) | 获取对应列中所有的备选值 |
|
||
| setColumnValues(index, values) | 设置对应列中所有的备选值 |
|
||
| getValues() | 获取所有列中被选中的值，返回一个数组 |
|
||
| setValues(values) | `values`为一个数组，设置所有列中被选中的值 |
|