智能客服
你问我答,随时在线为你解决问题

























TextClock组件通过文本将当前系统时间显示在设备上,支持不同时区的时间显示和时间格式自定义,最高精度到秒级。适用于需要在应用界面上实时展示系统时间、支持多时区显示的场景,可帮助开发者快速实现时间文本展示功能,无需手动计算和更新时间。
组件不可见时,时间变动将停止。组件的可见状态基于onVisibleAreaChange处理,可见阈值ratios大于0即视为可见状态。
该组件从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
无
TextClock(options?: TextClockOptions)
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | TextClockOptions | 否 | 通过文本显示当前系统时间的组件参数。不传入时使用默认配置,各属性默认值详见TextClockOptions。 |
用于构建TextClock组件的选项。
为规范匿名对象的定义,API 18版本修改了此处的元素定义。其中,保留了历史匿名对象的起始版本信息,会出现外层元素@since版本号高于内层元素版本号的情况,但这不影响接口的使用。
卡片能力: 从API version 18开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 18开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| timeZoneOffset8+ | number | 否 | 是 | 设置时区偏移量,单位:小时。 取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8。设置值为该取值范围内的浮点数时会进行取整,舍弃小数部分。 对横跨国际日界线的国家或地区,用-13(UTC+13)和-14(UTC+14)来保证整个国家或者区域处在相同的时间,当设置的值不在取值范围内时,将使用当前系统的时区偏移量。 默认值:当前系统的时区偏移量 设置值为{ 9.5, 3.5, -3.5, -4.5, -5.5, -5.75, -6.5, -9.5, -10.5, -12.75 }集合中的浮点数时不进行取整。 卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
| controller8+ | TextClockController | 否 | 是 | 绑定一个控制器,用来控制文本时钟的状态。当需要通过代码控制时钟的启动与停止时传入此参数;不传入时,时钟仍会正常运行显示,但无法通过代码控制启停。 卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
format(value: ResourceStr)
设置显示时间格式,如“yyyy/MM/dd”、“yyyy-MM-dd”。
y:年(yyyy表示完整年份,yy表示年份后两位)
M:月(若想使用01月则使用MM)
d:日(若想使用01日则使用dd)
E:星期(若想使用星期六则使用EEEE,若想使用周六则使用E、EE、EEE)
H:小时(24小时制)
h:小时(12小时制)
m:分钟
s:秒
SS:厘秒(format中S个数<3,全部按厘秒处理)
SSS:毫秒(format中S个数>=3,全部按毫秒处理)
a:上午/下午(当设置小时制式为H时,该参数不生效)
日期间隔符:"年月日"、“/”、"-"、"."(可以自定义间隔符样式,字母不可以作为间隔符,汉字可以作为间隔符处理)
允许自行拼接组合显示格式,即:年、月、日、星期、时、分、秒、毫秒可拆分为子元素,可自行排布组合。时间更新频率最高为一秒一次,不建议单独设置厘秒和毫秒格式。
当设置无效字母时(非上述字母被认为是无效字母),该字母会被忽略。如果format全是无效字母时,显示格式跟随系统语言和系统小时制。例如系统语言为中文时,12小时制显示格式为yyyy/MM/dd aa hh:mm:ss.SSS,24小时制显示格式为yyyy/MM/dd HH:mm:ss.SSS。
若format为空字符串("")或者undefined,则使用默认值。
非卡片中默认值:12小时制:aa hh:mm:ss,24小时制:HH:mm:ss。
卡片中默认值:12小时制:hh:mm,24小时制:HH:mm 。
卡片中使用时,最小时间单位为分钟。如果设置格式中有秒或厘秒,则按默认值处理。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | ResourceStr | 是 | 显示时间格式。 从API version 20开始,支持Resource类型。 |
以下是format输入的格式样式及对应的显示效果:
| 输入格式 | 显示效果 |
|---|---|
| yyyy年M月d日 EEEE | 2023年2月4日 星期六 |
| yyyy年M月d日 | 2023年2月4日 |
| M月d日 EEEE | 2月4日 星期六 |
| M月d日 | 2月4日 |
| MM/dd/yyyy | 02/04/2023 |
| EEEE MM月dd日 | 星期六 02月04日 |
| yyyy(完整年份) | 2023年 |
| yy(年份后两位) | 23年 |
| MM(完整月份) | 02月 |
| M(月份) | 2月 |
| dd(完整日期) | 04日 |
| d(日期) | 4日 |
| EEEE(完整星期) | 星期六 |
| E、EE、EEE(简写星期) | 周六 |
| yyyy年M月d日 | 2023年2月4日 |
| yyyy/M/d | 2023/2/4 |
| yyyy-M-d | 2023-2-4 |
| yyyy.M.d | 2023.2.4 |
| HH:mm:ss(时:分:秒) | 17:00:04 |
| aa hh:mm:ss(时:分:秒) | 上午 5:00:04 |
| hh:mm:ss(时:分:秒) | 5:00:04 |
| HH:mm(时:分) | 17:00 |
| aa hh:mm(时:分) | 上午 5:00 |
| hh:mm(时:分) | 5:00 |
| mm:ss(分:秒) | 00:04 |
| mm:ss.SS(分:秒.厘秒) | 00:04.91 |
| mm:ss.SSS(分:秒.毫秒) | 00:04.536 |
| hh:mm:ss aa | 5:00:04 上午 |
| HH | 17 |
fontColor(value: ResourceColor)
设置字体颜色。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | ResourceColor | 是 | 字体颜色。 Wearable设备上默认值:'#c5ffffff',其他设备默认值:'#e6182431' |
fontSize(value: Length)
设置字体大小。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | Length | 是 | 字体大小。fontSize为number类型时,使用fp单位。 字体默认大小16fp。不支持设置百分比字符串,传入百分比字符串时使用默认值。 |
fontStyle(value: FontStyle)
设置字体样式。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | FontStyle | 是 | 字体样式。 默认值:FontStyle.Normal,表示标准的字体样式(非斜体)。 |
fontWeight(value: number | FontWeight | string)
设置文本的字体粗细,设置过大可能会导致不同字体下的文字出现截断。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | FontWeight | string | 是 | 文本的字体粗细,number类型取值范围为[100, 900],取值间隔为100,取值越大,字体越粗。number类型取值范围外的默认值为400。string类型支持:number类型取值的字符串形式(如400),以及枚举值'lighter'(对应300)、'regular'(对应400)、'medium'(对应500)、'bold'(对应700)、'bolder'(对应900),分别对应FontWeight中相应的枚举值。 默认值:FontWeight.Normal |
fontFamily(value: ResourceStr)
设置字体列表。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | ResourceStr | 是 | 字体列表。默认字体'HarmonyOS Sans'。 应用当前支持'HarmonyOS Sans'字体和注册自定义字体。 卡片当前仅支持'HarmonyOS Sans'字体。 |
textShadow(value: ShadowOptions | Array<ShadowOptions>)
设置文字阴影效果。该接口支持以数组形式入参,实现多重文字阴影。不支持fill字段和智能取色模式。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | ShadowOptions | Array<ShadowOptions> | 是 | 文字阴影效果。支持单个阴影对象或阴影数组实现多重阴影效果。ShadowOptions对象包含radius(模糊半径)、color(阴影颜色)、offsetX(X轴偏移)、offsetY(Y轴偏移)等属性。 不支持fill字段,不支持智能取色模式。具体属性说明请参考ShadowOptions对象说明。 |
fontFeature(value: string)
设置文字特性效果,比如数字等宽的特性。
格式为:normal | <feature-tag-value>
<feature-tag-value>的格式为:<string> [ <integer> | on | off ]
<feature-tag-value>的个数可以有多个,中间用','隔开。
例如,使用等宽时钟数字的输入格式为:"ss01" on。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | string | 是 | 文字特性效果,用于设置文字的OpenType特性。格式为:normal | <feature-tag-value>,其中<feature-tag-value>格式为:<string> [ <integer> | on | off ]。可设置多个特性,中间用','隔开。例如,使用等宽时钟数字的格式为:'"ss01" on'。 |
contentModifier(modifier: ContentModifier<TextClockConfiguration>)
定制TextClock内容区的方法。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| modifier | ContentModifier<TextClockConfiguration> | 是 | 在TextClock组件上,定制内容区的方法。 modifier: 内容修改器,开发者需要自定义class实现ContentModifier接口。 |
dateTimeOptions(dateTimeOptions: Optional<DateTimeOptions>)
设置小时是否显示前导0。
卡片能力: 从API version 12开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dateTimeOptions | Optional<DateTimeOptions> | 是 | 设置小时是否显示前导0,只支持设置hour参数,参数值为{hour: "2-digit"}时表示显示前导0,参数值为{hour: "numeric"}时表示不显示前导0。 默认值:undefined,默认状态下,24小时制显示前导0,12小时制不显示前导0。 |
onDateChange(event: (value: number) => void)
提供时间变化回调,该事件回调间隔为秒。
组件不可见时不回调。
非卡片中使用时,该事件回调间隔为秒。
卡片中使用时,该事件回调间隔为分钟。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | Unix Time Stamp,即自1970年1月1日(UTC)起经过的秒数。 |
TextClock容器组件的控制器,可以将该控制器绑定到TextClock组件,通过它控制文本时钟的启动与停止。一个TextClock组件仅支持绑定一个控制器。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
- controller: TextClockController = new TextClockController();
constructor()
TextClockController的构造函数。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
start()
启动文本时钟。使用前需先将TextClockController绑定到TextClock组件。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
stop()
停止文本时钟。使用前需先将TextClockController绑定到TextClock组件。
卡片能力: 从API version 11开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
开发者需要自定义class实现ContentModifier接口。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| timeZoneOffset | number | 否 | 否 | 当前文本时钟时区偏移量。 取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8。设置值为该取值范围内的浮点数时会进行取整,舍弃小数部分。当设置的值不在取值范围内时,将使用当前系统的时区偏移量。 |
| started | boolean | 否 | 否 | 指示文本时钟是否启动。 true:表示启动文本时钟。 false:表示停止文本时钟。 默认值:true |
| timeValue | number | 否 | 否 | 当前文本时钟时区的UTC秒数。 |
该示例展示了TextClock组件的基本使用方法,通过format属性设置时钟文本的格式。
点击"start TextClock"按钮,按钮回调函数会调用TextClockController启动文本时钟。点击"stop TextClock"按钮,会调用TextClockController停止文本时钟。
示例中的组件通过设置onDateChange回调函数,在文本时钟更新时,持续修改accumulateTime的内容。
- @Entry
- @Component
- struct Second {
- @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)
- .fontSize(20)
- // 以12小时制显示东八区的系统时间,精确到秒。
- TextClock({ timeZoneOffset: -8, controller: this.controller })
- .format('aa hh:mm:ss')
- .onDateChange((value: number) => {
- this.accumulateTime = value;
- })
- .margin(20)
- .fontSize(30)
- Button('start TextClock')
- .margin({ bottom: 10 })
- .onClick(() => {
- // 启动文本时钟
- this.controller.start();
- })
- Button('stop TextClock')
- .onClick(() => {
- // 停止文本时钟
- this.controller.stop();
- })
- }
- .width('100%')
- .height('100%')
- }
- }

