quill编辑器使用总结

一、vue-quill-editor 与 quill

        若使用版本1.0,这两个组件使用哪个都是一样的,无非代码有点偏差;若需要使用表格功能,必须使用 quill2.0 版本,因为 vue-quill-editor 不支持table功能。

二、webpack版本问题

        在使用 quill-image-resize-module 组件做图片缩放功能时,需要全局引入quill,及在 vue.config.js 文件中进行如下配置:

const webpack = require('webpack');
// configureWebpack下添加
plugins: [
    new webpack.ProvidePlugin({
        'window.Quill': 'quill/dist/quill.js',
        'Quill': 'quill/dist/quill.js'
    })
]

但配置完发现项目还是报错,这里需要将 webpack5.0版本更换为 webpack4.0

三、图片文字复制粘贴功能

        配合 quill-image-extend-module 组件实现图片上传到服务器的功能,具体参考:https://www.kancloud.cn/liuwave/quill/1434141        

        编辑器内粘贴文字基本没啥问题,好多人都困在了粘贴图片需要上传至文件服务器的问题上,最简单的方法就是添加一个粘贴事件,示例如下:

<div class="editor" ref="editor" @paste="imgPasteHandler($event)"></div>
// 监听粘贴事件
    imgPasteHandler(e) {
      if (e.clipboardData && e.clipboardData.files && e.clipboardData.files.length) {
        e.preventDefault();
        [].forEach.call(e.clipboardData.files, file => {
          let fileName = file.name;
          let fileType = fileName.substring(fileName.lastIndexOf('.') + 1, fileName.length);
          console.log('fileType',fileType);
          let formData = new FormData();
          formData.append("files", file);
          uploadPic(formData).then(resp => {
            if (resp.code === '200') {
              this.$message.success("图片上传成功");
              let index = this.quill.getSelection(true).index;
              this.quill.insertEmbed(index, 'image', process.env.VUE_APP_BASE_API + resp.data.url);
              this.quill.setSelection(index + 1);
            } else {
              this.$message.error(resp.msg);
            }
          });
        });
      }
    }

四、实现表格功能 

        quill2.0版本是支持 quill-better-table 的。table可以实现单元格的宽度缩放,合并,新增,删除,以及底色调整。

        详情请参考:https://www.cnblogs.com/utomboy/p/17839224.html

五、动态实现编辑器的可编辑与只读模式

        可以在quill组件中定义一个属性,然后监听这个属性进行实时的对编辑器的只读模式进行更改,参考如下:

props: {
    /* 是否只读 */
    isReadOnly: {
      type: Boolean,
      default: false
    }
},
watch: {
    isReadOnly: {
      handler(flag) {
        if (this.quill !== null) {
          this.quill.enable(!flag);
        }
      },
      immediate: true
    }
  }

六、给toobar增加title

        编辑器默认是没有title提示的,这对于使用者来说很不友好,可以对toobar的工具图标添加title中文提示,示例如下:

data() {
    return {
        titleConfig: {
        'ql-bold': '加粗',
        'ql-color': '颜色',
        'ql-font': '字体',
        'ql-code': '插入代码',
        'ql-italic': '斜体',
        'ql-link': '添加链接',
        'ql-background': '背景颜色',
        'ql-size': '字体大小',
        'ql-strike': '删除线',
        'ql-script': '上标/下标',
        'ql-underline': '下划线',
        'ql-blockquote': '引用',
        'ql-header': '标题',
        'ql-indent': '缩进',
        'ql-list': '列表',
        'ql-align': '文本对齐',
        'ql-direction': '文本方向',
        'ql-code-block': '代码块',
        'ql-formula': '公式',
        'ql-image': '图片',
        'ql-video': '视频',
        'ql-clean': '清除字体样式'
      }
    }
},
mounted() {
    this.addQuillTitle();
},
methods: {
    addQuillTitle() {
      const oToolBar = document.querySelector('.ql-toolbar');
      const aButton = oToolBar.querySelectorAll('button');
      const aSelect = oToolBar.querySelectorAll('select');
      const aSpan = oToolBar.querySelectorAll('span');
      aButton.forEach(item => {
        if (item.className === 'ql-script') {
          item.value === 'sub' ? item.title = '下标' : item.title = '上标';
        } else if (item.className === 'ql-indent') {
          item.value === '+1' ? item.title = '向右缩进' : item.title = '向左缩进';
        } else if (item.className === 'ql-list') {
          item.value === 'ordered' ? item.title = '有序列表' : item.title = '无序列表';
        } else {
          item.title = this.titleConfig[item.classList[0]];
        }
      });
      aSelect.forEach(item => {
        if (!item.classList.contains('ql-color') && item.classList.contains('ql-background')) {
          item.parentNode.title = this.titleConfig[item.classList[0]];
        }
      });
      aSpan.forEach(item => {
        if (item.classList[0] === 'ql-size') {
          const children = item.querySelectorAll('span');
          children.forEach(child => {
            if (child.className === 'ql-picker-label') {
              child.title = '字体大小';
            } else {
              child.title = '';
            }
          });
        } else if (item.classList[0] === 'ql-header') {
          const children = item.querySelectorAll('span');
          children.forEach(child => {
            if (child.className === 'ql-picker-label') {
              child.title = '标题';
            } else {
              child.title = '';
            }
          });
        } else if (item.classList[0] === 'ql-color') {
          const children = item.querySelectorAll('span');
          children.forEach(child => {
            if (child.className === 'ql-picker-label') {
              child.title = '字体颜色';
            } else {
              child.title = '';
            }
          });
        } else if (item.classList[0] === 'ql-background') {
          const children = item.querySelectorAll('span');
          children.forEach(child => {
            if (child.className === 'ql-picker-label') {
              child.title = '背景颜色';
            } else {
              child.title = '';
            }
          });
        } else if (item.classList[0] === 'ql-align') {
          const children = item.querySelectorAll('span');
          children.forEach(child => {
            if (child.className === 'ql-picker-label') {
              child.title = '对齐方式';
            } else if(child.className === 'ql-picker-options') {
              const childes = child.querySelectorAll('span');
              childes.forEach(c => {
                if (c.getAttribute('data-value') === 'center') {
                  c.title = '居中';
                } else if (c.getAttribute('data-value') === 'right') {
                  c.title = '右对齐';
                } else if (c.getAttribute('data-value') === 'justify') {
                  c.title = '两端对齐';
                } else {
                  c.title = '左对齐';
                }
              });
            }
          });
        }
      });
    }
}

