• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Text
2
3显示一段文本的组件。
4
5>  **说明:**
6>
7>  该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 子组件
11
12可以包含[Span](ts-basic-components-span.md)子组件。
13
14
15## 接口
16
17Text(content?: string | Resource)
18
19从API version 9开始,该接口支持在ArkTS卡片中使用。
20
21**参数:**
22
23| 参数名 | 参数类型 | 必填 | 参数描述 |
24| -------- | -------- | -------- | -------- |
25| content | string \| [Resource](ts-types.md#resource) | 否 | 文本内容。包含子组件Span时不生效,显示Span内容,并且此时text组件的样式不生效。<br/>默认值:' ' |
26
27## 属性
28
29除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:
30
31| 名称                       | 参数类型                            | 描述                                               |
32| ----------------------- | ----------------------------------- | ------------------------------------------- |
33| textAlign               | [TextAlign](ts-appendix-enums.md#textalign) | 设置文本段落在水平方向的对齐方式<br/>默认值:TextAlign.Start<br/>说明:<br/>文本段落宽度占满Text组件宽度;可通过[align](ts-universal-attributes-location.md)属性控制文本段落在垂直方向上的位置。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
34| textOverflow            | {overflow:&nbsp;[TextOverflow](ts-appendix-enums.md#textoverflow)} | 设置文本超长时的显示方式。<br/>默认值:{overflow:&nbsp;TextOverflow.Clip}<br/>**说明:**<br/>文本截断是按字截断。例如,英文以单词为最小单位进行截断,若需要以字母为单位进行截断,可在字母间添加零宽空格:\u200B。<br />需配合`maxLines`使用,单独设置不生效。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
35| maxLines                | number | 设置文本的最大行数。<br />默认值:Infinity<br/>**说明:**<br />默认情况下,文本是自动折行的,如果指定此参数,则文本最多不会超过指定的行。如果有多余的文本,可以通过        `textOverflow`来指定截断方式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
36| lineHeight              | string&nbsp;\|&nbsp;number&nbsp;\|&nbsp;[Resource](ts-types.md#resource)  | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
37| decoration              | {<br/>type:&nbsp;[TextDecorationType](ts-appendix-enums.md#textdecorationtype),<br/>color?:&nbsp;[ResourceColor](ts-types.md#resourcecolor)<br/>} | 设置文本装饰线样式及其颜色。<br />默认值:{<br/>type:&nbsp;TextDecorationType.None,<br/>color:Color.Black<br/>} <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
38| baselineOffset          | number&nbsp;\|&nbsp;string | 设置文本基线的偏移量,默认值0。  <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>设置该值为百分比时,按默认值显示。 |
39| letterSpacing           | number&nbsp;\|&nbsp;string | 设置文本字符间距。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>设置该值为百分比时,按默认值显示。 |
40| minFontSize             | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource)      | 设置文本最小显示字号。<br/>需配合maxFontSize以及maxline或布局大小限制使用,单独设置不生效。 <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。                               |
41| maxFontSize             | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](ts-types.md#resource)      | 设置文本最大显示字号。<br/>需配合minFontSize以及maxline或布局大小限制使用,单独设置不生效。 <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。                                |
42| textCase                | [TextCase](ts-appendix-enums.md#textcase) | 设置文本大小写。<br />默认值:TextCase.Normal <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
43| copyOption<sup>9+</sup> | [CopyOptions](ts-appendix-enums.md#copyoptions9) | 组件支持设置文本是否可复制粘贴。<br />默认值:CopyOptions.None <br/>该接口支持在ArkTS卡片中使用。 |
44
45>  **说明:**
46>
47>  不支持Text内同时存在文本内容和Span子组件。如果同时存在,只显示Span内的内容。
48
49## 事件
50
51支持[通用事件](ts-universal-events-click.md)。
52
53
54## 示例
55
56### 示例1
57textAlign,textOverflow,maxLines,lineHeight使用示例。
58```ts
59// xxx.ets
60@Entry
61@Component
62struct TextExample1 {
63  build() {
64    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
65      // 文本水平方向对齐方式设置
66      // 单行文本
67      Text('textAlign').fontSize(9).fontColor(0xCCCCCC)
68      Text('TextAlign set to Center.')
69        .textAlign(TextAlign.Center)
70        .fontSize(12)
71        .border({ width: 1 })
72        .padding(10)
73        .width('100%')
74      Text('TextAlign set to Start.')
75        .textAlign(TextAlign.Start)
76        .fontSize(12)
77        .border({ width: 1 })
78        .padding(10)
79        .width('100%')
80      Text('TextAlign set to End.')
81        .textAlign(TextAlign.End)
82        .fontSize(12)
83        .border({ width: 1 })
84        .padding(10)
85        .width('100%')
86
87      // 多行文本
88      Text('This is the text content with textAlign set to Center.')
89        .textAlign(TextAlign.Center)
90        .fontSize(12)
91        .border({ width: 1 })
92        .padding(10)
93        .width('100%')
94      Text('This is the text content with textAlign set to Start.')
95        .textAlign(TextAlign.Start)
96        .fontSize(12)
97        .border({ width: 1 })
98        .padding(10)
99        .width('100%')
100      Text('This is the text content with textAlign set to End.')
101        .textAlign(TextAlign.End)
102        .fontSize(12)
103        .border({ width: 1 })
104        .padding(10)
105        .width('100%')
106
107
108      // 文本超长时显示方式
109      Text('TextOverflow+maxLines').fontSize(9).fontColor(0xCCCCCC)
110      // 超出maxLines截断内容展示
111      Text('This is the setting of textOverflow to Clip text content This is the setting of textOverflow to None text content. This is the setting of textOverflow to Clip text content This is the setting of textOverflow to None text content.')
112        .textOverflow({ overflow: TextOverflow.Clip })
113        .maxLines(1)
114        .fontSize(12)
115        .border({ width: 1 })
116        .padding(10)
117
118      // 超出maxLines展示省略号
119      Text('This is set textOverflow to Ellipsis text content This is set textOverflow to Ellipsis text content.'.split('')
120        .join('\u200B'))
121        .textOverflow({ overflow: TextOverflow.Ellipsis })
122        .maxLines(1)
123        .fontSize(12)
124        .border({ width: 1 })
125        .padding(10)
126
127      Text('lineHeight').fontSize(9).fontColor(0xCCCCCC)
128      Text('This is the text with the line height set. This is the text with the line height set.')
129        .fontSize(12).border({ width: 1 }).padding(10)
130      Text('This is the text with the line height set. This is the text with the line height set.')
131        .fontSize(12).border({ width: 1 }).padding(10)
132        .lineHeight(20)
133    }.height(600).width(350).padding({ left: 35, right: 35, top: 35 })
134  }
135}
136```
137![textExp1](figures/textExp1.png)
138
139### 示例2
140decoration,baselineOffset,letterSpacing,textCase使用示例:
141```ts
142@Entry
143@Component
144struct TextExample2 {
145  build() {
146    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
147      Text('decoration').fontSize(9).fontColor(0xCCCCCC)
148      Text('This is the text content with the decoration set to LineThrough and the color set to Red.')
149        .decoration({
150          type: TextDecorationType.LineThrough,
151          color: Color.Red
152        })
153        .fontSize(12)
154        .border({ width: 1 })
155        .padding(10)
156        .width('100%')
157
158
159      Text('This is the text content with the decoration set to Overline and the color set to Red.')
160        .decoration({
161          type: TextDecorationType.Overline,
162          color: Color.Red
163        })
164        .fontSize(12)
165        .border({ width: 1 })
166        .padding(10)
167        .width('100%')
168
169
170      Text('This is the text content with the decoration set to Underline and the color set to Red.')
171        .decoration({
172          type: TextDecorationType.Underline,
173          color: Color.Red
174        })
175        .fontSize(12)
176        .border({ width: 1 })
177        .padding(10)
178        .width('100%')
179
180      // 文本基线偏移
181      Text('baselineOffset').fontSize(9).fontColor(0xCCCCCC)
182      Text('This is the text content with baselineOffset 0.')
183        .baselineOffset(0)
184        .fontSize(12)
185        .border({ width: 1 })
186        .padding(10)
187        .width('100%')
188      Text('This is the text content with baselineOffset 30.')
189        .baselineOffset(30)
190        .fontSize(12)
191        .border({ width: 1 })
192        .padding(10)
193        .width('100%')
194      Text('This is the text content with baselineOffset -20.')
195        .baselineOffset(-20)
196        .fontSize(12)
197        .border({ width: 1 })
198        .padding(10)
199        .width('100%')
200
201      // 文本字符间距
202      Text('letterSpacing').fontSize(9).fontColor(0xCCCCCC)
203      Text('This is the text content with letterSpacing 0.')
204        .letterSpacing(0)
205        .fontSize(12)
206        .border({ width: 1 })
207        .padding(10)
208        .width('100%')
209      Text('This is the text content with letterSpacing 3.')
210        .letterSpacing(3)
211        .fontSize(12)
212        .border({ width: 1 })
213        .padding(10)
214        .width('100%')
215      Text('This is the text content with letterSpacing -1.')
216        .letterSpacing(-1)
217        .fontSize(12)
218        .border({ width: 1 })
219        .padding(10)
220        .width('100%')
221
222      Text('textCase').fontSize(9).fontColor(0xCCCCCC)
223      Text('This is the text content with textCase set to Normal.')
224        .textCase(TextCase.Normal)
225        .fontSize(12)
226        .border({ width: 1 })
227        .padding(10)
228        .width('100%')
229      // 文本全小写展示
230      Text('This is the text content with textCase set to LowerCase.')
231        .textCase(TextCase.LowerCase)
232        .fontSize(12)
233        .border({ width: 1 })
234        .padding(10)
235        .width('100%')
236      // 文本全大写展示
237      Text('This is the text content with textCase set to UpperCase.')
238        .textCase(TextCase.UpperCase)
239        .fontSize(12).border({ width: 1 }).padding(10)
240
241    }.height(700).width(350).padding({ left: 35, right: 35, top: 35 })
242  }
243}
244```
245![textExp1](figures/textExp2.png)
246