TimePicker时间选择框

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

代码演示

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

expand codeexpand code
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,
);

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

expand codeexpand code
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 中的某部分时,浮层中对应的列也会消失。

expand codeexpand code
import { TimePicker } from 'antd';
import moment from 'moment';

const format = 'HH:mm';

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

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

expand codeexpand code
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 使用时间范围选择器。

expand codeexpand code
import { TimePicker } from 'antd';

const { RangePicker } = TimePicker;

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

value 和 onChange 需要配合使用。

expand codeexpand code
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);

禁用时间选择。

expand codeexpand code
import { TimePicker } from 'antd';
import moment from 'moment';

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

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

expand codeexpand code
import { TimePicker } from 'antd';

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

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

expand codeexpand code
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,
);

无边框样式。

expand codeexpand code
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是否展示清除按钮booleantrue
autoFocus自动获取焦点booleanfalse
bordered是否有边框booleantrue
className选择器类名string-
clearText清除按钮的提示文案stringclear
defaultValue默认时间moment-
disabled禁用全部操作booleanfalse
disabledHours禁止选择部分小时选项function()-
disabledMinutes禁止选择部分分钟选项function(selectedHour)-
disabledSeconds禁止选择部分秒选项function(selectedHour, selectedMinute)-
format展示的时间格式stringHH:mm:ss
getPopupContainer定义浮层的容器,默认为 body 上新建 divfunction(trigger)-
hideDisabledOptions隐藏禁止选择的选项booleanfalse
hourStep小时选项间隔number1
inputReadOnly设置输入框为只读(避免在移动设备上打开虚拟键盘)booleanfalse
minuteStep分钟选项间隔number1
open面板是否打开booleanfalse
placeholder没有值的时候显示的内容string | [string, string]请选择时间
popupClassName弹出层类名string-
popupStyle弹出层样式对象object-
secondStep秒选项间隔number1
suffixIcon自定义的选择框后缀图标ReactNode-
clearIcon自定义的清除图标ReactNode-
renderExtraFooter选择框底部显示自定义的内容() => ReactNode-
use12Hours使用 12 小时制,为 true 时 format 默认为 h:mm:ss abooleanfalse
value当前时间moment-
onChange时间发生变化的回调function(time: moment, timeString: string): void-
onOpenChange面板打开/关闭时的回调(open: boolean) => void-
showNow面板是否显示“此刻”按钮boolean-4.4.0

方法#

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

RangePicker#

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

参数说明类型默认值版本
order始末时间是否自动排序booleantrue4.1.0

FAQ#

Transfer穿梭框Upload上传