微信小程序富文本编辑器 editor

逃离我推掉我的手 2021-09-08 00:28 1054阅读 0赞

[完整**微信小程序(Java后端) 技术贴**目录清单页面（必看）][Java_]

富文本编辑器，可以对图片、文字进行编辑。

编辑器导出内容支持带标签的 `html`和纯文本的 `text`，编辑器内部采用 `delta` 格式进行存储。

通过`setContents`接口设置内容时，解析插入的 `html` 可能会由于一些非法标签导致解析错误，建议开发者在小程序内使用时通过 delta 进行插入。

富文本组件内部引入了一些基本的样式使得内容可以正确的展示，开发时可以进行覆盖。需要注意的是，在其它组件或环境中使用富文本组件导出的html时，需要额外引入，并维护`<ql-container><ql-editor></ql-editor></ql-container>`的结构。

图片控件仅初始化时设置有效。

相关 api：[EditorContext][]

<table> 
 <thead> 
  <tr> 
   <th align="left">属性</th> 
   <th align="left">类型</th> 
   <th align="left">默认值</th> 
   <th align="left">必填</th> 
   <th align="left">说明</th> 
   <th align="left">最低版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">read-only</td> 
   <td align="left">boolean</td> 
   <td align="left">false</td> 
   <td align="left">否</td> 
   <td align="left">设置编辑器为只读</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">placeholder</td> 
   <td align="left">string</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">提示信息</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">show-img-size</td> 
   <td align="left">boolean</td> 
   <td align="left">false</td> 
   <td align="left">否</td> 
   <td align="left">点击图片时显示图片大小控件</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">show-img-toolbar</td> 
   <td align="left">boolean</td> 
   <td align="left">false</td> 
   <td align="left">否</td> 
   <td align="left">点击图片时显示工具栏控件</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">show-img-resize</td> 
   <td align="left">boolean</td> 
   <td align="left">false</td> 
   <td align="left">否</td> 
   <td align="left">点击图片时显示修改尺寸控件</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">bindready</td> 
   <td align="left">eventhandle</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">编辑器初始化完成时触发</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">bindfocus</td> 
   <td align="left">eventhandle</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">编辑器聚焦时触发，event.detail = {html, text, delta}</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">bindblur</td> 
   <td align="left">eventhandle</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">编辑器失去焦点时触发，detail = {html, text, delta}</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">bindinput</td> 
   <td align="left">eventhandle</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">编辑器内容改变时触发，detail = {html, text, delta}</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
  <tr> 
   <td align="left">bindstatuschange</td> 
   <td align="left">eventhandle</td> 
   <td align="left"></td> 
   <td align="left">否</td> 
   <td align="left">通过 Context 方法改变编辑器内样式时触发，返回选区已设置的样式</td> 
   <td align="left"><a href="https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html" rel="nofollow">2.7.0</a></td> 
  </tr> 
 </tbody> 
</table>

编辑器内支持部分 HTML 标签和内联样式，不支持**class**和**id**

**支持的标签**

不满足的标签会被忽略，`<div>`会被转行为`<p>`储存。

<table> 
 <thead> 
  <tr> 
   <th align="left">类型</th> 
   <th align="left">节点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">行内元素</td> 
   <td align="left"><code>&lt;span&gt; &lt;strong&gt; &lt;b&gt; &lt;ins&gt; &lt;em&gt; &lt;i&gt; &lt;u&gt; &lt;a&gt; &lt;del&gt; &lt;s&gt; &lt;sub&gt; &lt;sup&gt; &lt;img&gt;</code></td> 
  </tr> 
  <tr> 
   <td align="left">块级元素</td> 
   <td align="left"><code>&lt;p&gt; &lt;h1&gt; &lt;h2&gt; &lt;h3&gt; &lt;h4&gt; &lt;h5&gt; &lt;h6&gt; &lt;hr&gt; &lt;ol&gt; &lt;ul&gt; &lt;li&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

**支持的内联样式**

内联样式仅能设置在行内元素或块级元素上，不能同时设置。例如 `font-size` 归类为行内元素属性，在 p 标签上设置是无效的。