该示例通过textShadow属性设置时钟文本的阴影样式。
- @Entry
- @Component
- struct TextClockExample {
- @State textShadows: ShadowOptions | Array<ShadowOptions> = [{
- radius: 10,
- color: Color.Red,
- offsetX: 10,
- offsetY: 0
- }, {
- radius: 10,
- color: Color.Black,
- offsetX: 20,
- offsetY: 0
- }, {
- radius: 10,
- color: Color.Brown,
- offsetX: 30,
- offsetY: 0
- }, {
- radius: 10,
- color: Color.Green,
- offsetX: 40,
- offsetY: 0
- }, {
- radius: 10,
- color: Color.Yellow,
- offsetX: 100,
- offsetY: 0
- }];
-
- build() {
- Column({ space: 8 }) {
- TextClock().fontSize(50).textShadow(this.textShadows)
- }
- }
- }

该示例实现了自定义文本时钟样式的功能,自定义样式实现了一个时间选择器组件:通过文本时钟的时区偏移量与UTC秒数,来动态改变时间选择器的选中值,实现时钟效果。同时,根据文本时钟的启动状态,实现时间选择器的12小时制与24小时制的切换。
- class MyTextClockStyle implements ContentModifier<TextClockConfiguration> {
- currentTimeZoneOffset: number = new Date().getTimezoneOffset() / 60;
- title: string = '';
-
- constructor(title: string) {
- this.title = title;
- }
-
- applyContent(): WrappedBuilder<[TextClockConfiguration]> {
- return wrapBuilder(buildTextClock);
- }
- }
-
- @Builder
- function buildTextClock(config: TextClockConfiguration) {
- Row() {
- Column() {
- Text((config.contentModifier as MyTextClockStyle).title)
- .fontSize(20)
- .margin(20)
- TimePicker({
- // 根据UTC秒数和时区偏移量计算本地时间:config.timeValue为UTC秒数,需乘1000转为毫秒;
- // currentTimeZoneOffset为当前系统时区偏移量,timeZoneOffset为目标时区偏移量,
- // 二者之差乘以3600000得到时区调整的毫秒数
- selected: (new Date(config.timeValue * 1000 +
- ((config.contentModifier as MyTextClockStyle).currentTimeZoneOffset - config.timeZoneOffset) * 60 * 60 *
- 1000)),
- format: TimePickerFormat.HOUR_MINUTE_SECOND
- })
- .useMilitaryTime(!config.started)
- }
- }
- }
-
- @Entry
- @Component
- struct TextClockExample {
- @State accumulateTime1: number = 0;
- @State timeZoneOffset: number = -8;
- controller1: TextClockController = new TextClockController();
- controller2: TextClockController = new TextClockController();
-
- build() {
- Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
- Text('Current milliseconds is ' + this.accumulateTime1)
- .fontSize(20)
- .margin({ top: 20 })
- TextClock({ timeZoneOffset: this.timeZoneOffset, controller: this.controller1 })
- .format('aa hh:mm:ss')
- .onDateChange((value: number) => {
- this.accumulateTime1 = value;
- })
- .margin(20)
- .fontSize(30)
- TextClock({ timeZoneOffset: this.timeZoneOffset, controller: this.controller2 })
- .format('aa hh:mm:ss')
- .fontSize(30)
- .contentModifier(new MyTextClockStyle('ContentModifier:'))
- Button('start TextClock')
- .margin({ top: 20, bottom: 10 })
- .onClick(() => {
- // 启动文本时钟
- this.controller1.start();
- this.controller2.start();
- })
- Button('stop TextClock')
- .margin({ bottom: 30 })
- .onClick(() => {
- // 停止文本时钟
- this.controller1.stop();
- this.controller2.stop();
- })
-
- }
- .width('100%')
- .height('100%')
- }
- }

