yxfreeman / parser

小程序富文本插件（html 渲染），支持微信、QQ、百度、支付宝、头条、uni-app

Parser

小程序富文本插件，详见 文档

编辑器内测

欢迎测试配套编辑器：
微信原生框架：点击 代码片段 即可在微信开发者工具中打开
uni-app：下载 测试项目 到 HBuilder X 中即可试用
若发现问题或有改进建议可以通过 问卷 反馈

功能简介

• 支持匹配 style 中的样式
• 支持 svg
• 支持锚点跳转
• 支持设置占位图
• 支持设置高清预览图
• 支持长按复制内容
• 支持给多媒体标签设置多个源
• 支持自动给链接填充主域名
• 支持几乎所有的 html 标签
• 支持丰富的事件和效果
• 轻量化、效率高、容错性强
• 支持多平台（微信、QQ、百度、支付宝、头条、uni-app 等）
  ...

更多功能可见：功能介绍

使用方法

插件包说明

名称	大小	使用
parser	42.7KB	微信小程序插件包
parser.min	26.8KB	微信小程序插件包压缩版（功能相同）
parser.qq	42.2KB	QQ 小程序插件包
parser.bd	40.6KB	百度小程序插件包
parser.my	41.0KB	支付宝小程序插件包
parser.tt	41.5KB	头条小程序插件包
parser.uni	60.0KB	uni-app 插件包（可以编译到所有平台）

在原生框架中使用

• 源码引入

  1. 复制 parser 文件夹至 components 目录

  2. 在需要使用页面的 json 文件中添加

     {
       "usingComponents": {
         "parser":"/components/parser/parser"
       }
     }

  3. 在需要使用页面的 wxml 文件中添加

     <parser html="{{html}}" />

  4. 在需要使用页面的 js 文件中添加

     data: {
       html:"<div>Hello World!</div>"
     }

• npm 引入（仅限微信，需要基础库 2.1.1 以上）

  1. 在小程序目录下执行

     npm install parser-wx

  2. 勾选使用 npm 模块，并点击工具-构建 npm

  3. 在需要使用页面的 json 文件中添加

     {
       "usingComponents": {
         "parser":"parser-wx"
       }
     }

     后续步骤同上

• demo/wx 文件夹下的是微信小程序 富文本插件 示例程序的源码，可供参考

在 uni-app 中使用

1. 复制 parser.uni 包到 components 目录下（更名为 jyf-parser）

2. 在需要使用页面的 vue 文件中添加

   <template>
     <view>
       <jyf-parser :html="html"></jyf-parser>
     </view>
   </template>
   <script>
   import parser from "@/components/jyf-parser/jyf-parser"; // HBuilderX 2.5.5 及以上可以不需要引入
   export default {
     // HBuilderX 2.5.5 及以上可以不需要引入
     components: {
       "jyf-parser": parser
     },
     data() {
       return {
         html: '<div>Hello World!</div>'
       }
     }
   }
   </script>

• 可以直接通过 插件市场 引入
• demo/uni-app 文件夹下是一个示例程序，可供参考

其他框架中使用可见：在其他框架中使用

组件属性

属性	类型	默认值	说明
html	String		要显示的 html 字符串
autopause	Boolean	true	是否允许播放视频时自动暂停其他视频
autoscroll	Boolean	false	是否自动给 table 加一个滚动层（使表格可以单独滚动）
autosetTitle	Boolean	true	是否自动将 title 标签的内容设置到页面标题
compress	Number	0	压缩等级，可以选择是否移除 id 和 class
domain	String		主域名，设置后将给链接自动拼接主域名或协议名
lazy-load	Boolean	false	是否开启图片懒加载
loading-img	String		图片加载完成前的占位图，详见 占位图
selectable	Boolean	false	是否允许长按复制内容
show-with-animation	Boolean	false	是否使用渐显动画
tag-style	Object		设置标签的默认样式
use-anchor	Boolean	false	是否使用页面内锚点
use-cache	Boolean	false	是否使用缓存，设置后多次打开不用重复解析

详细可见：组件属性

事件

名称	功能	说明
bindparse	解析完成时触发	返回解析结果，可以对该结果进行自定义修改，将在渲染时生效
bindload	dom 加载完成时触发	所有节点被添加到节点树中时触发，无返回值，可以调用 api
bindready	渲染完成时触发	返回 boundingClientRect 的查询结果（包含宽高、位置等信息），所有图片（除懒加载）加载完成时才会触发，图片较大时可能 延时较长
binderror	出错时触发	返回一个 object，其中 source 是错误来源，errMsg 为错误信息，target 包含出错标签的具体信息
bindimgtap	图片被点击时触发	返回一个 object，其中 src 是图片链接，ignore 是一个函数，在回调函数中调用将不进行预览
bindlinkpress	链接被点击时触发	返回一个 object，其中 href 是链接地址，ignore 是一个函数，在回调中调用将不自动跳转/复制

详细可见：事件

使用外部样式

如果需要使用一些固定的样式，可以通过 wxss / css 文件引入
在 parser/trees/trees.wxss(css) 中通过 @import 引入自定义的样式文件即可

/*
* parser/trees/trees.wxss(css)
* 在这里引入您的自定义样式
*/
@import "external.wxss(css)";

更多信息可见：使用方法

扩展包

patches 文件夹中准备了一些扩展包，可根据需要选用，可以实现更加丰富的功能
具体信息见：扩展包

案例体验

富文本插件	程序员技术之旅	极客时代	APP 比比	全品作业小助手	多么生活

欢喜商城	古典文学名著阅读	典典博客	咚咚阅读	源创智造	米兔旅行

以上排名不分先后，更多可见：链接（欢迎添加）

相关项目：
EastWorld/wechat-app-mall
YanxinNet/uView
zhangdaren/miniprogram-to-uniapp
woniudiancang/bee

许可与支持

• 许可
  您可以随意的使用和分享本插件 MIT License
  不可用于任何违法用途
  在用于生产环境前务必经过充分测试，由插件 bug 带来的损失概不负责（可以自行修改源码）

• 支持
  

更新日志

• 2020.10.29

  1. U 文档同步到码云 详细
  2. U 图片和链接的点击事件不冒泡，内部和整体的点击可以独立处理 详细
  3. U uni-app 包支持使用 search 扩展包
  4. F 修复了 uni-app 包 H5 端 domain 属性可能导致 dataUrl 无法显示和无法对音视频生效的问题
  5. F 修复了微信 PC 端可能出现不必要的滚动条的问题 详细

• 2020.10.14

  1. U 通过 grid 布局实现含有合并单元格的表格中链接的点击 详细
  2. F 修复了 table 标签的 align 属性表现不正确的问题 详细
  3. F 修复了部分情况下 svg 显示不正常的问题 详细
  4. F 修复了后代选择器可能导致不正确的效果的问题 详细

• 2020.8.28

  1. U img 标签支持通过 original-src 属性设置预览时的图片地址 详细
  2. F 修复了 img 标签 width 和 height 属性使用非 px 单位时没有被转为 px 的问题 详细
  3. F 修复了 uni-app 包 NVUE 端编译到安卓时若含有 % 会被转义的问题
  4. F 修复了 打包工具 未关闭前生成的文件被占用的问题

更多可见：更新日志