Star767
5020
代码
代码
Issues1646
Pull Requests1749
流水线
讨论
Wiki
分析
Star767
5020
GGiteeupdate zh-cn/application-dev/reference/apis-arkui/arkui-ts/ts-methods-timepicker-dialog.md.
146decc8创建于 2025年1月20日历史提交

时间滑动选择器弹窗 (TimePickerDialog)

以24小时的时间区间创建时间滑动选择器，展示在弹窗上。

说明：

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

本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见UIContext说明。

从API version 10开始，可以通过使用UIContext中的showTimePickerDialog来明确UI的执行上下文。

TimePickerDialog

show

static show(options?: TimePickerDialogOptions)

定义时间滑动选择器弹窗并弹出。

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

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

参数：

参数名 类型 必填 说明
options TimePickerDialogOptions 否 配置时间选择器弹窗的参数。

TimePickerDialogOptions对象说明

继承自TimePickerOptions。

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

名称 类型 必填 说明
useMilitaryTime boolean 否 展示时间是否为24小时制，默认为12小时制。
默认值：false
说明： 当展示时间为12小时制时，上下午与小时无联动关系。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
disappearTextStyle10+ PickerTextStyle 否 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。
默认值：
{
color: '#ff182431',
font: {
size: '14fp',
weight: FontWeight.Regular
}
}
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
textStyle10+ PickerTextStyle 否 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。
默认值：
{
color: '#ff182431',
font: {
size: '16fp',
weight: FontWeight.Regular
}
}
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
selectedTextStyle10+ PickerTextStyle 否 设置选中项的文本颜色、字号、字体粗细。
默认值：
{
color: '#ff007dff',
font: {
size: '20vp',
weight: FontWeight.Medium
}
}
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
acceptButtonStyle12+ PickerDialogButtonStyle 否 设置确认按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。
说明：
acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true，二者primary字段均配置为true时均不生效。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
cancelButtonStyle12+ PickerDialogButtonStyle 否 设置取消按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。
说明：
acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true，二者primary字段均配置为true时均不生效。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
alignment10+ DialogAlignment 否 弹窗在竖直方向上的对齐方式。
默认值：DialogAlignment.Default
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
offset10+ Offset 否 弹窗相对alignment所在位置的偏移量。
默认值：{ dx: 0 , dy: 0 }
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
maskRect10+ Rectangle 否 弹窗遮蔽层区域，在遮蔽层区域内的事件不透传，在遮蔽层区域外的事件透传。
默认值：{ x: 0, y: 0, width: '100%', height: '100%' }
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
onAccept (value: TimePickerResult) => void 否 点击弹窗中的“确定”按钮时触发该回调。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
onCancel () => void 否 点击弹窗中的“取消”按钮时触发该回调。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
onChange (value: TimePickerResult) => void 否 滑动弹窗中的选择器使当前选中时间改变时触发该回调。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
backgroundColor11+ ResourceColor 否 弹窗背板颜色。
默认值：Color.Transparent
说明：
当设置了backgroundColor为非透明色时，backgroundBlurStyle需要设置为BlurStyle.NONE，否则颜色显示将不符合预期效果。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
backgroundBlurStyle11+ BlurStyle 否 弹窗背板模糊材质。
默认值：BlurStyle.COMPONENT_ULTRA_THICK
说明：
设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则颜色显示将不符合预期效果。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
onDidAppear12+ () => void 否 弹窗弹出时的事件回调。
说明：
1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.在onDidAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。
3.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。
4. 当弹窗入场动效未完成时关闭弹窗，该回调不会触发。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
onDidDisappear12+ () => void 否 弹窗消失时的事件回调。
说明：
1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
onWillAppear12+ () => void 否 弹窗显示动效前的事件回调。
说明：
1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.在onWillAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
onWillDisappear12+ () => void 否 弹窗退出动效前的事件回调。
说明：
1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
shadow12+ ShadowOptions | ShadowStyle 否 设置弹窗背板的阴影。
当设备为2in1时，默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD，失焦为ShadowStyle.OUTER_FLOATING_SM。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
dateTimeOptions12+ DateTimeOptions 否 设置时分是否显示前置0，目前只支持设置hour和minute参数。
默认值：
hour: 24小时制默认为"2-digit"，即有前置0；12小时制默认为"numeric"，即没有前置0。
minute: 默认为"2-digit"，即有前置0。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
enableHoverMode14+ boolean 否 是否响应悬停态。
默认值：false，默认不响应。
原子化服务API： 从API version 14开始，该接口支持在原子化服务中使用。
hoverModeArea14+ HoverModeAreaType 否 悬停态下弹窗默认展示区域。
默认值：HoverModeAreaType.BOTTOM_SCREEN
原子化服务API： 从API version 14开始，该接口支持在原子化服务中使用。

示例

说明：

推荐通过使用UIContext中的showTimePickerDialog来明确UI的执行上下文。

示例1（弹出时间选择弹窗）

该示例通过点击按钮弹出时间选择弹窗。

// xxx.ets
@Entry
@Component
struct TimePickerDialogExample {
  private selectTime: Date = new Date('2020-12-25T08:30:00')

