TimeConfig

用于时间相关选择器的配置对象。在 useDateTimePickeruseDateRangeTimePickeruseStandaloneTimePicker 之间共享。

import type { TimeConfig } from "react-date-range-picker-headless";

字段

字段类型默认值描述
precisionTimePrecision"minute"时间显示精度:"hour""minute""second"
hourFormatHourFormat"24"12 小时或 24 小时格式:"12""24"
minuteStepMinuteStep5分钟增量步长。
secondStepSecondStep1秒增量步长。
itemHeightnumber32每个滚轮项的高度(单位:px)。

TypeScript 定义

interface TimeConfig {
precision?: TimePrecision;
hourFormat?: HourFormat;
minuteStep?: MinuteStep;
secondStep?: SecondStep;
itemHeight?: number;
}

相关类型

type TimePrecision = "hour" | "minute" | "second";
type HourFormat = "12" | "24";
type MinuteStep = 1 | 2 | 3 | 5 | 10 | 15 | 20 | 30;
type SecondStep = 1 | 2 | 3 | 5 | 10 | 15 | 20 | 30;

解析后的配置

接受 TimeConfig 的 Hook 会返回一个 resolvedTimeConfig,其中填充了所有默认值:

type Required<TimeConfig>
// { precision: TimePrecision; hourFormat: HourFormat; minuteStep: MinuteStep; secondStep: SecondStep; itemHeight: number }

使用 resolveTimeConfig() 工具函数手动解析默认值:

import { resolveTimeConfig } from "react-date-range-picker-headless";
const resolved = resolveTimeConfig({ precision: "second" });
// { precision: "second", hourFormat: "24", minuteStep: 5, secondStep: 1, itemHeight: 32 }