2.2.1 • Published 4 years ago
wp-html-to-view v2.2.1
mp-html
一个强大的小程序富文本组件
功能介绍
- 支持在多个主流的小程序平台和
uni-app中使用 - 支持丰富的标签(包括
table、video、svg等) - 支持丰富的事件效果(自动预览图片、链接处理等)
- 支持设置占位图(加载中、出错时、预览时)
- 支持锚点跳转、长按复制等丰富功能
- 支持大部分 html 实体
- 丰富的插件(关键词搜索、内容 编辑 等)
- 效率高、容错性强且轻量化(
≈25KB,9KB gzipped)
查看 功能介绍 了解更多
使用方法
原生平台
npm方式在项目目录下安装组件包
npm install mp-html开发者工具中勾选
使用 npm 模块并点击工具 - 构建 npm在需要使用页面的
json文件中添加{ "usingComponents": { "mp-html": "mp-html" } }在需要使用页面的
wxml文件中添加<mp-html content="{{html}}" />在需要使用页面的
js文件中添加Page({ onLoad () { this.setData({ html: '<div>Hello World!</div>' }) } })
源码方式
- 将源码中对应平台的代码包(
dist/platform)拷贝到components目录下,更名为mp-html 在需要使用页面的
json文件中添加{ "usingComponents": { "mp-html": "/components/mp-html/index" } }
后续步骤同上
- 将源码中对应平台的代码包(
查看 快速开始 了解更多
uni-app
源码方式
- 将源码中
dist/uni-app内的内容拷贝到项目根目录下
可以直接通过 插件市场 引入 在需要使用页面的
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方式在项目目录下安装组件包
npm install mp-html在需要使用页面的
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目录下,否则无法运行
查看 快速开始 了解更多
组件属性
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| container-style | String | 容器的样式(2.1.0+) | |
| content | String | 用于渲染的 html 字符串 | |
| copy-link | Boolean | true | 是否允许外部链接被点击时自动复制 |
| domain | String | 主域名(用于链接拼接) | |
| error-img | String | 图片出错时的占位图链接 | |
| lazy-load | Boolean | false | 是否开启图片懒加载 |
| loading-img | String | 图片加载过程中的占位图链接 | |
| pause-video | Boolean | true | 是否在播放一个视频时自动暂停其他视频 |
| preview-img | Boolean | true | 是否允许图片被点击时自动预览 |
| scroll-table | Boolean | false | 是否给每个表格添加一个滚动层使其能单独横向滚动 |
| selectable | Boolean | false | 是否开启文本长按复制 |
| set-title | Boolean | true | 是否将 title 标签的内容设置到页面标题 |
| show-img-menu | Boolean | true | 是否允许图片被长按时显示菜单 |
| tag-style | Object | 设置标签的默认样式 | |
| use-anchor | Boolean | false | 是否使用锚点链接 |
查看 属性 了解更多
组件事件
| 名称 | 触发时机 |
|---|---|
| load | dom 树加载完毕时 |
| ready | 图片加载完毕时 |
| error | 发生渲染错误时 |
| imgtap | 图片被点击时 |
| linktap | 链接被点击时 |
查看 事件 了解更多
api
组件实例上提供了一些 api 方法可供调用
| 名称 | 作用 |
|---|---|
| in | 将锚点跳转的范围限定在一个 scroll-view 内 |
| navigateTo | 锚点跳转 |
| getText | 获取文本内容 |
| getRect | 获取富文本内容的位置和大小 |
| setContent | 设置富文本内容 |
| imgList | 获取所有图片的数组 |
查看 api 了解更多
插件扩展
除基本功能外,本组件还提供了丰富的扩展,可按照需要选用
| 名称 | 作用 |
|---|---|
| audio | 音乐播放器 |
| editable | 富文本编辑 |
| emoji | 解析 emoji |
| highlight | 代码块高亮显示 |
| markdown | 渲染 markdown |
| search | 关键词搜索 |
| style | 匹配 style 标签中的样式 |
| txv-video | 使用腾讯视频 |
| img-cache | 图片缓存 by @PentaTea |
查看 插件 了解更多
使用案例
| 官方示例 | 欢喜商城 | 多么生活 | 全品作业小助手 | 米兔旅行 | 食法查 |
|---|---|---|---|---|---|
![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
| 微慕 | 古典文学名著阅读 | 程序员技术之旅 | 典典博客 | Geek 时代 | 源创智造 |
|---|---|---|---|---|---|
![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
| 备忘录与记事本 | 优秀笔记 | 365 刷题 | 同城共享书 | 技术源 share | 周仙神 |
|---|---|---|---|---|---|
![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
以上排名不分先后,更多可见 使用案例收集(欢迎添加)
许可与支持
许可
您可以免费的使用(包括商用)、复制或修改本组件 MIT License
不可用于任何违法用途
在用于生产环境前务必经过充分测试,由插件bug带来的损失概不负责(可以自行修改源码)支持
更新日志
v2.2.1 (20211224)
v2.2.0 (20211011)
A增加customElements配置项,便于添加自定义功能性标签 详细Aeditable插件增加切换音视频自动播放状态的功能 详细 by @leeseettAeditable插件删除媒体标签时触发remove事件,便于删除已上传的文件Ueditable插件insertImg方法支持同时插入多张图片 详细Ueditable插入图片和音视频时支持拼接domian主域名F修复了内部链接参数中包含://时被认为是外部链接的问题 详细F修复了部分svg标签名或属性名大小写不正确时不生效的问题 详细F修复了uni-app包nvue页面运行到非app平台时可能样式错误的问题D移除了ad配置项(由customElements代替)
从
1.x的升级方法可见 更新指南
查看 更新日志 了解更多
2.2.1
4 years ago

