  build() {
    Column() {
      Button("TimePickerDialog 12小时制")
        .margin(20)
        .onClick(() => {
          TimePickerDialog.show({ // 建议使用 this.getUIContext().showTimePickerDialog()接口
            selected: this.selectTime,
            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 } },
            onAccept: (value: TimePickerResult) => {
              // 设置selectTime为按下确定按钮时的时间，这样当弹窗再次弹出时显示选中的为上一次确定的时间
              if (value.hour != undefined && value.minute != undefined) {
                this.selectTime.setHours(value.hour, value.minute)
                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
              }
            },
            onCancel: () => {
              console.info("TimePickerDialog:onCancel()")
            },
            onChange: (value: TimePickerResult) => {
              console.info("TimePickerDialog:onChange()" + JSON.stringify(value))
            },
            onDidAppear: () => {
              console.info("TimePickerDialog:onDidAppear()")
            },
            onDidDisappear: () => {
              console.info("TimePickerDialog:onDidDisappear()")
            },
            onWillAppear: () => {
              console.info("TimePickerDialog:onWillAppear()")
            },
            onWillDisappear: () => {
              console.info("TimePickerDialog:onWillDisappear()")
            }
          })
        })
      Button("TimePickerDialog 24小时制")
        .margin(20)
        .onClick(() => {
          TimePickerDialog.show({
            selected: this.selectTime,
            useMilitaryTime: true,
            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 } },
            onAccept: (value: TimePickerResult) => {
              if (value.hour != undefined && value.minute != undefined) {
                this.selectTime.setHours(value.hour, value.minute)
                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
              }
            },
            onCancel: () => {
              console.info("TimePickerDialog:onCancel()")
            },
            onChange: (value: TimePickerResult) => {
              console.info("TimePickerDialog:onChange()" + JSON.stringify(value))
            },
            onDidAppear: () => {
              console.info("TimePickerDialog:onDidAppear()")
            },
            onDidDisappear: () => {
              console.info("TimePickerDialog:onDidDisappear()")
            },
            onWillAppear: () => {
              console.info("TimePickerDialog:onWillAppear()")
            },
            onWillDisappear: () => {
              console.info("TimePickerDialog:onWillDisappear()")
            }
          })
        })
    }.width('100%')
  }
}

TimetPickerDialog

示例2（自定义样式）

该示例通过配置disappearTextStyle、textStyle、selectedTextStyle、acceptButtonStyle、cancelButtonStyle实现了自定义文本以及按钮样式。

// xxx.ets
@Entry
@Component
struct TimePickerDialogExample {
  private selectTime: Date = new Date('2020-12-25T08:30:00')

  build() {
    Column() {
      Button("TimePickerDialog 24小时制")
        .margin(20)
        .onClick(() => {
          TimePickerDialog.show({
            selected: this.selectTime,
            useMilitaryTime: true,
            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 } },
            acceptButtonStyle: { type: ButtonType.Normal, style: ButtonStyleMode.NORMAL, role: ButtonRole.NORMAL, fontColor: Color.Red,
              fontSize: '26fp', fontWeight: FontWeight.Bolder, fontStyle: FontStyle.Normal, fontFamily: 'sans-serif', backgroundColor:'#80834511',
              borderRadius: 20 },
            cancelButtonStyle: { type: ButtonType.Normal, style: ButtonStyleMode.NORMAL, role: ButtonRole.NORMAL, fontColor: Color.Blue,
              fontSize: '16fp', fontWeight: FontWeight.Normal, fontStyle: FontStyle.Italic, fontFamily: 'sans-serif', backgroundColor:'#50182431',
              borderRadius: 10 },
            onAccept: (value: TimePickerResult) => {
              if (value.hour != undefined && value.minute != undefined) {
                this.selectTime.setHours(value.hour, value.minute)
                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
              }
            },
            onCancel: () => {
              console.info("TimePickerDialog:onCancel()")
            },
            onChange: (value: TimePickerResult) => {
              console.info("TimePickerDialog:onChange()" + JSON.stringify(value))
            },
            onDidAppear: () => {
              console.info("TimePickerDialog:onDidAppear()")
            },
            onDidDisappear: () => {
              console.info("TimePickerDialog:onDidDisappear()")
            },
            onWillAppear: () => {
              console.info("TimePickerDialog:onWillAppear()")
            },
            onWillDisappear: () => {
              console.info("TimePickerDialog:onWillDisappear()")
            }
          })
        })
    }.width('100%')
  }
}

TimetPickerDialog

示例3（悬停态弹窗）

该示例展示了在折叠屏悬停态下设置dialog布局区域的效果。

@Entry
@Component
struct TimePickerDialogExample {
  private selectTime: Date = new Date('2020-12-25T08:30:00');

  build() {
    Column() {
      Button("TimePickerDialog 12小时制")
        .margin(20)
        .onClick(() => {
          TimePickerDialog.show({ // 建议使用 this.getUIContext().showTimePickerDialog()接口
            selected: this.selectTime,
            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 } },
            onAccept: (value: TimePickerResult) => {
              // 设置selectTime为按下确定按钮时的时间，这样当弹窗再次弹出时显示选中的为上一次确定的时间
              if (value.hour != undefined && value.minute != undefined) {
                this.selectTime.setHours(value.hour, value.minute);
                console.info("TimePickerDialog:onAccept()" + JSON.stringify(value));
              }
            },
            onCancel: () => {
              console.info("TimePickerDialog:onCancel()");
            },
            onChange: (value: TimePickerResult) => {
              console.info("TimePickerDialog:onChange()" + JSON.stringify(value));
            },
            onDidAppear: () => {
              console.info("TimePickerDialog:onDidAppear()");
            },
            onDidDisappear: () => {
              console.info("TimePickerDialog:onDidDisappear()");
            },
            onWillAppear: () => {
              console.info("TimePickerDialog:onWillAppear()");
            },
            onWillDisappear: () => {
              console.info("TimePickerDialog:onWillDisappear()");
            },
            enableHoverMode: true,
            hoverModeArea: HoverModeAreaType.TOP_SCREEN
          })
        })
    }.width('100%')
  }
}

TimetPickerDialog