• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 时间滑动选择器弹窗 (TimePickerDialog)
2
3以24小时的时间区间创建时间滑动选择器,展示在弹窗上。
4
5>  **说明:**
6>
7> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> 本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见[UIContext](../js-apis-arkui-UIContext.md#uicontext)说明。
10>
11> 从API version 10开始,可以通过使用[UIContext](../js-apis-arkui-UIContext.md#uicontext)中的[showTimePickerDialog](../js-apis-arkui-UIContext.md#showtimepickerdialog)来明确UI的执行上下文。
12
13## TimePickerDialog.show
14
15show(options?: TimePickerDialogOptions)
16
17定义时间滑动选择器弹窗并弹出。
18
19**系统能力:** SystemCapability.ArkUI.ArkUI.Full
20
21**参数:**
22
23| 参数名  | 类型                                                        | 必填 | 说明                       |
24| ------- | ----------------------------------------------------------- | ---- | -------------------------- |
25| options | [TimePickerDialogOptions](#timepickerdialogoptions对象说明) | 否   | 配置时间选择器弹窗的参数。 |
26
27## TimePickerDialogOptions对象说明
28
29继承自[TimePickerOptions](ts-basic-components-timepicker.md#timepickeroptions对象说明)。
30
31
32| 名称 | 类型 | 必填 | 说明 |
33| -------- | -------- | -------- | -------- |
34| useMilitaryTime | boolean | 否 | 展示时间是否为24小时制,默认为12小时制。<br/>默认值:false<br />**说明:** 当展示时间为12小时制时,上下午与小时无联动关系。 |
35| 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/>} |
36| 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/>} |
37| 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/>} |
38| alignment<sup>10+</sup>  | [DialogAlignment](ts-methods-alert-dialog-box.md#dialogalignment枚举说明) | 否   | 弹窗在竖直方向上的对齐方式。<br>默认值:DialogAlignment.Default |
39| offset<sup>10+</sup>     | [Offset](ts-types.md#offset) | 否     | 弹窗相对alignment所在位置的偏移量。<br/>默认值:{&nbsp;dx:&nbsp;0&nbsp;,&nbsp;dy:&nbsp;0&nbsp;} |
40| maskRect<sup>10+</sup>| [Rectangle](ts-methods-alert-dialog-box.md#rectangle8类型说明) | 否     | 弹窗遮蔽层区域,在遮蔽层区域内的事件不透传,在遮蔽层区域外的事件透传。<br/>默认值:{ x: 0, y: 0, width: '100%', height: '100%' } |
41| onAccept | (value: [TimePickerResult](ts-basic-components-timepicker.md#TimePickerResult对象说明)) => void | 否 | 点击弹窗中的“确定”按钮时触发该回调。 |
42| onCancel | () => void | 否 | 点击弹窗中的“取消”按钮时触发该回调。 |
43| onChange | (value: [TimePickerResult](ts-basic-components-timepicker.md#TimePickerResult对象说明)) => void | 否 | 滑动弹窗中的选择器使当前选中时间改变时触发该回调。 |
44| backgroundColor<sup>11+</sup> | [ResourceColor](ts-types.md#resourcecolor)  | 否 | 弹窗背板颜色。<br/>默认值:Color.Transparent。 |
45| backgroundBlurStyle<sup>11+</sup> | [BlurStyle](ts-appendix-enums.md#blurstyle9) | 否 | 弹窗背板模糊材质。<br/>默认值:BlurStyle.COMPONENT_ULTRA_THICK。 |
46
47## 示例
48
49```ts
50// xxx.ets
51@Entry
52@Component
53struct TimePickerDialogExample {
54  private selectTime: Date = new Date('2020-12-25T08:30:00')
55
56  build() {
57    Column() {
58      Button("TimePickerDialog 12小时制")
59        .margin(20)
60        .onClick(() => {
61          TimePickerDialog.show({
62            selected: this.selectTime,
63            disappearTextStyle: { color: Color.Red, font: { size: 15, weight: FontWeight.Lighter } },
64            textStyle: { color: Color.Black, font: { size: 20, weight: FontWeight.Normal } },
65            selectedTextStyle: { color: Color.Blue, font: { size: 30, weight: FontWeight.Bolder } },
66            onAccept: (value: TimePickerResult) => {
67              // 设置selectTime为按下确定按钮时的时间,这样当弹窗再次弹出时显示选中的为上一次确定的时间
68              if (value.hour != undefined && value.minute != undefined) {
69                this.selectTime.setHours(value.hour, value.minute)
70                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
71              }
72            },
73            onCancel: () => {
74              console.info("TimePickerDialog:onCancel()")
75            },
76            onChange: (value: TimePickerResult) => {
77              console.info("TimePickerDialog:onChange()" + JSON.stringify(value))
78            }
79          })
80        })
81      Button("TimePickerDialog 24小时制")
82        .margin(20)
83        .onClick(() => {
84          TimePickerDialog.show({
85            selected: this.selectTime,
86            useMilitaryTime: true,
87            disappearTextStyle: { color: Color.Red, font: { size: 15, weight: FontWeight.Lighter } },
88            textStyle: { color: Color.Black, font: { size: 20, weight: FontWeight.Normal } },
89            selectedTextStyle: { color: Color.Blue, font: { size: 30, weight: FontWeight.Bolder } },
90            onAccept: (value: TimePickerResult) => {
91              if (value.hour != undefined && value.minute != undefined) {
92                this.selectTime.setHours(value.hour, value.minute)
93                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
94              }
95            },
96            onCancel: () => {
97              console.info("TimePickerDialog:onCancel()")
98            },
99            onChange: (value: TimePickerResult) => {
100              console.info("TimePickerDialog:onChange()" + JSON.stringify(value))
101            }
102          })
103        })
104    }.width('100%')
105  }
106}
107```
108
109![TimetPickerDialog](figures/TimePickerDialog.gif)
110