时间选择框
输入或选择时间的控件。
何时使用
当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。
代码演示
-
基本 ·
basic -
受控组件 ·
value -
三种大小 ·
size -
选择确认 ·
need-confirm -
禁用 ·
disabled -
选择时分 ·
hide-column -
步长选项 ·
interval-options -
附加内容 ·
addon -
12 小时制 ·
12hours -
滚动即改变 ·
change-on-scroll -
范围选择器 ·
range-picker -
形态变体 ·
variant -
自定义状态 ·
status -
前后缀 ·
suffix -
自定义语义结构的样式和类 ·
style-class
API
通用属性参考:通用属性
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: 支持对象类型 | 6.4.0 |
TimePicker 面板底部的附加内容渲染函数,请使用 renderExtraFooter 替代 | () => ReactNode | - | - | × | |
| cellRender | 自定义单元格的内容 | (current: number, info: { originNode: React.ReactElement, today: dayjs, range?: 'start' | 'end', subType: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode | - | 5.4.0 | × |
| changeOnScroll | 在滚动时改变选择值 | boolean | false | 5.14.0 | × |
| classNames | 用于自定义组件内部各语义化结构的 class,支持对象或函数 | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 5.25.0 | |
| 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 | × | |
| needConfirm | 是否需要确认按钮,为 false 时失去焦点即代表选择 | boolean | - | 5.14.0 | × |
| open | 面板是否打开 | boolean | false | × | |
| placeholder | 没有值的时候显示的内容 | string | [string, string] | 请选择时间 | × | |
| placement | 选择框弹出的位置 | bottomLeft bottomRight topLeft topRight | bottomLeft | × | |
弹出层类名,请使用 classNames.popup 替换 | string | - | × | ||
弹出层样式对象, 请使用 styles.popup 替换 | CSSProperties | - | × | ||
| prefix | 自定义前缀 | ReactNode | - | 5.22.0 | × |
| previewValue | 当用户选择时间悬停选项时,输入字段的值会发生临时更改 | false | hover | hover | 6.0.0 | × |
| renderExtraFooter | 选择框底部显示自定义的内容 | () => ReactNode | - | × | |
| secondStep | 秒选项间隔 | number | 1 | × | |
| showNow | 面板是否显示“此刻”按钮 | boolean | - | 4.4.0 | × |
| size | 输入框大小,large 高度为 40px,small 为 24px,默认是 32px | large | medium | small | - | × | |
| status | 设置校验状态 | 'error' | 'warning' | 'success' | 'validating' | - | 4.19.0 | × |
| styles | 用于自定义组件内部各语义化结构的行内 style,支持对象或函数 | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 5.25.0 | |
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | 6.3.0 | |
| use12Hours | 使用 12 小时制,为 true 时 format 默认为 h:mm:ss a | boolean | false | × | |
| value | 当前时间 | dayjs | - | × | |
| variant | 形态变体 | outlined | borderless | filled | underlined | outlined | 5.13.0 | underlined: 5.24.0 | 5.19.0 |
| onCalendarChange | 待选日期发生变化的回调。info 参数自 4.4.0 添加 | function(dates: [dayjs, dayjs], dateStrings: [string, string], info: { range:start|end }) | - | × | |
| onChange | 时间发生变化的回调 | function(time: dayjs, timeString: string): void | - | × | |
| onClear | 点击清除按钮时的回调 | () => void | - | 6.5.0 | × |
| onOpenChange | 面板打开/关闭时的回调 | (open: boolean) => void | - | × |
DisabledTime
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 相同。还包含以下属性:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| disabledTime | 不可选择的时间 | RangeDisabledTime | - | 4.19.0 |
| order | 始末时间是否自动排序 | boolean | true | 4.1.0 |
RangeDisabledTime
type RangeDisabledTime = (
now: Dayjs,
type = 'start' | 'end',
) => {
disabledHours?: () => number[];
disabledMinutes?: (selectedHour: number) => number[];
disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];
};
Semantic DOM
| 语义节点 | 原生说明 | 版本 |
|---|---|---|
root | 根元素,包含相对定位、行内flex布局、内边距、边框圆角、过渡动画等日期选择器容器的基础样式 | — |
prefix | 前缀元素,包含flex布局、右外边距等前缀内容的布局样式 | — |
input | 输入框元素,包含相对定位、宽度、颜色、字体、行高、过渡动画等输入框的核心交互样式 | — |
suffix | 后缀元素,包含flex布局、颜色、行高、指针事件、过渡动画等后缀内容的样式 | — |
popup.root | 弹出框元素 | — |
popup.container | 容器元素,设置背景色、内边距、圆角、阴影、边框和内容展示样式 | — |
popup.content | 弹出框内容元素,包含日期表格的宽度、边框、单元格等内容展示样式 | — |
popup.item | 弹出框单项元素,包含日期单元格的尺寸、背景色、边框圆角、悬停态、选中态等交互样式 | — |
popup.footer | 弹出框底部元素,包含确认取消按钮、快捷选择等底部操作区域的布局样式 | — |
语义说明来源: vendor/components/date-picker/demo/_semantic.tsx
主题变量(Design Token)
类型、继承关系和原生令牌声明保持固定源码原文;默认值由原生主题计算,并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。
| 令牌 | 类型 | 原生说明 |
|---|---|---|
presetsWidth | number | 预设区域宽度 |
presetsMaxWidth | number | 预设区域最大宽度 |
zIndexPopup | number | 弹窗 z-index |
声明来源: vendor/components/date-picker/style/token.ts
import { FastColor } from '@ant-design/fast-color';
import type { SharedComponentToken, SharedInputToken } from '../../input/style/token';
import { initComponentToken } from '../../input/style/token';
import type { MultipleSelectorToken, SelectorToken } from '../../select/style/token';
import type { ArrowToken } from '../../style/roundedArrow';
import { getArrowToken } from '../../style/roundedArrow';
import type {
FullToken,
GetDefaultToken,
GlobalToken,
TokenWithCommonCls,
} from '../../theme/internal';
export interface PanelComponentToken extends MultipleSelectorToken {
/**
* @desc 单元格悬浮态背景色
* @descEN Background color of cell hover state
*/
cellHoverBg: string;
/**
* @desc 选取范围内的单元格背景色
* @descEN Background color of cell in range
*/
cellActiveWithRangeBg: string;
/**
* @desc 选取范围内的单元格悬浮态背景色
* @descEN Background color of hovered cell in range
*/
cellHoverWithRangeBg: string;
/**
* @desc 单元格禁用态背景色
* @descEN Background color of disabled cell
*/
cellBgDisabled: string;
/**
* @desc 选取范围时单元格边框色
* @descEN Border color of cell in range when picking
*/
cellRangeBorderColor: string;
/**
* @desc 时间列宽度
* @descEN Width of time column
*/
timeColumnWidth: number;
/**
* @desc 时间列高度
* @descEN Height of time column
*/
timeColumnHeight: number;
/**
* @desc 时间单元格高度
* @descEN Height of time cell
*/
timeCellHeight: number;
/**
* @desc 单元格高度
* @descEN Height of cell
*/
cellHeight: number;
/**
* @desc 单元格宽度
* @descEN Width of cell
*/
cellWidth: number;
/**
* @desc 单元格文本高度
* @descEN Height of cell text
*/
textHeight: number;
/**
* @desc 十年/年/季/月/周单元格高度
* @descEN Height of decade/year/quarter/month/week cell
*/
withoutTimeCellHeight: number;
}
export interface ComponentToken
extends Exclude<SharedComponentToken, 'addonBg'>,
PanelComponentToken,
ArrowToken {
/**
* @desc 预设区域宽度
* @descEN Width of preset area
*/
presetsWidth: number;
/**
* @desc 预设区域最大宽度
* @descEN Max width of preset area
*/
presetsMaxWidth: number;
/**
* @desc 弹窗 z-index
* @descEN z-index of popup
*/
zIndexPopup: number;
}
export type PickerPanelToken = {
pickerCellCls: string;
pickerCellInnerCls: string;
pickerDatePanelPaddingHorizontal: number | string;
pickerYearMonthCellWidth: number | string;
pickerCellPaddingVertical: number | string;
pickerQuarterPanelContentHeight: number | string;
pickerCellBorderGap: number;
pickerControlIconSize: number;
pickerControlIconMargin: number;
pickerControlIconBorderWidth: number;
};
export interface PickerToken
extends FullToken<'DatePicker'>,
PickerPanelToken,
SharedInputToken,
SelectorToken {
/** @private Used for internal calculation */
INTERNAL_FIXED_ITEM_MARGIN: number;
}
export type SharedPickerToken = TokenWithCommonCls<GlobalToken> &
PickerPanelToken &
PanelComponentToken;
FAQ
原生通用属性
Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| style | 自定义样式 | CSSProperties | - |
| className | 自定义类名 | string | - |
| rootClassName | 添加在组件最外层的 className | string | - |
| autoFocus | 自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效 | boolean | false |
安装并复现示例
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23
使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。
原生类型参考
源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。
vendor/components/time-picker/index.tsx
来源与许可
https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd
保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。