mp-html

一个强大的小程序富文本组件

功能介绍

• 支持在多个主流的小程序平台和 uni-app 中使用
• 支持丰富的标签（包括 table、video、svg 等）
• 支持丰富的事件效果（自动预览图片、链接处理等）
• 支持设置占位图（加载中、出错时、预览时）
• 支持锚点跳转、长按复制等丰富功能
• 支持大部分 html 实体
• 丰富的插件（关键词搜索、内容 编辑 等）
• 效率高、容错性强且轻量化（≈25KB，9KB gzipped）

查看 功能介绍 了解更多

使用方法

原生平台

• npm 方式

  1. 在项目目录下安装组件包

     npm install mp-html

  2. 开发者工具中勾选 使用 npm 模块 并点击 工具 - 构建 npm

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

     {
       "usingComponents": {
         "mp-html": "mp-html"
       }
     }

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

     <mp-html content="{{html}}" />

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

     Page({
       onLoad () {
         this.setData({
           html: '<div>Hello World!</div>'
         })
       }
     })

• 源码方式

  1. 将源码中对应平台的代码包（dist/platform）拷贝到 components 目录下，更名为 mp-html

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

     {
       "usingComponents": {
         "mp-html": "/components/mp-html/index"
       }
     }

  后续步骤同上

查看 快速开始 了解更多

uni-app

• 源码方式

  1. 将源码中 dist/uni-app 内的内容拷贝到项目根目录下
     可以直接通过 插件市场 引入

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

     <template>
       <view>
         <mp-html :content="html" />
       </view>
     </template>
     <script>
       import mpHtml from '@/components/mp-html/mp-html'
       export default {
         // HBuilderX 2.5.5+ 可以通过 easycom 自动引入
         components: {
           mpHtml
         },
         data () {
           return {
             html: '<div>Hello World!</div>'
           }
         }
       }
     </script>

• npm 方式

  1. 在项目目录下安装组件包

     npm install mp-html

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

     <template>
       <view>
         <mp-html :content="html" />
       </view>
     </template>
     <script>
       import mpHtml from 'mp-html/dist/uni-app/components/mp-html/mp-html'
       export default {
         // 不可省略
         components: {
           mpHtml
         },
         data () {
           return {
             html: '<div>Hello World!</div>'
           }
         }
       }
     </script>

  使用 cli 方式运行的项目，通过 npm 方式引入时，需要在 vue.config.js 中配置 transpileDependencies，详情可见 #330
  如果在 nvue 中使用还要将 dist/uni-app/static 目录下的内容拷贝到项目的 static 目录下，否则无法运行

查看 快速开始 了解更多

组件属性

查看 属性 了解更多

组件事件

查看 事件 了解更多

api

组件实例上提供了一些 api 方法可供调用

查看 api 了解更多

插件扩展

除基本功能外，本组件还提供了丰富的扩展，可按照需要选用

查看 插件 了解更多

使用案例

官方示例	欢喜商城	多么生活	全品作业小助手	米兔旅行	食法查

微慕	古典文学名著阅读	程序员技术之旅	典典博客	APP 比比	Geek 时代

源创智造	备忘录与记事本	优秀笔记	365 刷题	同城共享书	技术源 share

以上排名不分先后，更多可见 使用案例收集（欢迎添加）

许可与支持

• 许可
  您可以免费的使用（包括商用）、复制或修改本组件 MIT License
  不可用于任何违法用途
  在用于生产环境前务必经过充分测试，由插件 bug 带来的损失概不负责（可以自行修改源码）

• 支持
  

更新日志

• v2.2.0 (20211011)

  1. A 增加 customElements 配置项，便于添加自定义功能性标签 详细
  2. A editable 插件增加切换音视频自动播放状态的功能 详细 by @leeseett
  3. A editable 插件删除媒体标签时触发 remove 事件，便于删除已上传的文件
  4. U editable 插件 insertImg 方法支持同时插入多张图片 详细
  5. U editable 插入图片和音视频时支持拼接 domian 主域名
  6. F 修复了内部链接参数中包含 :// 时被认为是外部链接的问题 详细
  7. F 修复了部分 svg 标签名或属性名大小写不正确时不生效的问题 详细
  8. F 修复了 uni-app 包 nvue 页面运行到非 app 平台时可能样式错误的问题
  9. D 移除了 ad 配置项（由 customElements 代替）

• v2.1.5 (20210813)

  1. A 增加支持标签的 dir 属性
  2. F 修复了 ruby 标签文字与拼音没有居中对齐的问题 详细
  3. F 修复了音视频标签内有 a 标签时可能无法播放的问题
  4. F 修复了 externStyle 中的 class 名包含下划线或数字时可能失效的问题 详细
  5. F 修复了 uni-app 包 h5 端引入 externStyle 可能不生效的问题 详细
  6. F 修复了微信原生包 a 标签的 style 中包含 inline 时不响应事件的问题 详细

  从 1.x 的升级方法可见 更新指南

查看 更新日志 了解更多