安装

npm i @rtdui/dates

包含的组件

@rtdui/dates包提供的组件:

DatesProvider组件用于为内部的组件提供上下文设置, 支持的设置项:

  • locale 用于日期/时间格式化时的本地化设置, 范围内的日期组件中的格式化字符串会自动应用本地化. 如格式字符串: "MMMM", 会根据不同的locale显示不同的文本. 如果未提供, 默认会使用"en-US"
  • timeZone 用于日期/时间的时区设置, 取值为 IANA 的时区名, 如: "Asia/Shanghai", "America/New_York". 默认使用浏览器的时区
    当你传递给*Input组件一个UTC形式的日期字符串作为值, 显示时会按指定的时区显示日期文本.
  • firstDayOfWeek 用于指定星期的开始日, 取值为0 到 6之间的数字, 0 是指星期日, 6 是指星期六, 依次类推. 默认为: 1 (星期一)
  • weekendDays 用于指定哪几天为周末, 是一个数组, 每个元素取值为0 到 6之间的数字, 0 是指星期日, 6 是指星期六, 依次类推. 默认为: [0,6] (星期日和星期六)
  • labelSeparator 用于范围选择时的日期分隔符. 默认为: "-"
  • consistentWeeks 月份最大的时候会占据6周(6行),最小的时候会占据4周(4行), 该设置将所有月份都以6周显示, 防止高度突变. 默认为: false

以下组件只允许选取, 不允许自由输入:

  • YearPickerInput 组件用于选取年份
  • MonthPickerInput 组件用于选取月份
  • DatePickerInput 组件用于选取日期
  • DateTimePickerInput 组件用于选取日期和时间
  • TimePickerInput 组件用于选取时间

以下组件既支持选取也接受用户输入:

  • DateInput 组件支持选取或自由输入日期
  • TimeInput 组件支持选取或自由输入时间

以下组件用于内联显示的选取器

  • DatePicker 组件内联显示日期选取器
  • MonthPicker 组件内联显示月份选取器
  • YearPicker 组件内联显示年份选取器

功能:

  • 支持Input提供的所有功能.
  • 支持单选,多选和范围选择.
  • 范围选择时支持自定义范围分隔符.
  • 支持清除选择或输入
  • 支持内联日历显示
  • 本地化支持
  • 支持自定义格式化日期/时间
  • 时间支持到分钟级或秒级
  • 支持受控和非受控模式使用
  • 支持限制可选范围
  • 支持自定义星期的起始日(影响日历布局)
  • 支持自定义周末(周末可以有特殊的样式)
  • 支持多月并列显示