基本
受控组件
三种大小
禁用
选择时分
步长选项
附加内容
12 小时制
范围选择器
无边框
API

TimePicker时间选择框

当用户需要输入一个时间，可以点击标准输入框，弹出时间面板进行选择。

代码演示

点击 TimePicker，然后可以在浮层中选择或者输入某一时间。

import { TimePicker } from 'antd';
import moment from 'moment';

function onChange(time, timeString) {
  console.log(time, timeString);
}

ReactDOM.render(
  <TimePicker
    onChange={onChange}
    defaultOpenValue={moment('00:00:00', 'HH:mm:ss')}
  />,
  mountNode,
);

三种大小

三种大小的输入框，大的用在表单中，中的为默认。

import { TimePicker } from 'antd';
import moment from 'moment';

ReactDOM.render(
  <>
    <TimePicker defaultValue={moment('12:08:23', 'HH:mm:ss')} size="large" />
    <TimePicker defaultValue={moment('12:08:23', 'HH:mm:ss')} />
    <TimePicker defaultValue={moment('12:08:23', 'HH:mm:ss')} size="small" />
  </>,
  mountNode,
);

选择时分

TimePicker 浮层中的列会随着 format 变化，当略去 format 中的某部分时，浮层中对应的列也会消失。

import { TimePicker } from 'antd';
import moment from 'moment';

const format = 'HH:mm';

ReactDOM.render(
  <TimePicker
    defaultValue={moment('12:08', format)}
    format={format}
  />,
  mountNode,
);

附加内容

在 TimePicker 选择框底部显示自定义的内容。

import { TimePicker, Button } from 'antd';

class TimePickerAddonDemo extends React.Component {
  state = { open: false };

  handleOpenChange = open => {
    this.setState({ open });
  };

  handleClose = () => this.setState({ open: false });

  render() {
    return (
      <TimePicker
        open={this.state.open}
        onOpenChange={this.handleOpenChange}
        renderExtraFooter={() => (
          <Button size="small" type="primary" onClick={this.handleClose}>
            Ok
          </Button>
        )}
      />
    );
  }
}

ReactDOM.render(<TimePickerAddonDemo />, mountNode);

范围选择器

通过 RangePicker 使用时间范围选择器。

import { TimePicker } from 'antd';

const { RangePicker } = TimePicker;

ReactDOM.render(<RangePicker />, mountNode);

受控组件

value 和 onChange 需要配合使用。

import React, { useState } from 'react';
import { TimePicker } from 'antd';

const Demo = () => {
  const [value, setValue] = useState(null);

  const onChange = time => {
    setValue(time);
  };

  return <TimePicker value={value} onChange={onChange} />;
}

ReactDOM.render(<Demo />, mountNode);

禁用

禁用时间选择。

import { TimePicker } from 'antd';
import moment from 'moment';

ReactDOM.render(
  <TimePicker
    defaultValue={moment('12:08:23', 'HH:mm:ss')}
    disabled
  />,
  mountNode,
);

步长选项

可以使用 hourStep minuteStep secondStep 按步长展示可选的时分秒。

import { TimePicker } from 'antd';

ReactDOM.render(<TimePicker minuteStep={15} secondStep={10} />, mountNode);

12 小时制

12 小时制的时间选择器，默认的 format 为 h:mm:ss a。

import { TimePicker } from 'antd';

function onChange(time, timeString) {
  console.log(time, timeString);
}

ReactDOM.render(
  <>
    <TimePicker use12Hours onChange={onChange} />
    <TimePicker use12Hours format="h:mm:ss A" onChange={onChange} style={{ width: 140 }} />
    <TimePicker use12Hours format="h:mm a" onChange={onChange} />
  </>,
  mountNode,
);

无边框

无边框样式。

import { TimePicker } from 'antd';

const { RangePicker } = TimePicker;

ReactDOM.render(
  <>
    <TimePicker bordered={false} />
    <RangePicker bordered={false} />
  </>,
  mountNode,
);

API#

import moment from 'moment';
<TimePicker defaultValue={moment('13:30:56', 'HH:mm:ss')} />;

参数	说明	类型	默认值	版本
allowClear	是否展示清除按钮	boolean	true
autoFocus	自动获取焦点	boolean	false
bordered	是否有边框	boolean	true
className	选择器类名	string	-
clearText	清除按钮的提示文案	string	clear
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	面板是否打开	boolean	false
placeholder	没有值的时候显示的内容	string \| [string, string]	`请选择时间`
popupClassName	弹出层类名	string	-
popupStyle	弹出层样式对象	object	-
secondStep	秒选项间隔	number	1
suffixIcon	自定义的选择框后缀图标	ReactNode	-
clearIcon	自定义的清除图标	ReactNode	-
renderExtraFooter	选择框底部显示自定义的内容	() => ReactNode	-
use12Hours	使用 12 小时制，为 true 时 `format` 默认为 `h:mm:ss a`	boolean	false
value	当前时间	moment	-
onChange	时间发生变化的回调	function(time: moment, timeString: string): void	-
onOpenChange	面板打开/关闭时的回调	(open: boolean) => void	-
showNow	面板是否显示“此刻”按钮	boolean	-	4.4.0

方法#

名称	描述	版本
blur()	移除焦点
focus()	获取焦点

RangePicker#

属性与 DatePicker 的 RangePicker 相同。还包含以下属性：

参数	说明	类型	默认值	版本
order	始末时间是否自动排序	boolean	true	4.1.0

FAQ#

如何在 TimePicker 中使用自定义日期库（如 dayjs ）