Vant4 TimePicker 时间选择

2023-02-16 17:55 更新

介绍

时间选择器,通常与弹出层组件配合使用。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

import { createApp } from 'vue';
import { TimePicker } from 'vant';

const app = createApp();
app.use(TimePicker);

代码演示

基础用法

通过 ​v-model​ 绑定当前选中的时间。

<van-time-picker v-model="currentTime" title="选择时间" />
import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref(['12', '00']);
    return { currentTime };
  },
};

选项类型

通过 ​columns-type​ 属性可以控制选项的类型,支持以任意顺序对 ​hour​、​minute​ 和 ​second​ 进行排列组合。

比如:

  • 传入 ​['hour']​ 来单独选择小时。
  • 传入 ​['minute']​ 来单独选择分钟。
  • 传入 ​['minute', 'second']​ 来选择分钟和秒。
  • 传入 ​['hour', 'minute', 'second']​ 来选择小时、分钟和秒。
<van-time-picker
  v-model="currentTime"
  title="选择时间"
  :columns-type="columnsType"
/>
import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref(['12', '00', '00']);
    const columnsType = ['hour', 'minute', 'second'];
    return {
      currentTime,
      columnsType,
    };
  },
};

时间范围

<van-time-picker
  v-model="currentTime"
  title="选择时间"
  :min-hour="10"
  :max-hour="20"
  :min-minute="30"
  :max-minute="40"
/>
import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref(['12', '35']);
    return { currentTime };
  },
};

格式化选项

通过传入 ​formatter​ 函数,可以对选项的文字进行格式化。

<van-time-picker
  v-model="currentTime"
  title="选择时间"
  :formatter="formatter"
/>
import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref(['12', '00']);
    const formatter = (type, option) => {
      if (type === 'hour') {
        option.text += '时';
      }
      if (type === 'minute') {
        option.text += '分';
      }
      return option;
    };

    return {
      filter,
      currentTime,
    };
  },
};

过滤选项

通过传入 ​filter​ 函数,可以对选项数组进行过滤,剔除不需要的时间,实现自定义时间间隔。

<van-time-picker v-model="currentTime" title="选择时间" :filter="filter" />
import { ref } from 'vue';

export default {
  setup() {
    const currentTime = ref(['12', '00']);
    const filter = (type, options) => {
      if (type === 'minute') {
        return options.filter((option) => Number(option) % 10 === 0);
      }
      return options;
    };

    return {
      filter,
      currentTime,
    };
  },
};

API

Props

参数 说明 类型 默认值
v-model 当前选中的时间 string[] -
columns-type 选项类型,由 hourminute 和 second 组成的数组 string[] ['hour', 'minute']
min-hour 可选的最小小时 number | string 0
max-hour 可选的最大小时 number | string 23
min-minute 可选的最小分钟 number | string 0
max-minute 可选的最大分钟 number | string 59
min-second 可选的最小秒数 number | string 0
max-second 可选的最大秒数 number | string 59
title 顶部栏标题 string ''
confirm-button-text 确认按钮文字 string 确认
cancel-button-text 取消按钮文字 string 取消
show-toolbar 是否显示顶部栏 boolean true
loading 是否显示加载状态 boolean false
readonly 是否为只读状态,只读状态下无法切换选项 boolean false
filter 选项过滤函数 (type: string, options: PickerOption[]) => PickerOption[] -
formatter 选项格式化函数 (type: string, option: PickerOption) => PickerOption -
option-height 选项高度,支持 px vw vh rem 单位,默认 px number | string 44
visible-option-num 可见的选项个数 number | string 6
swipe-duration 快速滑动时惯性滚动的时长,单位 ms number | string 1000

Events

事件名 说明 回调参数
confirm 点击完成按钮时触发 { selectedValues, selectedOptions }
cancel 点击取消按钮时触发 { selectedValues, selectedOptions }
change 选项改变时触发 { selectedValues, selectedOptions, columnIndex }

Slots

名称 说明 参数
toolbar 自定义整个顶部栏的内容 -
title 自定义标题内容 -
confirm 自定义确认按钮内容 -
cancel 自定义取消按钮内容 -
option 自定义选项内容 option: PickerOption
columns-top 自定义选项上方内容 -
columns-bottom 自定义选项下方内容 -

类型定义

组件导出以下类型定义:

import type { TimePickerProps, TimePickerColumnType } from 'vant';

常见问题

在桌面端无法操作组件?

参见桌面端适配


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号