Vue 富文本编辑器 vue-quill-editor

背景

公司项目需要支持简单表格展示、图片上传、样式丰富的富文本编辑器。

当时选择Quill这个富文本编辑器了也是看了一些附带的插件的Demo（quill-better-table、quill-image-resize-module），还有自定义的toolbar

安装

# use npm 

  npm install vue-quill-editor --save
  
  npm install quill --save          

引用

全局引用

main.js中引用

import VueQuillEditor from 'vue-quill-editor'

import 'quill/dist/quill.core.css'

import 'quill/dist/quill.snow.css'

import 'quill/dist/quill.bubble.css'

//挂载到Vue上
Vue.use(VueQuillEditor, /* { default global options } */)

项目中使用Quill

<quill-editor
    class="editor"
    v-model="content"
    ref="myQuillEditor"
    @change="onEditorChange($event)"
  >
  </quill-editor>
  
  export default {
  name: 'quillEditor',
  data() {
    return {
      content: null,
    }
  },
  methods: {
    onEditorChange(e) {
      //内容改变事件
      this.$emit('EditorFrom', e.html)
    },
  },
}

组件配置

/*富文本编辑图片上传配置*/
const uploadConfig = {
    action:  'http',  // 必填参数 图片上传地址
    methods: 'POST',  // 必填参数 图片上传方式
    token:'token',  // 可选参数 如果需要token验证，假设你的token有存放在sessionStorage
    name: 'file',  // 必填参数 文件的参数名
    size: 10000,  // 可选参数   图片大小，单位为Kb, 1M = 1024Kb
    accept: 'image/png, image/gif, image/jpeg, image/bmp, image/x-icon'  // 可选 可上传的图片格式
};

// toolbar工具栏的工具选项（默认展示全部）
const toolOptions = [
    ['bold', 'italic', 'underline', 'strike'],
    ['blockquote', 'code-block'],
    [{'header': 1}, {'header': 2}],
    [{'list': 'ordered'}, {'list': 'bullet'}],
    [{'script': 'sub'}, {'script': 'super'}],
    [{'indent': '-1'}, {'indent': '+1'}],
    [{'direction': 'rtl'}],
    [{'size': ['small', false, 'large', 'huge']}],
    [{'header': [1, 2, 3, 4, 5, 6, false]}],
    [{'color': []}, {'background': []}],
    [{'font': []}],
    [{'align': []}],
    ['clean'],
    ['image']
];
const handlers = {
    image: function image() {
        var self = this;
        
        var fileInput = this.container.querySelector('input.ql-image[type=file]');
        if (fileInput === null) {
            fileInput = document.createElement('input');
            fileInput.setAttribute('type', 'file');
            // 设置图片参数名
            if (uploadConfig.qname) {
                fileInput.setAttribute('name', uploadConfig.name);
            }
            // 可设置上传图片的格式
            fileInput.setAttribute('accept', uploadConfig.accept);
            fileInput.classList.add('ql-image');
            // 监听选择文件
            fileInput.addEventListener('change', function () {
                // 创建formData
                var formData = new FormData();
                formData.append(uploadConfig.name, fileInput.files[0]);
                // 如果需要token且存在token
                if (uploadConfig.token) {
                    formData.append('token', uploadConfig.token)
                }
                // 图片上传
                var xhr = new XMLHttpRequest();
				var loadingInstance;
                xhr.open(uploadConfig.methods, uploadConfig.action, true);
                xhr.setRequestHeader('token', uploadConfig.token);
                // 上传数据成功，会触发
                xhr.onload = function () {
                    if (xhr.status === 200) {
                        var res = JSON.parse(xhr.responseText);
                        let length = self.quill.getSelection(true).index;
                        //这里很重要，你图片上传成功后，img的src需要在这里添加，res.path就是你服务器返回的图片链接。 
                        self.quill.insertEmbed(length, 'image', res.data.url);
                        self.quill.setSelection(length + 1)
						// loadingInstance.close();
                    }
                    fileInput.value = ''
                };
                // 开始上传数据
                xhr.upload.onloadstart = function () {
                    fileInput.value = ''
                };
                // 当发生网络异常的时候会触发，如果上传数据的过程还未结束
                xhr.upload.onerror = function () {
					
					loadingInstance.close();
                };
                // 上传数据完成（成功或者失败）时会触发
                xhr.upload.onloadend = function () {
					// loadingInstance.close();
                };
                xhr.send(formData)
            });
            this.container.appendChild(fileInput);
        }
        fileInput.click();
    }
};

export default {
    placeholder: '',
    theme: 'snow',  // 主题
    modules: {
        toolbar: {
            container:toolOptions ,  // 工具栏选项
            handlers: handlers  // 事件重写
        }
    }
};

页面展示效果