::: sourceCode ## rich-text > issues: https://issues.dcloud.net.cn/?mid=component.basic-content.rich-text > 源码: https://github.com/dcloudio/uni-app/tree/uni-app-x-alpha/src/uni_modules/uni-rich-text/components/rich-text ::: > 组件类型:UniRichTextElement 富文本。可渲染文字样式、图片、超链接。支持部分HTML标签 以往开发者在app平台渲染富文本,大多使用webview。但webview启动慢、快滚白屏,在部分设备上被限死刷新率不能超过60帧。 虽然uni-app x的rich-text组件也支持mode=web,但在app平台蒸汽模式下,提供了c语言全新实现的rich-text mode=native。 uni-app x 蒸汽模式的rich-text native,应该是业内最佳的富文本呈现的解决方案。可以瞬间加载5万字长文、多图混排,流畅的快速滚动,不白屏、不掉帧。[详见评测](../app-vapor.md#rich-text)。 ### 兼容性 Web: 4.0; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: 3.9; iOS: 4.11; HarmonyOS: 4.61 ### 支持的HTML标签和属性 |HTML |属性 |样式 | |-------|-------|-------| |br | | | |p | |text-align color background-color text-decoration| |ul | | | |li | |text-align color background-color text-decoration| |span | |color background-color text-decoration| |strong | | | |i | | | |big | | | |small | | | |a |href | | |u | | | |del | | | |h1-h6 | | | |img |src | | > text-decoration仅支持line-through > 仅在 app-android 平台 VDOM 模式下且配置 mode=native 时受上述表格限制 ### 属性 | 名称 | 类型 | 默认值 | 兼容性 | 描述 | | :- | :- | :- | :-: | :- | | nodes | any | | Web: 4.0; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: 3.9; iOS: 4.11; HarmonyOS: 4.61 | 节点列表/HTML String | | mode | string | "web" | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.71; iOS: 4.11; HarmonyOS: 4.61 | 渲染模式 | | space | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: x; iOS: x; HarmonyOS: x | *(string)*
显示连续空格 | | user-select | boolean | false | Web: 5.25; 微信小程序: 4.41; 支付宝小程序: x; Android(VDOM): 3.9; Android(Vapor): 5.25; iOS(VDOM): 4.11; iOS(Vapor): 5.25; HarmonyOS(VDOM): 4.61; HarmonyOS(Vapor): 5.25 | 文本是否可选,该属性会使节点显示为 block | | selection-handle-color | string | "#4285F4FF" | 微信小程序: x; 支付宝小程序: x; Android(VDOM): x; Android(Vapor): 5.21; iOS(VDOM): x; iOS(Vapor): 5.22; HarmonyOS: x | 选择区域高亮手柄颜色 | | selection-background-color | string | "#33B5E566" | 微信小程序: x; 支付宝小程序: x; Android(VDOM): x; Android(Vapor): 5.21; iOS(VDOM): x; iOS(Vapor): 5.22; HarmonyOS: x | 选择区域高亮背景颜色 | | @itemclick | (event: [UniRichTextItemClickEvent](#unirichtextitemclickevent)) => void | | Web: 4.0; 微信小程序: x; 支付宝小程序: x; Android: 3.9; iOS: 4.11; HarmonyOS: 4.71 | 内容点击事件 | | ~~selectable~~ | boolean | false | Web: 5.24; 微信小程序: 4.41; 支付宝小程序: x; Android: 3.9; iOS: 4.11; HarmonyOS: 4.61 | 文本是否可选。已废弃,请使用 user-select | #### mode 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | web | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.71; iOS: 4.11; HarmonyOS: 4.61 | 使用webview渲染 | | native | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.71; iOS(VDOM): x; iOS(Vapor): 5.21; HarmonyOS(VDOM): x; HarmonyOS(Vapor): 5.0 | 使用原生渲染 | #### space 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | ensp | Web: x; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: x; iOS: x; HarmonyOS: x | 中文字符空格一半大小 | | emsp | Web: x; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: x; iOS: x; HarmonyOS: x | 中文字符空格大小 | | nbsp | Web: x; 微信小程序: 4.41; 支付宝小程序: 5.31; Android: x; iOS: x; HarmonyOS: x | 根据字体设置的空格大小 | ### 节点列表数据结构 ``` json { name: "p", // 标签名 attrs: { style: "color: red;" // 样式 }, children: [ // 子节点 { text: "hello uni-app x" // 文本节点 }, { name: "img", // img 标签 attrs: { src: "https://web-ext-storage.dcloud.net.cn/uni-app-x/logo.ico", width: "100", height: "100" } }, { name: "a", // a 标签 attrs: { href: "https://www.dcloud.io" } } ] } ``` ### 事件 #### UniRichTextItemClickEvent ```mermaid graph LR UniRichTextItemClickEvent -- Extends --> UniEvent style UniEvent color:#42b983 click UniEvent "https://doc.dcloud.net.cn/uni-app-x/component/common.html#unievent" ``` ##### UniRichTextItemClickEvent 的属性值 | 名称 | 类型 | 必填 | | :- | :- | :- | | detail | **UniRichTextItemClickEventDetail** | 是 | #### detail 的属性描述 | 名称 | 类型 | 必备 | 描述 | | :- | :- | :- | :- | | src | string | 否 | \图片链接 | | href | string | 否 | \超链接 | ### 子组件 @children-tags 不可以嵌套组件 ### 示例 示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/component/rich-text/rich-text.uvue),与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/component/rich-text/rich-text.uvue) ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/rich-text/rich-text > appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/component/rich-text/rich-text >示例 ```vue ``` ::: ### 参见 - [参见uni-app相关文档](https://uniapp.dcloud.io/component/rich-text.html) ## rich-text的mode介绍 rich-text组件,在web和小程序本身就是webview渲染的。在app平台,有2种mode,web和native。 - web模式:每个rich-text都使用一个web-view来渲染内容。初始化速度略慢,页面中有多个rich-text组件就意味着有多个web-view,会很卡。 - native模式:在app蒸汽模式下使用c语言自绘。它的流畅度无与伦比,可以瞬间加载5万字长文多图混排、流畅的快速滚动不白屏不掉帧。[详见评测](../app-vapor.md#rich-text)。 但是它的模块体积较大,每个cpu类型需要8M的so库。 - 原生markdown渲染:官方提供了markdown解析,动态拼接原生组件的方案,在[uni-ai x开源项目](https://ext.dcloud.net.cn/plugin?id=23902)中可以体验 ## 全局样式 rich-text组件的style或class中,支持如下几个css属性,用于设置全局样式。全局样式优先级低于rich-text内容中的样式设置。 - font-size - font-family - line-height - color App平台需HBuilderX5.21+ ## 调整历史@change 在4.7版以前,Android是kotlin实现的rich-text,但与web规范拉齐度较低;iOS使用的是web-view;鸿蒙使用的是系统的rich-text,但该rich-text也是基于web-view实现且有细节问题。 从uni-app x4.7+,3个App平台统一使用web-view实现。鸿蒙平台直接替换了之前的实现,而Android平台则新增了mode属性配置,默认是web-view实现,但也可以通过mode=native继续使用之前的原生kotlin方式。 App平台从蒸汽模式开始,新增了c语言实现的 rich-text。3个App平台均支持 mode 属性配置,默认是 `web-view` 实现,可以通过设置 `mode=native` 使用原生方式。Android蒸汽模式的rich-text mode native,也从kotlin实现统一改为更快的c语言实现。 ## Bug & Tips@tips - rich-text不支持video组件,如果涉及video,需拆分文本内容,在video前后各放置一个rich-text组件 - 小程序的rich-text功能要弱一些,不支持rich-text中子内容的点击事件,如有这类需求,在小程序平台需要条件编译使用[mp-html](https://ext.dcloud.net.cn/search?q=mp-html) - App-Android 平台 vdom模式 且 mode=native 时,HTML String 类型的``不支持自定义宽高,默认以 rich-text 组件宽度为基准等比缩放;节点列表类型的``支持自定义宽高。