Vant4 TimePicker 时间选择

介绍

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

引入

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

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 | string0
max-hour可选的最大小时number | string23
min-minute可选的最小分钟number | string0
max-minute可选的最大分钟number | string59
min-second可选的最小秒数number | string0
max-second可选的最大秒数number | string59
title顶部栏标题string
confirm-button-text确认按钮文字string确认
cancel-button-text取消按钮文字string取消
show-toolbar是否显示顶部栏booleantrue
loading是否显示加载状态booleanfalse
readonly是否为只读状态,只读状态下无法切换选项booleanfalse
filter选项过滤函数(type: string, options: PickerOption[]) => PickerOption[]
formatter选项格式化函数(type: string, option: PickerOption) => PickerOption
option-height选项高度,支持 px vw vh rem 单位,默认 pxnumber | string44
visible-option-num可见的选项个数number | string6
swipe-duration快速滑动时惯性滚动的时长,单位 msnumber | string1000

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;

常见问题

在桌面端无法操作组件?

参见桌面端适配

作者:唐伯虎点蚊香,如若转载,请注明出处:https://www.web176.com/vant4/18915.html

(0)
打赏 支付宝 支付宝 微信 微信
唐伯虎点蚊香的头像唐伯虎点蚊香
上一篇 2023年4月28日
下一篇 2023年4月28日

相关推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注