

<DemoTitle title="TimePicker" desc="输入或选择时间的控件。">
#### API

<AntdApiRef url="https://ant.design/components/time-picker-cn/#api"></AntdApiRef>


## antd API



通用属性参考：[通用属性](/docs/react/common-props)


```jsx
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat'

dayjs.extend(customParseFormat)
<TimePicker defaultValue={dayjs('13:30:56', 'HH:mm:ss')} />;
```


| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| allowClear | 自定义清除按钮 | boolean \| { clearIcon?: ReactNode } | true | 5.8.0: 支持对象类型 | 
| autoFocus | 自动获取焦点 | boolean | false |  | 
| cellRender | 自定义单元格的内容 | (current: number, info: { originNode: React.ReactNode, today: dayjs, range?: 'start' \| 'end', subType: 'hour' \| 'minute' \| 'second' \| 'meridiem' }) => React.ReactNode | - | 5.4.0 | 
| changeOnScroll | 在滚动时改变选择值 | boolean | false | 5.14.0 | 
| className | 选择器类名 | string | - |  | 
| defaultValue | 默认时间 |  | - |  | 
| disabled | 禁用全部操作 | boolean | false |  | 
| 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 |  | 
| needConfirm | 是否需要确认按钮，为  | boolean | - | 5.14.0 | 
| open | 面板是否打开 | boolean | false |  | 
| placeholder | 没有值的时候显示的内容 | string \| [string, string] | 请选择时间 |  | 
| placement | 选择框弹出的位置 | bottomLeft | bottomLeft |  | 
| popupClassName | 弹出层类名 | string | - |  | 
| popupStyle | 弹出层样式对象 | object | - |  | 
| prefix | 自定义前缀 | ReactNode | - | 5.22.0 | 
| renderExtraFooter | 选择框底部显示自定义的内容 | () => ReactNode | - |  | 
| secondStep | 秒选项间隔 | number | 1 |  | 
| showNow | 面板是否显示“此刻”按钮 | boolean | - | 4.4.0 | 
| size | 输入框大小， | large | - |  | 
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | 
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - |  | 
| use12Hours | 使用 12 小时制，为 true 时  | boolean | false |  | 
| value | 当前时间 |  | - |  | 
| variant | 形态变体 | outlined | outlined | 5.13.0 \|  | 
| onCalendarChange | 待选日期发生变化的回调。 | function(dates: [dayjs, dayjs], dateStrings: [string, string], info: { range: | - |  | 
| onChange | 时间发生变化的回调 | function(time: dayjs, timeString: string): void | - |  | 
| onOpenChange | 面板打开/关闭时的回调 | (open: boolean) => void | - |  | 


#### DisabledTime


```typescript
type DisabledTime = (now: Dayjs) => {
  disabledHours?: () => number[];
  disabledMinutes?: (selectedHour: number) => number[];
  disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];
  disabledMilliseconds?: (
    selectedHour: number,
    selectedMinute: number,
    selectedSecond: number,
  ) => number[];
};
```


注意：`disabledMilliseconds` 为 `5.14.0` 新增。

## 方法

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


## RangePicker

属性与 DatePicker 的 [RangePicker](/components/date-picker-cn#rangepicker) 相同。还包含以下属性：

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| disabledTime | 不可选择的时间 |  | - | 4.19.0 | 
| order | 始末时间是否自动排序 | boolean | true | 4.1.0 | 


### RangeDisabledTime


```typescript
type RangeDisabledTime = (
  now: Dayjs,
  type = 'start' | 'end',
) => {
  disabledHours?: () => number[];
  disabledMinutes?: (selectedHour: number) => number[];
  disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];
};
```
