输入或选择时间的控件。
当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。
import React from 'react';
import { TimePicker } from 'antd';
import type { Dayjs } from 'dayjs';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';
dayjs.extend(customParseFormat);
const onChange = (time: Dayjs, timeString: string) => {
console.log(time, timeString);
};
const App: React.FC = () => (
<TimePicker onChange={onChange} defaultOpenValue={dayjs('00:00:00', 'HH:mm:ss')} />
);
export default App;
import React from 'react';
import { Space, TimePicker } from 'antd';
import dayjs from 'dayjs';
const App: React.FC = () => (
<Space wrap>
<TimePicker defaultValue={dayjs('12:08:23', 'HH:mm:ss')} size="large" />
<TimePicker defaultValue={dayjs('12:08:23', 'HH:mm:ss')} />
<TimePicker defaultValue={dayjs('12:08:23', 'HH:mm:ss')} size="small" />
</Space>
);
export default App;
import React from 'react';
import { TimePicker } from 'antd';
import dayjs from 'dayjs';
const format = 'HH:mm';
const App: React.FC = () => <TimePicker defaultValue={dayjs('12:08', format)} format={format} />;
export default App;
import React, { useState } from 'react';
import { Button, TimePicker } from 'antd';
const App: React.FC = () => {
const [open, setOpen] = useState(false);
return (
<TimePicker
open={open}
onOpenChange={setOpen}
renderExtraFooter={() => (
<Button size="small" type="primary" onClick={() => setOpen(false)}>
OK
</Button>
)}
/>
);
};
export default App;
import React from 'react';
import { TimePicker } from 'antd';
const App: React.FC = () => <TimePicker.RangePicker />;
export default App;
import React from 'react';
import { Space, TimePicker } from 'antd';
const App: React.FC = () => (
<Space direction="vertical">
<TimePicker status="error" />
<TimePicker status="warning" />
<TimePicker.RangePicker status="error" />
<TimePicker.RangePicker status="warning" />
</Space>
);
export default App;
import React, { useState } from 'react';
import { TimePicker } from 'antd';
import type { Dayjs } from 'dayjs';
const App: React.FC = () => {
const [value, setValue] = useState<Dayjs | null>(null);
const onChange = (time: Dayjs) => {
setValue(time);
};
return <TimePicker value={value} onChange={onChange} />;
};
export default App;
import React from 'react';
import { TimePicker } from 'antd';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';
dayjs.extend(customParseFormat);
const App: React.FC = () => <TimePicker defaultValue={dayjs('12:08:23', 'HH:mm:ss')} disabled />;
export default App;
import React from 'react';
import { TimePicker } from 'antd';
const App: React.FC = () => <TimePicker minuteStep={15} secondStep={10} hourStep={1} />;
export default App;
import React from 'react';
import { Space, TimePicker } from 'antd';
import type { Dayjs } from 'dayjs';
const onChange = (time: Dayjs, timeString: string) => {
console.log(time, timeString);
};
const App: React.FC = () => (
<Space wrap>
<TimePicker use12Hours onChange={onChange} />
<TimePicker use12Hours format="h:mm:ss A" onChange={onChange} />
<TimePicker use12Hours format="h:mm a" onChange={onChange} />
</Space>
);
export default App;
import React from 'react';
import { TimePicker } from 'antd';
const { RangePicker } = TimePicker;
const App: React.FC = () => (
<>
<TimePicker bordered={false} />
<RangePicker bordered={false} />
</>
);
export default App;
import dayjs from 'dayjs';import customParseFormat from 'dayjs/plugin/customParseFormat'dayjs.extend(customParseFormat)<TimePicker defaultValue={dayjs('13:30:56', 'HH:mm:ss')} />;
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
allowClear | 是否展示清除按钮 | boolean | true | |
autoFocus | 自动获取焦点 | boolean | false | |
bordered | 是否有边框 | boolean | true | |
changeOnBlur | 失去焦点时触发 change 事件,例如 datetime 下不再需要点击确认按钮 | boolean | false | 5.5.0 |
className | 选择器类名 | string | - | |
clearIcon | 自定义的清除图标 | ReactNode | - | |
clearText | 清除按钮的提示文案 | string | clear | |
defaultValue | 默认时间 | dayjs | - | |
disabled | 禁用全部操作 | boolean | false | |
disabledTime | 不可选择的时间 | DisabledTime | - | 4.19.0 |
format | 展示的时间格式 | string | HH:mm:ss | |
getPopupContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | - | |
hideDisabledOptions | 隐藏禁止选择的选项 | boolean | false | |
hourStep | 小时选项间隔 | number | 1 | |
inputReadOnly | 设置输入框为只读(避免在移动设备上打开虚拟键盘) | boolean | false | |
minuteStep | 分钟选项间隔 | number | 1 | |
open | 面板是否打开 | boolean | false | |
placeholder | 没有值的时候显示的内容 | string | [string, string] | 请选择时间 | |
placement | 选择框弹出的位置 | bottomLeft bottomRight topLeft topRight | bottomLeft | |
popupClassName | 弹出层类名 | string | - | |
popupStyle | 弹出层样式对象 | object | - | |
renderExtraFooter | 选择框底部显示自定义的内容 | () => ReactNode | - | |
secondStep | 秒选项间隔 | number | 1 | |
showNow | 面板是否显示“此刻”按钮 | boolean | - | 4.4.0 |
size | 输入框大小,large 高度为 40px,small 为 24px,默认是 32px | large | middle | small | - | |
status | 设置校验状态 | 'error' | 'warning' | - | 4.19.0 |
suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | |
use12Hours | 使用 12 小时制,为 true 时 format 默认为 h:mm:ss a | boolean | false | |
value | 当前时间 | dayjs | - | |
onChange | 时间发生变化的回调 | function(time: dayjs, timeString: string): void | - | |
onOpenChange | 面板打开/关闭时的回调 | (open: boolean) => void | - |
type DisabledTime = (now: Dayjs) => {disabledHours?: () => number[];disabledMinutes?: (selectedHour: number) => number[];disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];};
名称 | 描述 | 版本 |
---|---|---|
blur() | 移除焦点 | |
focus() | 获取焦点 |
属性与 DatePicker 的 RangePicker 相同。还包含以下属性:
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
disabledTime | 不可选择的时间 | RangeDisabledTime | - | 4.19.0 |
order | 始末时间是否自动排序 | boolean | true | 4.1.0 |
type RangeDisabledTime = (now: Dayjs,type = 'start' | 'end',) => {disabledHours?: () => number[];disabledMinutes?: (selectedHour: number) => number[];disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];};