From 8f98aa7c364d5738fd8fc515244bf06180aab4b0 Mon Sep 17 00:00:00 2001 From: liukaii Date: Sat, 8 Oct 2022 19:16:19 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9text=5Fclock=E5=92=8Ctexttime?= =?UTF-8?q?r=E7=BB=84=E4=BB=B6=E7=9A=84API=E5=8F=82=E8=80=83=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liukaii --- .../arkui-ts/ts-basic-components-textclock.md | 43 +++++++++---------- .../arkui-ts/ts-basic-components-texttimer.md | 40 +++++++---------- 2 files changed, 36 insertions(+), 47 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md index 1cc4843459..cee1fad16b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md @@ -3,12 +3,9 @@ TextClock组件通过文本将当前系统时间显示在设备上。支持不同时区的时间显示，最高精度到秒级。 >**说明：** +> >该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 @@ -19,18 +16,18 @@ TextClock(options?: { timeZoneOffset?: number, controller?: TextClockController **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | -------- | ---- | ------------------ | ------------------------------------------------------------ | -| timeZoneOffset | number | 否 | 当前系统的时区偏移量 | 设置时区偏移量。
取值范围为[-14, 12]，表示东十二区到西十二区，其中负值表示东时区，正值表示西时区，比如东八区为-8。
对横跨国际日界线的国家或地区，用-13（UTC+13）和-14（UTC+14）来保证整个国家或者区域处在相同的时间，当设置的值不在取值范围内时，将使用当前系统的时区偏移量。 | -| controller | [TextClockController](#textclockcontroller) | 否 | null | 绑定一个控制器，用来控制文本时钟的状态。| +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------------- | -------- | ------ | --------------------------------------------------------------------------- | +| timeZoneOffset | number | 否 | 设置时区偏移量。
取值范围为[-14, 12]，表示东十二区到西十二区，其中负值表示东时区，正值表示西时区，比如东八区为-8。
对横跨国际日界线的国家或地区，用-13（UTC+13）和-14（UTC+14）来保证整个国家或者区域处在相同的时间，当设置的值不在取值范围内时，将使用当前系统的时区偏移量。
默认值：当前系统的时区偏移量 | +| controller | [TextClockController](#textclockcontroller) | 否 | 绑定一个控制器，用来控制文本时钟的状态。| ## 属性 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| ------ | -------- | -------- | ------------------------------------------------------------ | -| format | string | 'hms' | 设置显示时间格式。
日期间隔符固定为"/"，时间间隔符为":"。
如yyyyMMdd，yyyy-MM-dd显示为yyyy/MM/dd，
hhmmss显示为hh:mm:ss。
时间格式只用写一位即可，如"hhmmss"等同于"hms"。
支持的时间格式化字符串：
- YYYY/yyyy：完整年份。
- YY/yy：年份后两位。
- M：月份(若想使用01月则使用MM)。
- d：日期(若想使用01日则使用dd)。
- D：年中日(一年中的第几天)。
- H：24小时制。
- h：12小时制。
- m：分钟。
- s：秒。
- SSS：毫秒。| +| 名称 | 参数类型 | 描述 | +| ------ | --------------- | ------------------------------------------------------------ | +| format | string | 设置显示时间格式。
日期间隔符固定为"/"，时间间隔符为":"。
如yyyyMMdd，yyyy-MM-dd显示为yyyy/MM/dd，
hhmmss显示为hh:mm:ss。
时间格式只用写一位即可，如"hhmmss"等同于"hms"。
支持的时间格式化字符串：
- YYYY/yyyy：完整年份。
- YY/yy：年份后两位。
- M：月份(若想使用01月则使用MM)。
- d：日期(若想使用01日则使用dd)。
- D：年中日(一年中的第几天)。
- H：24小时制。
- h：12小时制。
- m：分钟。
- s：秒。
- SSS：毫秒。若格式未匹配，则使用默认值。
默认值： 'hms'| ## 事件 @@ -38,16 +35,16 @@ TextClock(options?: { timeZoneOffset?: number, controller?: TextClockController | 名称 | 功能描述 | | -------------------------------------------- | ------------------------------------------------------------ | -| onDateChange(event: (value: number) => void) | 提供时间变化回调，该事件最小回调间隔为秒。
- value: Unix Time Stamp，即自1970年1月1日（UTC）起经过的毫秒数。 | +| onDateChange(event: (value: number) => void) | 提供时间变化回调，该事件最小回调间隔为秒。
- value: Unix Time Stamp，即自1970年1月1日（UTC）起经过的毫秒数。 | ## TextClockController -TextClock容器组件的控制器，可以将此对象绑定到TextClock组件，再通过它控制文本时钟的启动与停止。一个TextClock组件仅支持绑定一个控制器。 +TextClock容器组件的控制器，可以将该控制器绑定到TextClock组件，通过它控制文本时钟的启动与停止。一个TextClock组件仅支持绑定一个控制器。 ### 导入对象 ```ts -controller: TextClockController = new TextClockController() +controller: TextClockController = new TextClockController(); ``` ### start @@ -62,16 +59,15 @@ stop() 停止文本时钟。 - ## 示例 ```ts @Entry @Component struct Second { - @State accumulateTime: number = 0 - controller: TextClockController = new TextClockController() - + @State accumulateTime: number = 0; + // 导入对象 + controller: TextClockController = new TextClockController(); build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Text('Current milliseconds is ' + this.accumulateTime) @@ -80,18 +76,20 @@ struct Second { TextClock({ timeZoneOffset: -8, controller: this.controller }) .format('hms') .onDateChange((value: number) => { - this.accumulateTime = value + this.accumulateTime = value; }) .margin(20) .fontSize(30) Button("start TextClock") .margin({ bottom: 10 }) .onClick(() => { - this.controller.start() + // 启动文本时钟 + this.controller.start(); }) Button("stop TextClock") .onClick(() => { - this.controller.stop() + // 停止文本时钟 + this.controller.stop(); }) } .width('100%') @@ -99,5 +97,4 @@ struct Second { } } ``` -![](figures/text_clock.png) - +![text_clock](figures/text_clock.gif) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md index 5cbed372dd..b1ee5ea593 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md @@ -3,43 +3,36 @@ 通过文本显示计时信息并控制其计时器状态的组件。 > **说明：** +> > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - -## 权限列表 - -无 - - ## 子组件 无 - ## 接口 -TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) +TextTimer(options?: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | isCountDown | boolean | 否 | false | 是否倒计时。 | - | count | number | 否 | 60000 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
- count<=0时，使用默认值为倒计时初始值。
- count>0时，count值为倒计时初始值。 | - | controller | [TextTimerController](#texttimercontroller) | 否 | - | TextTimer控制器。 | +**参数：** -## 属性 +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------- | -------- | -------- | -------- | -------- | +| isCountDown | boolean | 否 | 是否倒计时。
默认值：false | +| count | number | 否 | 倒计时时间（isCountDown为true时生效），单位为毫秒。最长不超过86400000毫秒（24小时）。 0<count<86400000时，count值为倒计时初始值。否则，使用默认值为倒计时初始值。
默认值：60000 | +| controller | [TextTimerController](#texttimercontroller) | 否 | TextTimer控制器。 | -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| format | string | 'hh:mm:ss.ms' | 自定义格式，需至少包含一个hh、mm、ss、ms中的关键字。 | +## 属性 +| 名称 | 参数类型 | 描述 | +| -------- | ---------------------- | ---------------------- | +| format | string | 自定义格式，需至少包含一个HH、mm、ss、SS中的关键字。如使用yy、MM、dd等日期格式，则使用默认值。
默认值：'HH:mm:ss.SS' | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onTimer(event: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：当前显示的时间，单位为毫秒。
elapsedTime：计时器经过的时间，单位为毫秒。 | - +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onTimer(event: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：Linux时间戳，即自1970年1月1日起经过的毫秒数。
elapsedTime：计时器经过的时间，单位为毫秒。 | ## TextTimerController @@ -70,7 +63,6 @@ reset() 重置计时器。 - ## 示例 ```ts @@ -79,7 +71,7 @@ reset() @Component struct TextTimerExample { textTimerController: TextTimerController = new TextTimerController() - @State format: string = 'hh:mm:ss.ms' + @State format: string = 'HH:mm:ss.SS' build() { Column() { -- GitLab