### Quill 编辑器中回车功能的使用与问题解决方案 Quill 富文本编辑器是一个现代化的富文本编辑工具,提供了丰富的扩展性和灵活性。然而,在实际开发过程中,可能会遇到一些特定的功能需求或问题,比如如何正确监听和处理回车键的行为。 #### 1. 默认行为分析 Quill 编辑器默认会在用户按下回车键时插入一个新的段落 `<p>` 元素[^2]。这种行为对于大多数场景来说已经足够,但在某些特殊情况下(例如需要自定义换行逻辑),开发者可能希望修改这一默认行为。 #### 2. 自定义回车键行为的方法 如果需要更改 Quill 中回车键的行为,可以通过 `Keyboard` 模块来实现绑定自定义事件。以下是具体的实现方式: ##### 方法一:通过 Keyboard 绑定覆盖默认行为 可以利用 Quill 提供的 `Keyboard` 模块重新定义按键行为。以下代码展示了如何拦截并重写 Enter 键的操作: ```javascript const quill = new Quill('#editor', { theme: 'snow', modules: { toolbar: true, keyboard: { bindings: { enter: { key: 13, // 对应键盘上的 Enter 键码 handler(range, context) { const cursorPosition = quill.getSelection(true); if (cursorPosition && cursorPosition.length === 0) { quill.insertText(cursorPosition.index, '\n'); quill.setSelection(cursorPosition.index + 1); // 移动光标位置 } return false; // 防止触发默认行为 }, }, }, }, }, }); ``` 此方法通过绑定 `enter` 键的方式实现了对回车操作的完全控制,并阻止了默认的新段落插入行为[^4]。 ##### 方法二:动态调整模块配置 有时直接在初始化阶段绑定键盘事件可能不起作用,这通常是因为其他模块优先级较高而覆盖了自定义绑定。此时可以在实例化之后手动更新 `Keyboard` 模块: ```javascript // 获取当前的 Keyboard 实例 const keyboard = quill.getModule('keyboard'); // 添加新的绑定规则 keyboard.addBinding({ key: 13 }, function (range, context) { console.log('Custom Enter Key Pressed!'); return false; }); ``` 这种方法更加灵活,适合运行时动态调整的情况。 #### 3. 常见问题及其解决办法 - **问题描述**: 在部分版本中发现即使按照官方文档设置了 `Keyboard` 模块也无法正常工作。 - **原因分析**: 这可能是由于不同版本之间的 API 差异造成的。确保使用Quill 版本与其对应的文档匹配是非常重要的。 - **解决方案**: 如果确认版本无误但仍存在问题,则尝试先移除原有的绑定再新增自定义绑定,如下所示: ```javascript quill.keyboard.removeBinding(13); // 删除原有绑定 quill.keyboard.bindings['13'] = [{ // 新增绑定 shiftKey: false, handler() { console.log('Shift not pressed.'); }, }]; ``` 以上代码片段能够有效避免冲突并成功注册新行为[^4]。 --- ### 总结 通过对 Quill 的 `Keyboard` 模块进行合理配置,不仅可以满足基础的回车键定制需求,还能进一步拓展更多复杂交互逻辑。需要注意的是,任何改动都应在充分理解现有机制的基础上谨慎实施,以免引入不必要的副作用。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值