DatetimePicker 时间选择
介绍
时间选择组件通常与 弹出层 组件配合使用
引入
import { DatetimePicker } from 'vant';
Vue.use(DatetimePicker);
代码演示
选择完整时间
<van-datetime-picker
v-model="currentDate"
type="datetime"
:min-date="minDate"
:max-date="maxDate"
/>
export default {
data() {
return {
minHour: 10,
maxHour: 20,
minDate: new Date(),
maxDate: new Date(2019, 10, 1),
currentDate: new Date()
};
}
};
选择日期(年月日)
<van-datetime-picker
v-model="currentDate"
type="date"
:min-date="minDate"
/>
export default {
data() {
return {
currentDate: new Date()
};
}
}
选择日期(年月)
通过传入formatter
函数,可以对选项文字进行格式化处理
<van-datetime-picker
v-model="currentDate"
type="year-month"
:min-date="minDate"
:formatter="formatter"
/>
export default {
data() {
return {
currentDate: new Date()
};
},
methods: {
formatter(type, value) {
if (type === 'year') {
return `${value}年`;
} else if (type === 'month') {
return `${value}月`
}
return value;
}
}
}
选择时间
<van-datetime-picker
v-model="currentTime"
type="time"
:min-hour="10"
:max-hour="20"
/>
export default {
data() {
return {
currentTime: '12:00'
};
}
}
选项过滤器
通过传入filter
函数,可以对选项数组进行过滤,实现自定义时间间隔
<van-datetime-picker
v-model="currentTime"
type="time"
:filter="filter"
/>
export default {
data() {
return {
currentTime: '12:00'
};
},
methods: {
filter(type, options) {
if (type === 'minute') {
return options.filter(option => option % 5 === 0)
}
return options;
}
}
}
API
Props
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
type | 类型,可选值为 date time year-month | String | datetime | 1.0.2 |
min-date | 可选的最小时间,精确到分钟 | Date | 十年前 | - |
max-date | 可选的最大时间,精确到分钟 | Date | 十年后 | - |
min-hour | 可选的最小小时,针对 time 类型 | Number | 0 | - |
max-hour | 可选的最大小时,针对 time 类型 | Number | 23 | - |
min-minute | 可选的最小分钟,针对 time 类型 | Number | 0 | 1.1.15 |
max-minute | 可选的最大分钟,针对 time 类型 | Number | 59 | 1.1.15 |
filter | 选项过滤函数 | (type, values) => values | - | 2.0.0 |
formatter | 选项格式化函数 | (type, value) => value | - | 1.1.14 |
title | 顶部栏标题 | String | '' | 1.0.4 |
show-toolbar | 是否显示顶部栏 | Boolean | false | 1.0.2 |
loading | 是否显示加载状态 | Boolean | false | 1.0.4 |
item-height | 选项高度 | Number | 44 | 1.0.4 |
confirm-button-text | 确认按钮文字 | String | 确认 | 1.0.4 |
cancel-button-text | 取消按钮文字 | String | 取消 | 1.0.4 |
visible-item-count | 可见的选项个数 | Number | 5 | 1.0.4 |
Events
事件名 | 说明 | 回调参数 |
---|---|---|
change | 当值变化时触发的事件 | picker 实例 |
confirm | 点击完成按钮时触发的事件 | 当前 value |
cancel | 点击取消按钮时触发的事件 | - |
change 事件
在change
事件中,可以获取到picker
实例,对picker
进行相应的更新等操作:
函数 | 说明 |
---|---|
getColumnValue(index) | 获取对应列中选中的值 |
setColumnValue(index, value) | 设置对应列中选中的值 |
getColumnValues(index) | 获取对应列中所有的备选值 |
setColumnValues(index, values) | 设置对应列中所有的备选值 |
getValues() | 获取所有列中被选中的值,返回一个数组 |
setValues(values) | values 为一个数组,设置所有列中被选中的值 |