<table> 
 <thead> 
  <tr> 
   <th align="left">类型</th> 
   <th align="left">样式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">块级样式</td> 
   <td align="left"><code>text-align</code> <code>direction</code> <code>margin</code> <code>margin-top</code> <code>margin-left</code> <code>margin-right</code> <code>margin-bottom</code> <code>padding</code> <code>padding-top</code> <code>padding-left</code> <code>padding-right</code> <code>padding-bottom</code> <code>line-height</code> <code>text-indent</code></td> 
  </tr> 
  <tr> 
   <td align="left">行内样式</td> 
   <td align="left"><code>font</code> <code>font-size</code> <code>font-style</code> <code>font-variant</code> <code>font-weight</code> <code>font-family</code> <code>letter-spacing</code> <code>text-decoration</code> <code>color</code> <code>background-color</code></td> 
  </tr> 
 </tbody> 
</table>

**Bug & Tip**

1.  `tip`: 使用 catchtouchend 绑定事件则不会使编辑器失去焦点(2.8.3)
2.  `tip`: 插入的 html 中事件绑定会被移除
3.  `tip`: formats 中的 color 属性会统一以 hex 格式返回
4.  `tip`: 粘贴时仅纯文本内容会被拷贝进编辑器
5.  `tip`: 插入 html 到编辑器内时，编辑器会删除一些不必要的标签，以保证内容的统一。例如`<p><span>xxx</span></p>`会改写为`<p>xxx</p>`
6.  `tip`: 编辑器聚焦时页面会被上推，系统行为以保证编辑区可见

**示例代码**

[在开发者工具中预览效果][Link 1]

editor.wxml

<view class="container" style="height:{ { editorHeight}}px;">
      <editor id="editor" class="ql-container" placeholder="{ {placeholder}}" bindstatuschange="onStatusChange" bindready="onEditorReady">
      </editor>
    </view>
    
    <view class="toolbar" catchtouchend="format" hidden="{ {keyboardHeight > 0 ? false : true}}" style="bottom: { { isIOS ? keyboardHeight : 0}}px">
      <i class="iconfont icon-charutupian" catchtouchend="insertImage"></i>
      <i class="iconfont icon-format-header-2 { {formats.header === 2 ? 'ql-active' : ''}}" data-name="header" data-value="{ {2}}"></i>
      <i class="iconfont icon-format-header-3 { {formats.header === 3 ? 'ql-active' : ''}}" data-name="header" data-value="{ {3}}"></i>
      <i class="iconfont icon-zitijiacu { {formats.bold ? 'ql-active' : ''}}" data-name="bold"></i>
      <i class="iconfont icon-zitixieti { {formats.italic ? 'ql-active' : ''}}" data-name="italic"></i>
      <i class="iconfont icon-zitixiahuaxian { {formats.underline ? 'ql-active' : ''}}" data-name="underline"></i>
      <i class="iconfont icon--checklist" data-name="list" data-value="check"></i>
      <i class="iconfont icon-youxupailie { {formats.list === 'ordered' ? 'ql-active' : ''}}" data-name="list" data-value="ordered"></i>
      <i class="iconfont icon-wuxupailie { {formats.list === 'bullet' ? 'ql-active' : ''}}" data-name="list" data-value="bullet"></i>
    </view>

editor.js

