TimePicker 时间选择框
输入或选择时间的控件。
何时使用
当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。
代码演示
点击 TimePicker,然后可以在浮层中选择或者输入某一时间。
<template>
<a-time-picker v-model:value="value" />
<a-time-picker v-model:value="strValue" valueFormat="HH:mm:ss" />
</template>
<script lang="ts">
import moment, { Moment } from 'moment';
import { defineComponent, ref, watch } from 'vue';
export default defineComponent({
setup() {
const value = ref<Moment>(moment('08:00:00', 'HH:mm:ss'));
const strValue = ref<string>('09:00:00');
watch(value, () => {
console.log(value.value);
});
watch(strValue, () => {
console.log(strValue.value);
});
return {
value,
strValue,
moment,
};
},
});
</script>
在 TimePicker 选择框底部显示自定义的内容。
<template>
<div>
<a-time-picker v-model:value="value" v-model:open="open" @openChange="handleOpenChange">
<template #addon="{ prefixCls }">
<a-button size="small" type="primary" @click="handleClose">Ok {{ prefixCls }}</a-button>
</template>
</a-time-picker>
<a-time-picker v-model:value="value" v-model:open="open2">
<template #addon>
<a-button size="small" type="primary" @click="handleClose">Ok</a-button>
</template>
</a-time-picker>
</div>
</template>
<script lang="ts">
import { Moment } from 'moment';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const open = ref(false);
const open2 = ref(false);
const value = ref<Moment>();
const handleOpenChange = (openStatus: boolean) => {
console.log('open', openStatus);
open.value = openStatus;
};
const handleClose = () => {
open.value = false;
open2.value = false;
};
return {
value,
open,
open2,
handleOpenChange,
handleClose,
};
},
});
</script>
TimePicker 浮层中的列会随着 format
变化,当略去 format
中的某部分时,浮层中对应的列也会消失。
<template>
<a-time-picker v-model:value="value" format="HH:mm" />
</template>
<script lang="ts">
import moment from 'moment';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const value = ref(moment('12:08', 'HH:mm'));
return {
value,
moment,
};
},
});
</script>
三种大小的输入框,大的用在表单中,中的为默认。
<template>
<div>
<a-time-picker v-model:value="value1" size="large" />
<a-time-picker v-model:value="value2" />
<a-time-picker v-model:value="value3" size="small" />
</div>
</template>
<script lang="ts">
import moment from 'moment';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
return {
value1: ref(moment('12:08:23', 'HH:mm')),
value2: ref(moment('12:08:23', 'HH:mm')),
value3: ref(moment('12:08:23', 'HH:mm')),
};
},
});
</script>
12 小时制的时间选择器,默认的 format 为 h:mm:ss a
。
<template>
<div>
<a-time-picker v-model:value="value" use12-hours />
<a-time-picker v-model:value="value" use12-hours format="h:mm:ss A" />
<a-time-picker v-model:value="value" use12-hours format="h:mm a" />
</div>
</template>
<script lang="ts">
import { Moment } from 'moment';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
return {
value: ref<Moment | undefined>(undefined),
};
},
});
</script>
禁用时间选择。
<template>
<a-time-picker :value="moment('12:08:23', 'HH:mm:ss')" disabled />
</template>
<script lang="ts">
import moment from 'moment';
import { defineComponent } from 'vue';
export default defineComponent({
setup() {
return {
moment,
};
},
});
</script>
可以使用 hourStep
minuteStep
secondStep
按步长展示可选的时分秒。
<template>
<a-time-picker v-model:value="value" :minute-step="15" :second-step="10" />
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const value = ref();
return {
value,
};
},
});
</script>
点击 TimePicker,然后可以在浮层中选择或者输入某一时间。
<template>
<a-time-picker v-model:value="value" :defaultOpenValue="moment('00:00:00', 'HH:mm:ss')">
<template #suffixIcon><smile-outlined /></template>
</a-time-picker>
</template>
<script lang="ts">
import moment, { Moment } from 'moment';
import { SmileOutlined } from '@ant-design/icons-vue';
import { defineComponent, ref } from 'vue';
export default defineComponent({
components: {
SmileOutlined,
},
setup() {
return {
moment,
value: ref<Moment | undefined>(),
};
},
});
</script>
API
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
addon | 选择框底部显示自定义的内容 | slot | slot-scope | 无 | |
allowClear | 是否展示清除按钮 | boolean | true | |
autofocus | 自动获取焦点 | boolean | false | |
clearText | 清除按钮的提示文案 | string | clear | |
defaultOpenValue | 当 defaultValue/value 不存在时,可以设置面板打开时默认选中的值 | moment | moment() | |
defaultValue | 默认时间 | moment | 无 | |
disabled | 禁用全部操作 | boolean | false | |
disabledHours | 禁止选择部分小时选项 | function() | 无 | |
disabledMinutes | 禁止选择部分分钟选项 | function(selectedHour) | 无 | |
disabledSeconds | 禁止选择部分秒选项 | function(selectedHour, selectedMinute) | 无 | |
format | 展示的时间格式 | string | “HH:mm:ss” | |
getPopupContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 | |
hideDisabledOptions | 隐藏禁止选择的选项 | boolean | false | |
hourStep | 小时选项间隔 | number | 1 | |
inputReadOnly | 设置输入框为只读(避免在移动设备上打开虚拟键盘) | boolean | false | |
minuteStep | 分钟选项间隔 | number | 1 | |
open(v-model) | 面板是否打开 | boolean | false | |
placeholder | 没有值的时候显示的内容 | string | “请选择时间” | |
popupClassName | 弹出层类名 | string | ‘’ | |
popupStyle | 弹出层样式对象 | object | - | |
secondStep | 秒选项间隔 | number | 1 | |
suffixIcon | 自定义的选择框后缀图标 | string | VNode | slot | - | |
clearIcon | 自定义的清除图标 | string | VNode | slot | - | 1.5.0 |
use12Hours | 使用 12 小时制,为 true 时 format 默认为 h:mm:ss a | boolean | false | |
value(v-model) | 当前时间 | moment | 无 | |
align | 该值将合并到 placement 的配置中,设置参考 dom-align | Object | 无 | 1.5.4 |
valueFormat | 可选,绑定值的格式,对 value、defaultValue 起作用。不指定则绑定值为 moment 对象 | string,具体格式 | - | 1.5.4 |
事件
事件名称 | 说明 | 回调参数 |
---|---|---|
change | 时间发生变化的回调 | function(time: moment | string, timeString: string): void |
openChange | 面板打开/关闭时的回调 | (open: boolean): void |
方法
名称 | 描述 |
---|---|
blur() | 移除焦点 |
focus() | 获取焦点 |