• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# TimePicker
2
3时间选择组件,根据指定参数创建选择器,支持选择小时及分钟。
4
5>  **说明:**
6>
7>  该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 子组件
11
1213
14
15## 接口
16
17TimePicker(options?: TimePickerOptions)
18
19默认以24小时的时间区间创建滑动选择器。
20
21**系统能力:** SystemCapability.ArkUI.ArkUI.Full
22
23**参数:**
24
25| 参数名  | 类型                                            | 必填 | 描述                     |
26| ------- | ----------------------------------------------- | ---- | ------------------------ |
27| options | [TimePickerOptions](#timepickeroptions对象说明) | 否   | 配置时间选择组件的参数。 |
28
29## TimePickerOptions对象说明
30
31| 名称                 | 类型                                          | 必填 | 说明                                                         |
32| -------------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
33| selected             | Date                                          | 否   | 设置选中项的时间。<br/>默认值:当前系统时间<br />从API version 10开始,该参数支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 |
34## 属性
35
36除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:
37
38| 名称                             | 参数类型                                                     | 描述                                                         |
39| -------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
40| useMilitaryTime                  | boolean                                                      | 展示时间是否为24小时制。<br/>默认值:false<br />**说明:**当展示时间为12小时制时,上下午与小时无联动关系。 |
41| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff182431',<br/>font: {<br/>size: '14fp', <br/>weight: FontWeight.Regular<br/>}<br/>} |
42| textStyle<sup>10+</sup>          | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff182431',<br/>font: {<br/>size: '16fp', <br/>weight: FontWeight.Regular<br/>}<br/>} |
43| selectedTextStyle<sup>10+</sup>  | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置选中项的文本颜色、字号、字体粗细。<br/>默认值:<br/>{<br/>color: '#ff007dff',<br/>font: {<br/>size: '20vp', <br/>weight: FontWeight.Medium<br/>}<br/>} |
44
45## 事件
46
47除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件:
48
49| 名称                                       | 功能描述        |
50| ---------------------------------------- | ----------- |
51| onChange(callback:&nbsp;(value:&nbsp;TimePickerResult )&nbsp;=&gt;&nbsp;void) | 选择时间时触发该事件。 |
52
53## TimePickerResult对象说明
54
55返回值为24小时制时间。
56
57| 名称                 | 参数类型 | 描述                                |
58| -------------------- | -------- | ----------------------------------- |
59| hour                 | number   | 选中时间的时。<br/>取值范围:[0-23] |
60| minute               | number   | 选中时间的分。<br/>取值范围:[0-59] |
61
62
63## 示例
64
65```ts
66// xxx.ets
67@Entry
68@Component
69struct TimePickerExample {
70  @State isMilitaryTime: boolean = false
71  private selectedTime: Date = new Date('2022-07-22T08:00:00')
72
73  build() {
74    Column() {
75      Button('切换12小时制/24小时制')
76        .margin(30)
77        .onClick(() => {
78          this.isMilitaryTime = !this.isMilitaryTime
79        })
80      TimePicker({
81        selected: this.selectedTime,
82      })
83        .useMilitaryTime(this.isMilitaryTime)
84        .onChange((value: TimePickerResult) => {
85          if(value.hour) {
86            this.selectedTime.setHours(value.hour, value.minute)
87            console.info('select current date is: ' + JSON.stringify(value))
88          }
89        })
90        .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
91        .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
92        .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
93    }.width('100%')
94  }
95}
96```
97
98![timePicker](figures/timePicker.gif)