• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# RichText
2<!--Kit: ArkWeb-->
3<!--Subsystem: Web-->
4<!--Owner: @weixin_41848015-->
5<!--Designer: @libing23232323-->
6<!--Tester: @ghiker-->
7<!--Adviser: @HelloCrease-->
8
9富文本组件，解析并显示HTML格式文本。
10
11- 适用场景：
12
13  RichText组件适用于加载与显示一段HTML字符串，且不需要对显示效果进行较多自定义的应用场景。RichText组件仅支持有限的通用属性和事件。具体见[属性](#属性)与[事件](#事件)小节。
14
15  RichText组件底层复用了Web组件来提供基础能力，包括但不限于HTML页面的解析、渲染等。因此使用RichText组件需要遵循Web约束条件。常见典型约束如下：
16
17  移动设备的视口默认值大小为980px，默认值可以确保大部分网页在移动设备下可以正常浏览。如果RichText组件宽度低于这个值，content内部的HTML则可能会产生一个可以滑动的页面被RichText组件包裹。如果想替换默认值，可以在content中添加以下标签：
18
19  ```html
20  <meta name="viewport" content="width=device-width">
21  ```
22
23- 不适用场景：
24
25  RichText组件不适用于对HTML字符串的显示效果进行较多自定义的应用场景。例如RichText组件不支持通过设置属性与事件，来修改背景颜色、字体颜色、字体大小、动态改变内容等。在这种情况下，推荐使用[Web组件](../../apis-arkweb/arkts-basic-components-web.md)。
26
27  RichText组件消耗较多内存资源，在List下循环重复使用RichText组件时，会出现卡顿、滑动响应迟缓等现象。
28
29>  **说明：**
30>
31> - 该组件从API version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
32> - 该组件无法根据内容自适应设置宽高属性，需要开发者设置显示布局。
33> - 该组件不再更新和维护，推荐使用[Web组件](../../apis-arkweb/arkts-basic-components-web.md)。
34
35
36## 子组件
37
38不包含子组件。
39
40## 接口
41
42RichText(content:string &nbsp;|&nbsp; Resource)
43
44**系统能力：** SystemCapability.ArkUI.ArkUI.Full
45
46**参数:**
47
48| 参数名 | 类型 | 必填  | 说明 |
49| ------- | -------- | ------------- | -------- |
50| content | string \| [Resource](ts-types.md#resource) <sup>20+</sup>   | 是   | 表示HTML格式的字符串或者本地资源文件。 |
51
52
53
54## 事件
55
56### onStart
57
58onStart(callback: () => void)
59
60**系统能力：** SystemCapability.ArkUI.ArkUI.Full
61
62**参数:**
63
64| 参数名 | 类型 | 必填  | 说明 |
65| ------- | -------- | ------------- | -------- |
66|  callback | () => void | 是   | 加载网页时触发回调。 |
67
68### onComplete
69
70onComplete(callback: () => void)
71
72**系统能力：** SystemCapability.ArkUI.ArkUI.Full
73
74**参数:**
75
76| 参数名 | 类型 | 必填  | 说明 |
77| ------- | -------- | ------------- | -------- |
78|  callback | () => void | 是   | 网页加载结束时触发回调。 |
79
80## 属性
81
82只支持[通用属性](ts-component-general-attributes.md)中width，height，size，layoutWeight四个属性。由于padding，margin，constraintSize属性使用时与通用属性描述不符，暂不支持。
83
84## 支持标签
85
86| 名称 | 描述 | 示例 |
87| -------- | -------- | -------- |
88| \<h1>--\<h6> | 被用来定义HTML，\<h1>定义重要等级最高的标题，\<h6>定义重要等级最低的标题。 | \<h1>这是一个标题\</h1>\<h2>这是h2标题\</h2> |
89| \<p>\</p> | 定义段落。 | \<p>这是一个段落\</p> |
90| \<br/> | 插入一个简单的换行符。 | \<p>这是一个段落\<br/>这是换行段落\</p> |
91| \<font/> | 规定文本的字体、字体尺寸、字体颜色。在<font/>标签中font size能够设置的值只有1到7的数字，默认值是3，由于<font/>标签在HTML 4.01中不建议使用，在XHTML1.0 Strict DTD中不支持，所以不建议使用此标签，请使用CSS代替。CSS语法：\<p style="font-size: 35px; font-family: verdana; color: rgb(24,78,228)"> | \<font size="3" face="arial" color="red">这是一段红色字体。\</font> |
92| \<hr/> | 定义HTML页面中的主题变化（比如话题的转移），并显示为一条水平线。 | \<p>这个一个段落\</p>\<hr/>\<p>这是一个段落\</p> |
93| \<image>\</image> | 用来定义图片。 | \<image src="resource://rawfile/icon.png">\</image> |
94| \<div>\</div> | 常用于组合块级元素，以便通过CSS来对这些元素进行格式化。 | \<div style='color:#0000FF'>\<h3>这是一个在div元素中的标题。\</h3>\</div> |
95| \<i>\</i> | 定义与文本中其余部分不同的部分，并把这部分文本呈现为斜体文本。 | \<i>这是一个斜体\</i> |
96| \<u>\</u> | 定义与常规文本风格不同的文本，像拼写错误的单词或者汉语中的专有名词，应尽量避免使用\<u>为文本加下划线，用户会把它混淆为一个超链接。 | \<p>\<u>这是带有下划线的段落\</u>\</p> |
97| \<style>\</style> | 定义HTML文档的样式信息。 | \<style>h1{color:red;}p{color:blue;}\</style> |
98| style | 属性规定元素的行内样式，写在标签内部，在使用的时候需用引号来进行区分，并以; 间隔样式，style='width: 500px;height: 500px;border: 1px soild;margin: 0 auto;'。 | \<h1 style='color:blue;text-align:center'>这是一个标题\</h1>\<p style='color:green'>这是一个段落。\</p> |
99| \<script>\</script> | 用于定义客户端脚本，比如JavaScript。 | \<script>document.write("Hello World!")\</script> |
100
101## 示例
102
103示例效果请以真机运行为准，当前DevEco Studio预览器不支持。
104
105```ts
106// xxx.ets
107@Entry
108@Component
109struct RichTextExample {
110  @State data: string = '<h1 style="text-align: center;">h1标题</h1>' +
111  '<h1 style="text-align: center;"><i>h1斜体</i></h1>' +
112  '<h1 style="text-align: center;"><u>h1下划线</u></h1>' +
113  '<h2 style="text-align: center;">h2标题</h2>' +
114  '<h3 style="text-align: center;">h3标题</h3>' +
115  '<p style="text-align: center;">p常规</p><hr/>' +
116  '<div style="width: 500px;height: 500px;border: 1px solid;margin: 0 auto;">' +
117  '<p style="font-size: 35px;text-align: center;font-weight: bold; color: rgb(24,78,228)">字体大小35px,行高45px</p>' +
118  '<p style="background-color: #e5e5e5;line-height: 45px;font-size: 35px;text-indent: 2em;">' +
119  '<p>这是一段文字这是一段文字这是一段文字这是一段文字这是一段文字这是一段文字这是一段文字这是一段文字这是一段文字</p>';
120
121  build() {
122    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center,
123      justifyContent: FlexAlign.Center }) {
124      RichText(this.data)
125        .onStart(() => {
126          console.info('RichText onStart');
127        })
128        .onComplete(() => {
129          console.info('RichText onComplete');
130        })
131        .width(500)
132        .height(500)
133        .backgroundColor(0XBDDB69)
134      RichText('layoutWeight(1)')
135        .onStart(() => {
136          console.info('RichText onStart');
137        })
138        .onComplete(() => {
139          console.info('RichText onComplete');
140        })
141        .size({ width: '100%', height: 110 })
142        .backgroundColor(0X92D6CC)
143        .layoutWeight(1)
144      RichText('layoutWeight(2)')
145        .onStart(() => {
146          console.info('RichText onStart');
147        })
148        .onComplete(() => {
149          console.info('RichText onComplete');
150        })
151        .size({ width: '100%', height: 110 })
152        .backgroundColor(0X92C48D)
153        .layoutWeight(2)
154    }
155  }
156}
157```
158
159 ![richText](figures/richText.png)
160
161加载本地资源文件。
162
163通过$rawfile方式加载。
164
165  ```ts
166  // xxx.ets
167  @Entry
168  @Component
169  struct RichTextComponent {
170
171    build() {
172      Column() {
173        // 通过$rawfile加载本地资源文件。
174        RichText($rawfile("index.html"))
175      }
176    }
177  }
178  ```
179
180通过resources协议加载，适用Webview加载带有"#"路由的链接。
181
182使用 `resource://rawfile/` 协议前缀可以避免常规 `$rawfile` 方式在处理带有"#"路由链接时的局限性。当URL中包含"#"号时，"#"后面的内容会被视为锚点（fragment）。
183
184  ```ts
185  // xxx.ets
186  @Entry
187  @Component
188  struct RichTextComponent {
189
190    build() {
191      Column() {
192        // 通过resource协议加载本地资源文件。
193        RichText("resource://rawfile/index.html#home")
194      }
195    }
196  }
197  ```
198
199在“src\main\resources\rawfile”文件夹下创建index.html：
200
201   加载的html文件。
202
203   ```html
204   <!-- index.html -->
205   <!DOCTYPE html>
206   <html>
207       <body>
208           <p>Hello World</p>
209       </body>
210   </html>
211   ```