Page({ 
      data: { 
        formats: { },
        readOnly: false,
        placeholder: '开始输入...',
        editorHeight: 300,
        keyboardHeight: 0,
        isIOS: false
      },
      readOnlyChange() { 
        this.setData({ 
          readOnly: !this.data.readOnly
        })
      },
      onLoad() { 
        const platform = wx.getSystemInfoSync().platform
        const isIOS = platform === 'ios'
        this.setData({  isIOS})
        const that = this
        this.updatePosition(0)
        let keyboardHeight = 0
        wx.onKeyboardHeightChange(res => { 
          if (res.height === keyboardHeight) return
          const duration = res.height > 0 ? res.duration * 1000 : 0
          keyboardHeight = res.height
          setTimeout(() => { 
            wx.pageScrollTo({ 
              scrollTop: 0,
              success() { 
                that.updatePosition(keyboardHeight)
                that.editorCtx.scrollIntoView()
              }
            })
          }, duration)
    
        })
      },
      updatePosition(keyboardHeight) { 
        const toolbarHeight = 50
        const {  windowHeight, platform } = wx.getSystemInfoSync()
        let editorHeight = keyboardHeight > 0 ? (windowHeight - keyboardHeight - toolbarHeight) : windowHeight
        this.setData({  editorHeight, keyboardHeight })
      },
      calNavigationBarAndStatusBar() { 
        const systemInfo = wx.getSystemInfoSync()
        const {  statusBarHeight, platform } = systemInfo
        const isIOS = platform === 'ios'
        const navigationBarHeight = isIOS ? 44 : 48
        return statusBarHeight + navigationBarHeight
      },
      onEditorReady() { 
        const that = this
        wx.createSelectorQuery().select('#editor').context(function (res) { 
          that.editorCtx = res.context
        }).exec()
      },
      blur() { 
        this.editorCtx.blur()
      },
      format(e) { 
        let {  name, value } = e.target.dataset
        if (!name) return
        // console.log('format', name, value)
        this.editorCtx.format(name, value)
    
      },
      onStatusChange(e) { 
        const formats = e.detail
        this.setData({  formats })
      },
      insertDivider() { 
        this.editorCtx.insertDivider({ 
          success: function () { 
            console.log('insert divider success')
          }
        })
      },
      clear() { 
        this.editorCtx.clear({ 
          success: function (res) { 
            console.log("clear success")
          }
        })
      },
      removeFormat() { 
        this.editorCtx.removeFormat()
      },
      insertDate() { 
        const date = new Date()
        const formatDate = `${ date.getFullYear()}/${ date.getMonth() + 1}/${ date.getDate()}`
        this.editorCtx.insertText({ 
          text: formatDate
        })
      },
      insertImage() { 
        const that = this
        wx.chooseImage({ 
          count: 1,
          success: function (res) { 
            that.editorCtx.insertImage({ 
              src: res.tempFilePaths[0],
              data: { 
                id: 'abcd',
                role: 'god'
              },
              width: '80%',
              success: function () { 
                console.log('insert image success')
              }
            })
          }
        })
      }
    })

editor.json

{ 
      "navigationBarTitleText": "发表文章",
      "disableScroll": true
    }

editor.wxss

@import "../common/lib/weui.wxss";
    @import "./assets/iconfont.wxss"
    
    .container {
      position: absolute; 
      top: 0; 
      left: 0; 
      width: 100%;
    }
    
    .ql-container {
      box-sizing: border-box;
      width: 100%;
      height: 100%;
      font-size: 16px;
      line-height: 1.5;
      overflow: auto;
      padding: 10px 10px 20px 10px;
      border: 1px solid #ECECEC;
    }
    
    .ql-active {
      color: #22C704;
    }
    
    .iconfont {
      display: inline-block;
      width: 30px;
      height: 30px;
      cursor: pointer;
      font-size: 20px;
    }
    
    .toolbar {
      box-sizing: border-box;
      padding: 0 10px;
      height: 50px;
      width: 100%;
      position: fixed;
      left: 0;
      right: 100%;
      bottom: 0;
      display: flex;
      align-items: center;
      justify-content: space-between;
      border: 1px solid #ECECEC;
      border-left: none;
      border-right: none;
    }

运行效果（请用真机调试）：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tAue7eNg-1622196446094)(image-20210528104114369.png)\]][img-tAue7eNg-1622196446094_image-20210528104114369.png]

> 微信搜一搜【java1234】关注这个放荡不羁的程序员，关注后回复【资料】有我准备的一线大厂笔试面试资料以及简历模板。

[Java_]: https://blog.csdn.net/caoli201314/article/details/116643190
[EditorContext]: https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.html
[Link 1]: https://developers.weixin.qq.com/s/W7uZ3EmU7jbl
[img-tAue7eNg-1622196446094_image-20210528104114369.png]: /images/20210716/0f0f3d57eac74f8491f5666fa67fdbff.png