ContextQMD
Back to Ant Design

TimePicker

components/time-picker/index.zh-CN.md

6.3.76.8 KB
Original Source

何时使用 {#when-to-use}

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

代码演示 {#examples}

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">基本</code> <code src="./demo/value.tsx">受控组件</code> <code src="./demo/size.tsx">三种大小</code> <code src="./demo/need-confirm.tsx" version="5.14.0">选择确认</code> <code src="./demo/disabled.tsx">禁用</code> <code src="./demo/hide-column.tsx">选择时分</code> <code src="./demo/interval-options.tsx">步长选项</code> <code src="./demo/addon.tsx">附加内容</code> <code src="./demo/12hours.tsx">12 小时制</code> <code src="./demo/change-on-scroll.tsx" version="5.14.0">滚动即改变</code> <code src="./demo/colored-popup.tsx" debug>色付きポップアップ</code> <code src="./demo/range-picker.tsx">范围选择器</code> <code src="./demo/variant.tsx" version="5.13.0">形态变体</code> <code src="./demo/status.tsx">自定义状态</code> <code src="./demo/suffix.tsx">前后缀</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code> <code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code>

API

通用属性参考：通用属性

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 }true5.8.0: 支持对象类型
addonTimePicker 面板底部的附加内容渲染函数，请使用 renderExtraFooter 替代() => ReactNode--
cellRender自定义单元格的内容(current: number, info: { originNode: React.ReactNode, today: dayjs, range?: 'start' | 'end', subType: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode-5.4.0
changeOnScroll在滚动时改变选择值booleanfalse5.14.0
className选择器类名string-
classNames用于自定义组件内部各语义化结构的 class，支持对象或函数Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-
defaultValue默认时间dayjs-
disabled禁用全部操作booleanfalse
disabledTime不可选择的时间DisabledTime-4.19.0
format展示的时间格式stringHH:mm:ss
getPopupContainer定义浮层的容器，默认为 body 上新建 divfunction(trigger)-
hideDisabledOptions隐藏禁止选择的选项booleanfalse
hourStep小时选项间隔number1
inputReadOnly设置输入框为只读（避免在移动设备上打开虚拟键盘）booleanfalse
minuteStep分钟选项间隔number1
needConfirm是否需要确认按钮，为 false 时失去焦点即代表选择boolean-5.14.0
open面板是否打开booleanfalse
placeholder没有值的时候显示的内容string | [string, string]请选择时间
placement选择框弹出的位置bottomLeft bottomRight topLeft topRightbottomLeft
popupClassName弹出层类名，请使用 classNames.popup 替换string-
popupStyle弹出层样式对象, 请使用 styles.popup 替换object-
prefix自定义前缀ReactNode-5.22.0
previewValue当用户选择时间悬停选项时，输入字段的值会发生临时更改false | hoverhover6.0.0
renderExtraFooter选择框底部显示自定义的内容() => ReactNode-
secondStep秒选项间隔number1
showNow面板是否显示“此刻”按钮boolean-4.4.0
size输入框大小，large 高度为 40px，small 为 24px，默认是 32pxlarge | medium | small-
status设置校验状态'error' | 'warning'-4.19.0
styles用于自定义组件内部各语义化结构的行内 style，支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-
suffixIcon自定义的选择框后缀图标ReactNode-
use12Hours使用 12 小时制，为 true 时 format 默认为 h:mm:ss abooleanfalse
value当前时间dayjs-
variant形态变体outlined | borderless | filled | underlinedoutlined5.13.0 | underlined: 5.24.0
onCalendarChange待选日期发生变化的回调。info 参数自 4.4.0 添加function(dates: [dayjs, dayjs], dateStrings: [string, string], info: { range:start|end })-
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 相同。还包含以下属性：

参数说明类型默认值版本
disabledTime不可选择的时间RangeDisabledTime-4.19.0
order始末时间是否自动排序booleantrue4.1.0

RangeDisabledTime

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

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

主题变量（Design Token）{#design-token}

<ComponentTokenTable component="DatePicker"></ComponentTokenTable>

FAQ