该示例演示了dateTimeOptions属性为小时字段增加或去除前导0的功能。24小时制的小时字段默认带有前导0,可通过dateTimeOptions属性去除前导0,12小时制的小时字段默认不带有前导0,可通过dateTimeOptions属性增加前导0。
- @Entry
- @Component
- struct TextClockExample {
- build() {
- Column({ space: 8 }) {
- Row() {
- Text('24小时制去除前导0:')
- .fontSize(20)
- TextClock()
- .fontSize(20)
- .format('HH:mm:ss')
- .dateTimeOptions({ hour: 'numeric' })
- }
-
- Row() {
- Text('12小时制增加前导0:')
- .fontSize(20)
- TextClock()
- .fontSize(20)
- .format('aa hh:mm:ss')
- .dateTimeOptions({ hour: '2-digit' })
- }
- }
- .alignItems(HorizontalAlign.Start)
- }
- }

该示例演示了使用fontFeature、fontColor、fontStyle、fontWeight、fontFamily属性设置时钟文字显示样式的功能。
- @Entry
- @Component
- struct Index {
- build() {
- Column() {
- Text('fontFeature').fontColor(0xCCCCCC)
- // 设置文本特性
- TextClock()
- .fontFeature('\"sinf\" off')
- TextClock()
- .fontFeature('\"sinf\" on')
- .margin('10%')
-
- // 设置字体颜色
- Text('fontColor').fontColor(0xCCCCCC)
- TextClock()
- .fontColor(Color.Black)
- TextClock()
- .fontColor(Color.Blue)
- .margin('10%')
-
- Text('fontStyle').fontColor(0xCCCCCC)
- // 设置字体样式
- TextClock()
- .fontStyle(FontStyle.Normal)
- TextClock()
- .fontStyle(FontStyle.Italic)
- .margin('10%')
-
- Text('fontWeight').fontColor(0xCCCCCC)
- // 设置字体粗细
- TextClock()
- .fontWeight(FontWeight.Normal)
- TextClock()
- .fontWeight(FontWeight.Bold)
- .margin('10%')
-
- Text('fontFamily').fontColor(0xCCCCCC)
- // 设置字体
- TextClock()
- .fontFamily('HarmonyOS Sans')
- }
- .width('100%')
- .height('100%')
- }
- }

智能客服
你问我答,随时在线为你解决问题
合作咨询
我们的专家服务团队将竭诚为您提供专业的合作咨询服务
解决方案
精准高效的一站式服务支持,助力开发者商业成功