时间选择组件，根据指定参数创建选择器，支持选择小时及分钟。

说明

该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

子组件

无

接口

TimePicker(options?: TimePickerOptions)

默认以24小时的时间区间创建滑动选择器。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	[TimePickerOptions]	否	配置时间选择组件的参数。

TimePickerOptions对象说明

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	必填	说明
selected	Date	否	设置选中项的时间。默认值：当前系统时间从API version 10开始，该参数支持[$$]双向绑定变量。元服务API： 从API version 11开始，该接口支持在元服务中使用。
format11+	[TimePickerFormat]	否	指定需要显示的TimePicker的格式。默认值：TimePickerFormat.HOUR_MINUTE元服务API： 从API version 12开始，该接口支持在元服务中使用。

TimePickerFormat11+枚举说明

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	说明
HOUR_MINUTE	按照小时和分显示。
HOUR_MINUTE_SECOND	按照小时、分钟和秒显示。

属性

除支持[通用属性]外，还支持以下属性：

useMilitaryTime

useMilitaryTime(value: boolean)

设置展示时间是否为24小时制。当展示时间为12小时制时，上下午与小时无联动关系。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	boolean	是	展示时间是否为24小时制。默认值：false

disappearTextStyle10+

disappearTextStyle(value: PickerTextStyle)

设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[PickerTextStyle]	是	所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。默认值：{color: ‘#ff182431’,font: {size: ‘14fp’,weight: FontWeight.Regular}}

textStyle10+

textStyle(value: PickerTextStyle)

设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[PickerTextStyle]	是	所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。默认值：{color: ‘#ff182431’,font: {size: ‘16fp’,weight: FontWeight.Regular}}

selectedTextStyle10+

selectedTextStyle(value: PickerTextStyle)

设置选中项的文本颜色、字号、字体粗细。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[PickerTextStyle]	是	选中项的文本颜色、字号、字体粗细。默认值：{color: ‘#ff007dff’,font: {size: ‘20vp’,weight: FontWeight.Medium}}

loop11+

loop(value: boolean)

设置是否启用循环模式。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	boolean	是	是否启用循环模式。默认值：true，true表示启用循环模式，false表示不启用循环模式。

dateTimeOptions12+

dateTimeOptions(value: DateTimeOptions)

设置时分秒是否显示前置0。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[DateTimeOptions]	是	设置时分秒是否显示前置0，目前只支持设置hour、minute和second参数。默认值：hour: 24小时制默认为"2-digit"，即有前置0；12小时制默认为"numeric"，即没有前置0。minute: 默认为"2-digit"，即有前置0。second: 默认为"2-digit"，即有前置0。

enableHapticFeedback12+

enableHapticFeedback(enable: boolean)

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数名	类型	必填	说明
enable	boolean	是	是否支持触控反馈。默认值：true，true表示开启触控反馈，false表示不开启触控反馈。设置为true后是否生效，还取决于系统的硬件是否支持。

事件

除支持[通用事件]外，还支持以下事件：

onChange

onChange(callback: (value: TimePickerResult ) => void)

选择时间时触发该事件。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[TimePickerResult]	是	24小时制时间。

TimePickerResult对象说明

返回值为24小时制时间。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	只读	可选	说明
hour	number	否	否	选中时间的时。取值范围：[0-23]
minute	number	否	否	选中时间的分。取值范围：[0-59]
second11+	number	否	否	选中时间的秒。取值范围：[0-59]

示例

该示例实现了时间选择组件，根据指定参数创建选择器。

// xxx.ets
@Entry
@Component
struct TimePickerExample {
  @State isMilitaryTime: boolean = false
  private selectedTime: Date = new Date('2022-07-22T08:00:00')

  build() {
    Column() {
      Button('切换12小时制/24小时制')
        .margin(30)
        .onClick(() => {
          this.isMilitaryTime = !this.isMilitaryTime
        })
      TimePicker({
        selected: this.selectedTime,
      })
        .useMilitaryTime(this.isMilitaryTime)
        .onChange((value: TimePickerResult) => {
          if(value.hour >= 0) {
            this.selectedTime.setHours(value.hour, value.minute)
            console.info('select current date is: ' + JSON.stringify(value))
          }
        })
        .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
        .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
        .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
    }.width('100%')
  }
}