From 7be353fbd745a1ff7944ed63820a623a14958bd6 Mon Sep 17 00:00:00 2001 From: qiang Date: Wed, 29 Sep 2021 11:20:54 +0800 Subject: [PATCH] docs: update rich-text --- docs/component/rich-text.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/docs/component/rich-text.md b/docs/component/rich-text.md index f0272ce10..9e717ac84 100644 --- a/docs/component/rich-text.md +++ b/docs/component/rich-text.md @@ -1,29 +1,24 @@ #### rich-text + 富文本。 +支持默认事件,包括:click、touchstart、touchmove、touchcancel、touchend、longpress。 + **属性说明** |属性名|类型|默认值|说明|平台兼容| |:-|:-|:-|:-|:-| |nodes|Array / String|[]|节点列表 / HTML String|| -|space|string||显示连续空格|微信基础库2.4.1+[详见](https://developers.weixin.qq.com/miniprogram/dev/component/rich-text.html)、QQ小程序、快手小程序[详见](https://mp.kuaishou.com/docs/develop/components/basicComponents/richText.html)| -|selectable|Boolean|false|富文本是否可以长按选中,可用于复制,粘贴等场景|百度小程序(真机)| - -**注意** - -- app-nvue 平台 nodes 属性只支持使用 Array 类型 - -- 支付宝小程序 nodes 属性只支持使用 Array 类型。 - -如果需要支持 HTML String,则需要自己将 HTML String转化为 nodes 数组,可使用 [html-parser](https://github.com/dcloudio/hello-uniapp/blob/master/common/html-parser.js) 转换。 - -支持默认事件,包括:click、touchstart、touchmove、touchcancel、touchend、longpress。 - -**nodes 属性推荐使用 Array 类型,由于组件会将 String 类型转换为 Array 类型,因而性能会有所下降。** +|space|string||显示连续空格|App、H5、微信基础库2.4.1+[详见](https://developers.weixin.qq.com/miniprogram/dev/component/rich-text.html)、QQ小程序、字节小程序、快手小程序[详见](https://mp.kuaishou.com/docs/develop/components/basicComponents/richText.html)| +|selectable|Boolean|true|富文本是否可以长按选中,可用于复制,粘贴等场景|百度小程序(仅真机支持,基础库 3.150.1 以下版本默认为 false)| +|image-menu-prevent|Boolean|false|阻止长按图片时弹起默认菜单(将该属性设置为image-menu-prevent或image-menu-prevent="true"),只在初始化时有效,不能动态变更;若不想阻止弹起默认菜单,则不需要设置此属性|百度小程序| +|preview|Boolean||富文本中的图片是否可点击预览。在不设置的情况下,若 rich-text 未监听点击事件,则默认开启。未显示设置 preview 时会进行点击默认预览判断,建议显示设置 preview|百度小程序| ##### nodes -现支持两种节点,通过 type 来区分,分别是元素节点和文本节点,默认是元素节点,在富文本区域里显示的 HTML 节点。 +nodes 值为 HTML String 时,在组件内部将自动解析为节点列表,推荐直接使用 Array 类型避免内部转换导致的性能下降。App-nvue 和支付宝小程序不支持 HTML String 方式,仅支持直接使用节点列表即 Array 类型,如要使用 HTML String,则需自己将 HTML String 转化为 nodes 数组,可使用 [html-parser](https://github.com/dcloudio/hello-uniapp/blob/master/common/html-parser.js) 转换。 + +节点列表内的节点现支持两种类型,通过 type 来区分,分别是元素节点和文本节点,默认是元素节点,在富文本区域里显示的 HTML 节点。 **元素节点:type = node** @@ -41,7 +36,7 @@ ##### 受信任的HTML节点及属性 -全局支持class和style属性,**不支持id属性**。 +全局支持 class 和 style 属性,**不支持 id 属性**。 |节点|属性| |:-|:-| @@ -146,5 +141,5 @@ export default { - attrs 属性不支持 id ,支持 class 。 - name 属性大小写不敏感。 - 如果使用了不受信任的HTML节点,该节点及其所有子节点将会被移除。 -- img 标签仅支持网络图片。 +- 非 App 平台 img 标签仅支持网络图片。 - 如果在自定义组件中使用 rich-text 组件,那么仅自定义组件的 css 样式对 rich-text 中的 class 生效。 -- GitLab