• 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?: {selected?: Date})
18
19默认以24小时的时间区间创建滑动选择器。
20
21**参数:**
22
23| 参数名   | 参数类型 | 必填 | 参数描述                                                     |
24| -------- | -------- | ---- | ------------------------------------------------------------ |
25| selected | Date     | 否   | 设置选中项的时间。<br/>默认值:当前系统时间<br />从API version 10开始,该参数支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 |
26
27## 属性
28
29除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:
30
31| 名称                             | 参数类型                                                     | 描述                                                         |
32| -------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
33| useMilitaryTime                  | boolean                                                      | 展示时间是否为24小时制。<br/>默认值:false<br />**说明:**当展示时间为12小时制时,上下午与小时无联动关系。 |
34| 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/>} |
35| 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/>} |
36| 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/>} |
37
38## 事件
39
40除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件:
41
42| 名称                                       | 功能描述        |
43| ---------------------------------------- | ----------- |
44| onChange(callback:&nbsp;(value:&nbsp;TimePickerResult )&nbsp;=&gt;&nbsp;void) | 选择时间时触发该事件。 |
45
46## TimePickerResult对象说明
47
48返回值为24小时制时间。
49
50| 名称   | 参数类型 | 描述                                |
51| ------ | -------- | ----------------------------------- |
52| hour   | number   | 选中时间的时。<br/>取值范围:[0-23] |
53| minute | number   | 选中时间的分。<br/>取值范围:[0-59] |
54
55
56## 示例
57
58```ts
59// xxx.ets
60@Entry
61@Component
62struct TimePickerExample {
63  @State isMilitaryTime: boolean = false
64  private selectedTime: Date = new Date('2022-07-22T08:00:00')
65
66  build() {
67    Column() {
68      Button('切换12小时制/24小时制')
69        .margin({ top: 30 })
70        .onClick(() => {
71          this.isMilitaryTime = !this.isMilitaryTime
72        })
73      TimePicker({
74        selected: this.selectedTime,
75      })
76        .useMilitaryTime(this.isMilitaryTime)
77        .onChange((value: TimePickerResult) => {
78          if(value.hour) {
79            this.selectedTime.setHours(value.hour, value.minute)
80            console.info('select current date is: ' + JSON.stringify(value))
81          }
82        })
83        .disappearTextStyle({color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}})
84        .textStyle({color: Color.Black, font: {size: 20, weight: FontWeight.Normal}})
85        .selectedTextStyle({color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}})
86    }.width('100%')
87  }
88}
89```
90
91![timePicker](figures/timePicker.gif)