Web聊天工具的富文本输入框

最近折腾 Websocket，打算开发一个聊天室应用练练手。在应用开发的过程中发现可以插入 emoji ，粘贴图片的富文本输入框其实蕴含着许多有趣的知识，于是便打算记录下来和大家分享。

输入框富文本化

传统的输入框都是使用 来制作的，它的优势是非常简单，但***的缺陷却是无法展示图片。为了能够让输入框能够展示图片（富文本化），我们可以采用设置了 contenteditable="true" 属性的 <div> 来实现这里面的功能。</p><p>简单创建一个 index.html 文件，然后写入如下内容：</p><pre> <ol> <li><div class="editor" contenteditable="true">  </li> <li>  <img src="https://static.easyicon.net/preview/121/1214124.gif" alt="">  </li> <li></div> </li> </ol></pre><p>打开浏览器，就能看到一个默认已经带了一张图片的输入框：</p><p><p>光标可以在图片前后移动，同时也可以输入内容，甚至通过退格键删除这张图片——换句话说，图片也是可编辑内容的一部分，也意味着输入框的富文本化已经体现出来了。</p><p>接下来的任务，就是思考如何直接通过 control + v 把图片粘贴进去了。</p><p><strong>处理粘贴事件</strong></p><p>任何通过“复制”或者 control + c 所复制的内容（包括屏幕截图）都会储存在剪贴板，在粘贴的时候可以在输入框的 onpaste 事件里面监听到。</p><pre> <ol> <li><div class="editor" contenteditable="true">  </li> <li>  <img src="https://static.easyicon.net/preview/121/1214124.gif" alt="">  </li> <li></div> </li> </ol></pre><p>而剪贴板的的内容则存放在 DataTransferItemList 对象中，可以通过 e.clipboardData.items 访问到：</p><p><p>细心的读者会发现，如果直接在控制台点开 DataTransferItemList 前的小箭头，会发现对象的 length 属性为0。说好的剪贴板内容呢？其实这是 Chrome 调试的一个小坑。在开发者工具里面，console.log 出来的对象是一个引用，会随着原始数据的改变而改变。由于剪贴板的数据已经被“粘贴”进输入框了，所以展开小箭头以后看到的 DataTransferItemList 就变成空的了。为此，我们可以改用 console.table 来展示实时的结果。</p><p><p>在明白了剪贴板数据的存放位置以后，就可以编写代码来处理它们了。由于我们的富文本输入框比较简单，所以只需要处理两类数据即可，其一是普通的文本类型数据，包括 emoji 表情；其二则是图片类型数据。</p><p>新建 paste.js 文件：</p><pre> <ol> <li>const onPaste = (e) => {  </li> <li>  // 如果剪贴板没有数据则直接返回  </li> <li>  if (!(e.clipboardData && e.clipboardData.items)) {  </li> <li>    return  </li> <li>  }  </li> <li>  // 用Promise封装便于将来使用  </li> <li>  return new Promise((resolve, reject) => {  </li> <li>    // 复制的内容在剪贴板里位置不确定，所以通过遍历来保证数据准确  </li> <li>    for (let i = 0, len = e.clipboardData.items.length; i < len; i++) {  </li> <li>      const item = e.clipboardData.items[i]  </li> <li>      // 文本格式内容处理  </li> <li>      if (item.kind === 'string') {  </li> <li>        item.getAsString((str) => {  </li> <li>          resolve(str)  </li> <li>        })  </li> <li>      // 图片格式内容处理  </li> <li>      } else if (item.kind === 'file') {  </li> <li>        const pasteFile = item.getAsFile()  </li> <li>        // 处理pasteFile  </li> <li>        // TODO(pasteFile)  </li> <li>      } else {  </li> <li>        reject(new Error('Not allow to paste this type!'))  </li> <li>      }  </li> <li>    }  </li> <li>  })  </li> <li>}  </li> <li>export default onPaste </li> </ol></pre><p>然后就可以在 onPaste 事件里面直接使用了：</p><pre> <ol> <li>document.querySelector('.editor').addEventListener('paste', async (e) => {  </li> <li>    const result = await onPaste(e)  </li> <li>    console.log(result)  </li> <li>}) </li> </ol></pre><p>上面的代码支持文本格式，接下来就要对图片格式进行处理了。玩过 <input type="file"> 的同学会知道，包括图片在内的所有文件格式内容都会储存在 File 对象里面，这在剪贴板里面也是一样的。于是我们可以编写一套通用的函数，专门来读取 File 对象里的图片内容，并把它转化成 base64 字符串。</p><p><strong>粘贴图片</strong></p><p>为了更好地在输入框里展示图片，必须限制图片的大小，所以这个图片处理函数不仅能够读取 File 对象里面的图片，还能够对其进行压缩。</p><p>新建一个 chooseImg.js 文件：</p><pre> <ol> <li>/**  </li> <li> * 预览函数  </li> <li> *  </li> <li> * @param {*} dataUrl base64字符串  </li> <li> * @param {*} cb 回调函数  </li> <li> */  </li> <li>function toPreviewer (dataUrl, cb) {  </li> <li>  cb && cb(dataUrl)  </li> <li>}  </li> <li>/**  </li> <li> * 图片压缩函数  </li> <li> *  </li> <li> * @param {*} img 图片对象  </li> <li> * @param {*} fileType  图片类型  </li> <li> * @param {*} maxWidth 图片***宽度  </li> <li> * @returns base64字符串  </li> <li> */  </li> <li>function compress (img, fileType, maxWidth) {  </li> <li>  let canvas = document.createElement('canvas')  </li> <li>  let ctx = canvas.getContext('2d')  </li> <li>  const proportion = img.width / img.height  </li> <li>  const width = maxWidth  </li> <li>  const height = maxWidth / proportion  </li> <li>  canvas.width = width  </li> <li>  canvas.height = height  </li> <li>  ctx.fillStyle = '#fff'  </li> <li>  ctx.fillRect(0, 0, canvas.width, canvas.height)  </li> <li>  ctx.drawImage(img, 0, 0, width, height)  </li> <li>  const base64data = canvas.toDataURL(fileType, 0.75)  </li> <li>  canvas = ctx = null  </li> <li>  return base64data  </li> <li>}  </li> <li>/**  </li> <li> * 选择图片函数  </li> <li> *  </li> <li> * @param {*} e input.onchange事件对象  </li> <li> * @param {*} cb 回调函数  </li> <li> * @param {number} [maxsize=200 * 1024] 图片***体积  </li> <li> */  </li> <li>function chooseImg (e, cb, maxsize = 200 * 1024) {  </li> <li>  const file = e.target.files[0]  </li> <li>  if (!file || !/\/(?:jpeg|jpg|png)/i.test(file.type)) {  </li> <li>    return  </li> <li>  }  </li> <li>  const reader = new FileReader()  </li> <li>  reader.onload = function () {  </li> <li>    const result = this.result  </li> <li>    let img = new Image()  </li> <li>    if (result.length <= maxsize) {  </li> <li>      toPreviewer(result, cb)  </li> <li>      return  </li> <li>    }  </li> <li>    img.onload = function () {  </li> <li>      const compresscompressedDataUrl = compress(img, file.type, maxsize / 1024)  </li> <li>      toPreviewer(compressedDataUrl, cb)  </li> <li>      img = null  </li> <li>    }   </li> <li>    img.src = result  </li> <li>  }  </li> <li>  reader.readAsDataURL(file)  </li> <li>}  </li> <li>export default chooseImg </li> </ol></pre><p>关于使用 canvas 压缩图片和使用 FileReader 读取文件的内容在这里就不赘述了，感兴趣的读者可以自行查阅。</p><p>回到上一步的 paste.js 函数，把其中的 TODO() 改写成 chooseImg() 即可：</p><pre> <ol> <li>const imgEvent = {  </li> <li>  target: {  </li> <li>    files: [pasteFile]  </li> <li>  }  </li> <li>}  </li> <li>chooseImg(imgEvent, (url) => {  </li> <li>  resolve(url)  </li> <li>}) </li> </ol></pre><p>回到浏览器，如果我们复制一张图片并在输入框中执行粘贴的动作，将可以在控制台看到打印出了以 data:image/png;base64 开头的图片地址。</p><p><strong>输入框中插入内容</strong></p><p>经过前面两个步骤，我们后已经可以读取剪贴板中的文本内容和图片内容了，接下来就是把它们正确的插入输入框的光标位置当中。</p><p>对于插入内容，我们可以直接通过 document.execCommand 方法进行。关于这个方法详细用法可以在MDN文档里面找到，在这里我们只需要使用 insertText 和 insertImage 即可。</p><pre> <ol> <li>document.querySelector('.editor').addEventListener('paste', async (e) => {  </li> <li>    const result = await onPaste(e)  </li> <li>    const imgRegx = /^data:image\/png;base64,/  </li> <li>    const command = imgRegx.test(result) ? 'insertImage': 'insertText'   </li> <li>    document.execCommand(command, false, result)  </li> <li>}) </li> </ol></pre><p>但是在某些版本的 Chrome 浏览器下，insertImage 方法可能会失效，这时候便可以采用另外一种方法，利用 Selection 来实现。而之后选择并插入 emoji 的操作也会用到它，因此不妨先来了解一下。</p><p>当我们在代码中调用 window.getSelection() 后会获得一个 Selection 对象。如果在页面中选中一些文字，然后在控制台执行 window.getSelection().toString()，就会看到输出是你所选择的那部分文字。</p><p>与这部分区域文字相对应的，是一个 range 对象，使用 window.getSelection().getRangeAt(0) 即可以访问它。range 不仅包含了选中区域文字的内容，还包括了区域的起点位置 startOffset 和终点位置 endOffset。</p><p>我们也可以通过 document.createRange() 的办法手动创建一个 range，往它里面写入内容并展示在输入框中。</p><p>对于插入图片来说，要先从 window.getSelection() 获取 range ，然后往里面插入图片。</p><pre> <ol> <li>document.querySelector('.editor').addEventListener('paste', async (e) => {  </li> <li>  // 读取剪贴板的内容  </li> <li>  const result = await onPaste(e)  </li> <li>  const imgRegx = /^data:image\/png;base64,/  </li> <li>  // 如果是图片格式（base64），则通过构造range的办法把<img>标签插入正确的位置  </li> <li>  // 如果是文本格式，则通过document.execCommand('insertText')方法把文本插入  </li> <li>  if (imgRegx.test(result)) {  </li> <li>    const sel = window.getSelection()  </li> <li>    if (sel && sel.rangeCount === 1 && sel.isCollapsed) {  </li> <li>      const range = sel.getRangeAt(0)  </li> <li>      const img = new Image()  </li> <li>      img.src = result  </li> <li>      range.insertNode(img)  </li> <li>      range.collapse(false)  </li> <li>      sel.removeAllRanges()  </li> <li>      sel.addRange(range)  </li> <li>    }  </li> <li>  } else {  </li> <li>    document.execCommand('insertText', false, result)  </li> <li>  }  </li> <li>}) </li> </ol></pre><p>这种办法也能很好地完成粘贴图片的功能，并且通用性会更好。接下来我们还会利用 Selection，来完成 emoji 的插入。</p><p><strong>插入 emoji</strong></p><p>不管是粘贴文本也好，还是图片也好，我们的输入框始终是处于聚焦（focus）状态。而当我们从表情面板里选择 emoji 表情的时候，输入框会先失焦(blur），然后再重新聚焦。由于 document.execCommand 方法必须在输入框聚焦状态下才能触发，所以对于处理 emoji 插入来说就无法使用了。</p><p>上一小节讲过，Selection 可以让我们拿到聚焦状态下所选文本的起点位置 startOffset 和终点位置 endOffset，如果没有选择文本而仅仅处于聚焦状态，那么这两个位置的值相等（相当于选择文本为空），也就是光标的位置。只要我们能够在失焦前记录下这个位置，那么就能够通过 range 把 emoji 插入正确的地方了。</p><p>首先编写两个工具方法。新建一个 cursorPosition.js 文件：</p><pre> <ol> <li>/**  </li> <li> * 获取光标位置  </li> <li> * @param {DOMElement} element 输入框的dom节点  </li> <li> * @return {Number} 光标位置  </li> <li> */  </li> <li>export const getCursorPosition = (element) => {  </li> <li>  let caretOffset = 0  </li> <li>  const doc = element.ownerDocument || element.document  </li> <li>  const win = doc.defaultView || doc.parentWindow  </li> <li>  const sel = win.getSelection()  </li> <li>  if (sel.rangeCount > 0) {  </li> <li>    const range = win.getSelection().getRangeAt(0)  </li> <li>    const preCaretRange = range.cloneRange()  </li> <li>    preCaretRange.selectNodeContents(element)  </li> <li>    preCaretRange.setEnd(range.endContainer, range.endOffset)  </li> <li>    caretOffset = preCaretRange.toString().length  </li> <li>  }  </li> <li>  return caretOffset  </li> <li>}  </li> <li>/**  </li> <li> * 设置光标位置  </li> <li> * @param {DOMElement} element 输入框的dom节点  </li> <li> * @param {Number} cursorPosition 光标位置的值  </li> <li> */  </li> <li>export const setCursorPosition = (element, cursorPosition) => {  </li> <li>  const range = document.createRange()  </li> <li>  range.setStart(element.firstChild, cursorPosition)  </li> <li>  range.setEnd(element.firstChild, cursorPosition)  </li> <li>  const sel = window.getSelection()  </li> <li>  sel.removeAllRanges()  </li> <li>  sel.addRange(range)  </li> <li>} </li> </ol></pre><p>有了这两个方法以后，就可以放入 editor 节点里面使用了。首先在节点的 keyup 和 click 事件里记录光标位置：</p><pre> <ol> <li>let cursorPosition = 0  </li> <li>const editor = document.querySelector('.editor')  </li> <li>editor.addEventListener('click', async (e) => {  </li> <li>  cursorPosition = getCursorPosition(editor)  </li> <li>})  </li> <li>editor.addEventListener('keyup', async (e) => {  </li> <li>  cursorPosition = getCursorPosition(editor)  </li> <li>}) </li> </ol></pre><p>记录下光标位置后，便可通过调用 insertEmoji() 方法插入 emoji 字符了。</p><pre> <ol> <li>insertEmoji (emoji) {  </li> <li>  const text = editor.innerHTML  </li> <li>  // 插入 emoji  </li> <li>  editor.innerHTML = text.slice(0, cursorPosition) + emoji + text.slice(cursorPosition, text.length)  </li> <li>  // 光标位置后挪一位，以保证在刚插入的 emoji 后面  </li> <li>  setCursorPosition(editor, this.cursorPosition + 1)  </li> <li>  // 更新本地保存的光标位置变量（注意 emoji 占两个字节大小，所以要加1）  </li> <li>  cursorPosition = getCursorPosition(editor) + 1 //  emoji 占两位  </li> <li>} </li> </ol></pre><p><strong>尾声</strong></p><p>文章涉及的代码已经上传到仓库，为了简便起见采用 VueJS 处理了一下，不影响阅读。***想说的是，这个 Demo 仅仅完成了输入框最基础的部分，关于复制粘贴还有很多细节要处理（比如把别处的行内样式也复制了进来等等），在这里就不一一展开了，感兴趣的读者可以自行研究，更欢迎和我留言交流~</p> <br> 本文题目：Web聊天工具的富文本输入框 <br> 浏览地址：<a href="http://www.kmywjy.com/article/copogod.html">http://www.kmywjy.com/article/copogod.html</a> </div> </div> <div class="other"> <h3>其他资讯</h3> <ul> <li> <a href="/article/sphgjh.html">餐饮抖音运营全案,看完这个短视频你就知道怎么做了!</a> </li><li> <a href="/article/sphgsd.html">禹州短视频运营团队</a> </li><li> <a href="/article/sphgje.html">小白学习短视频运营</a> </li><li> <a href="/article/sphjeo.html">抖音代运营费用价格</a> </li><li> <a href="/article/sphjec.html">丽江短视频运营渠道经理</a> </li> </ul> </div> </div> <footer> <div class="message"> <div class="mess container"> <p>免费获取网站建设与品牌策划方案报价</p> <span>*主要业务范围包括：高端网站建设， 集团网站建设(网站建设网站制作)找网站建设公司就上四川自贡网站建设。</span> <form action=""> <input type="text" class="ipt1" placeholder="联系人"> <input type="text" class="ipt2" placeholder="联系电话"> <textarea name="" id="" placeholder="内容描述：描述您的需求，如网站、微信、电商、APP等。"> 提交需求