基於Vue項目的富文本vue-quill-editor的使用

基於Vue項目的富文本vue-quill-editor的使用

一.背景

最近呢,要做一個項目,後臺管理平臺要實現一個商品的詳情發佈,因爲馬上要做項目了,所以看了其中的一些設計,提前把一些技術要點攻關一下,到時候做項目會得心應手,網上搜了一下,發現vue-quill-editor這款富文本編輯器還挺不錯的,在github上使用率也比較高,很適合咱們的vue項目,話不多說,直接上手了

二.Vue-Quill-Editor使用

1.簡介

基於 Quill,適用於Vue的富文本編輯器,支持服務端渲染和單頁應用.不過有一定的兼容性,就是兼容IE10+

2.安裝

npm install vue-quill-editor -S

當然,也可以使用CDN的方式引入,我們這裏講NPM安裝

3.掛載到項目

1.全局掛載

// main.js

import Vue from 'vue'
import VueQuillEditor from 'vue-quill-editor'

import 'quill/dist/quill.core.css' // import styles
import 'quill/dist/quill.snow.css' // for snow theme
import 'quill/dist/quill.bubble.css' // for bubble theme

Vue.use(VueQuillEditor, /* { default global options } */)

2.組件中掛載

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

import { quillEditor } from 'vue-quill-editor'

export default {
  components: {
    quillEditor
  }
}

我們在開發中,使用到富文本,最多也就那麼幾個地方,所以不用使用全局掛載,直接在封裝成組件,在組件中掛載即可!

4.組件中使用

在template中去使用組件,這裏,我們有兩種方式:一種是支持雙向數據綁定的,一種是手動控制數據同步的

1.雙向數據綁定示例

<template>
 <!-- Two-way Data-Binding -->
  <quill-editor
    ref="myQuillEditor"
    v-model="content"
    :options="editorOption"
    @blur="onEditorBlur($event)"
    @focus="onEditorFocus($event)"
    @ready="onEditorReady($event)"
  />    
</template>

2.手動控制數據同步

<!-- Or manually control the data synchronization -->
  <quill-editor
    :content="content"
    :options="editorOption"
    @change="onEditorChange($event)"
  />

既然是Vue項目,我們這當然是使用支持雙向數據綁定的

5.在script中的配置

1.基本配置

import "quill/dist/quill.core.css";
import "quill/dist/quill.snow.css";
import "quill/dist/quill.bubble.css";

import { quillEditor } from "vue-quill-editor";

export default {
  components: {
    quillEditor
  },
   data () {
      return {
        // 富文本編輯器默認內容
        content: '<h2>I am Example</h2>',
        //富文本編輯器配置
        editorOption: {
          // Some Quill options...
        }
      }
    },
    methods: {
      //失去焦點事件
      onEditorBlur(quill) {
        console.log('editor blur!', quill)
      },
      //獲得焦點事件
      onEditorFocus(quill) {
        console.log('editor focus!', quill)
      },
      // 準備富文本編輯器
      onEditorReady(quill) {
        console.log('editor ready!', quill)
      },
      //內容改變事件
      onEditorChange({ quill, html, text }) {
        console.log('editor change!', quill, html, text)
        this.content = html
      }
    }
}

配置到這裏,我們基本上就可以使用這個富文本了,但是呢,這只是最基本的,還不能滿足我們的需求,因爲這種簡單的有些缺陷

• 都是英文,在我們國內的話,不能要求我們的用戶都是高學歷的,能漢化最好了
• 富文本中總要上傳一些圖片,或者短視頻什麼的,這裏雖然都支持,但是都會轉成base64的格式,當我們要把這些數據提交到後端的時候,傳輸數據量比較大,總是不太方便

所以我們還需要使用它更豐富的功能,進行擴展一下,能彌補這些缺陷

2.擴展漢化處理

1.配置工具欄

// 工具欄配置
const toolbarOptions = [
  ["bold", "italic", "underline", "strike"], // 加粗 斜體 下劃線 刪除線 -----['bold', 'italic', 'underline', 'strike']
  ["blockquote", "code-block"], // 引用  代碼塊-----['blockquote', 'code-block']
  [{ header: 1 }, { header: 2 }], // 1、2 級標題-----[{ header: 1 }, { header: 2 }]
  [{ list: "ordered" }, { list: "bullet" }], // 有序、無序列表-----[{ list: 'ordered' }, { list: 'bullet' }]
  [{ script: "sub" }, { script: "super" }], // 上標/下標-----[{ script: 'sub' }, { script: 'super' }]
  [{ indent: "-1" }, { indent: "+1" }], // 縮進-----[{ indent: '-1' }, { indent: '+1' }]
  [{ direction: "rtl" }], // 文本方向-----[{'direction': 'rtl'}]
  [{ size: ["small", false, "large", "huge"] }], // 字體大小-----[{ size: ['small', false, 'large', 'huge'] }]
  [{ header: [1, 2, 3, 4, 5, 6, false] }], // 標題-----[{ header: [1, 2, 3, 4, 5, 6, false] }]
  [{ color: [] }, { background: [] }], // 字體顏色、字體背景顏色-----[{ color: [] }, { background: [] }]
  [{ font: [] }], // 字體種類-----[{ font: [] }]
  [{ align: [] }], // 對齊方式-----[{ align: [] }]
  ["clean"], // 清除文本格式-----['clean']
  ["image", "video"] // 鏈接、圖片、視頻-----['link', 'image', 'video']
];

2.css樣式配置

<style lang='scss' >
.editor {
  line-height: normal !important;
  height: 500px;
}
.ql-snow .ql-tooltip[data-mode="link"]::before {
  content: "請輸入鏈接地址:";
}
.ql-snow .ql-tooltip.ql-editing a.ql-action::after {
  border-right: 0px;
  content: "保存";
  padding-right: 0px;
}

.ql-snow .ql-tooltip[data-mode="video"]::before {
  content: "請輸入視頻地址:";
}

.ql-snow .ql-picker.ql-size .ql-picker-label::before,
.ql-snow .ql-picker.ql-size .ql-picker-item::before {
  content: "14px";
}
.ql-snow .ql-picker.ql-size .ql-picker-label[data-value="small"]::before,
.ql-snow .ql-picker.ql-size .ql-picker-item[data-value="small"]::before {
  content: "10px";
}
.ql-snow .ql-picker.ql-size .ql-picker-label[data-value="large"]::before,
.ql-snow .ql-picker.ql-size .ql-picker-item[data-value="large"]::before {
  content: "18px";
}
.ql-snow .ql-picker.ql-size .ql-picker-label[data-value="huge"]::before,
.ql-snow .ql-picker.ql-size .ql-picker-item[data-value="huge"]::before {
  content: "32px";
}

.ql-snow .ql-picker.ql-header .ql-picker-label::before,
.ql-snow .ql-picker.ql-header .ql-picker-item::before {
  content: "文本";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="1"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="1"]::before {
  content: "標題1";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="2"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="2"]::before {
  content: "標題2";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="3"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="3"]::before {
  content: "標題3";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="4"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="4"]::before {
  content: "標題4";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="5"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="5"]::before {
  content: "標題5";
}
.ql-snow .ql-picker.ql-header .ql-picker-label[data-value="6"]::before,
.ql-snow .ql-picker.ql-header .ql-picker-item[data-value="6"]::before {
  content: "標題6";
}

.ql-snow .ql-picker.ql-font .ql-picker-label::before,
.ql-snow .ql-picker.ql-font .ql-picker-item::before {
  content: "標準字體";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value="serif"]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value="serif"]::before {
  content: "襯線字體";
}
.ql-snow .ql-picker.ql-font .ql-picker-label[data-value="monospace"]::before,
.ql-snow .ql-picker.ql-font .ql-picker-item[data-value="monospace"]::before {
  content: "等寬字體";
}
</style>

注意:

• 因爲我們是在組件內寫的樣式 所以要刪除 style lang=‘scss’ scoped 中的 scoped,使樣式全局生效

• 我加了一個.editor 自定義的樣式,可以自己控制富文本窗體大小,所以在引用這個組件的時候,加上class=’.editor’

  <quill-editor class='.editor'></quill-editor>
  

3.data選項中的配置變化

 data() {
    return {
      content: ``, // 富文本編輯器默認內容
      editorOption: {
        //  富文本編輯器配置
        modules: {
          //工具欄定義的
          toolbar: toolbarOptions
        },
        //主題
        theme: "snow",
        placeholder: "請輸入正文"
      }
    };
  },

6.在富文本中上傳文件

富文本中總要上傳一些圖片,或者短視頻什麼的,這裏雖然都支持,但是都會轉成base64的格式,當我們要把這些數據提交到後端的時候,傳輸數據量比較大,總是不太方便,況且後端存數據庫的時候也只是存個路徑地址而已,不會存base64那麼一長串的編碼,否則數據庫豈不是要爆炸了

1.效果圖:

首先呢,說一下具體的思路,然後實現:

• vue-quill-edito是基於quill的,而quill有很多擴展和自定義的方法功能,比如說圖片上傳的點擊功能,和圖片的重定義大小

• 需要獲取到quill的實例,我們纔好做後面的事情this.$refs.myQuillEditor.quill

• 現在呢,要實現圖片上傳,用vue-quill-editor自身的工具欄中的圖片按鈕點擊事件肯定是不行的,因爲會默認轉爲base64,所以我們需要自己定義一個圖片處理函數,當工具欄中的圖片按鈕被點擊,然後使之觸發.

  this.$refs.newEditor.quill.getModule(``"toolbar"``).addHandler(``"image"``, imgHandler) 註冊一個自定義圖片處理函數

• 我們聯想一下,以前使用隱藏控件時,讓隱藏控件做某些事情.利用這個原理,我們可以模擬一個文件上傳的點擊事件,在當前使用組件的地方,寫一個form表單,然後form表單中隱藏一個input標籤,type爲file屬性.當我們的自定義圖片處理函數被點擊時,進行觸發

• 最後調用圖片上傳的接口,返回圖片在服務器的地址之後,回顯於當前富文本中

不多說了,上代碼

template

<template>
  <div>
    <quill-editor
      v-model="content"
      ref="myQuillEditor"
      :options="editorOption"
      @focus="onEditorFocus($event)"
      @blur="onEditorBlur($event)"
      @change="onEditorChange($event)"
      class="editor"
    ></quill-editor>

    <form action method="post" enctype="multipart/form-data" id="uploadFormMulti">
      <input
        style="display: none"
        :id="uniqueId"
        type="file"
        name="file"
        multiple
        accept="image/jpg, image/jpeg, image/png, image/gif"
        @change="uploadImg('uploadFormMulti')"
      />
    </form>
  </div>
</template>

上面是vue文件模版的內容

script

<script>
import "quill/dist/quill.core.css";
import "quill/dist/quill.snow.css";
import "quill/dist/quill.bubble.css";

import { quillEditor } from "vue-quill-editor";

// 工具欄配置
const toolbarOptions = [
  ["bold", "italic", "underline", "strike"], // 加粗 斜體 下劃線 刪除線 -----['bold', 'italic', 'underline', 'strike']
  ["blockquote", "code-block"], // 引用  代碼塊-----['blockquote', 'code-block']
  [{ header: 1 }, { header: 2 }], // 1、2 級標題-----[{ header: 1 }, { header: 2 }]
  [{ list: "ordered" }, { list: "bullet" }], // 有序、無序列表-----[{ list: 'ordered' }, { list: 'bullet' }]
  [{ script: "sub" }, { script: "super" }], // 上標/下標-----[{ script: 'sub' }, { script: 'super' }]
  [{ indent: "-1" }, { indent: "+1" }], // 縮進-----[{ indent: '-1' }, { indent: '+1' }]
  [{ direction: "rtl" }], // 文本方向-----[{'direction': 'rtl'}]
  [{ size: ["small", false, "large", "huge"] }], // 字體大小-----[{ size: ['small', false, 'large', 'huge'] }]
  [{ header: [1, 2, 3, 4, 5, 6, false] }], // 標題-----[{ header: [1, 2, 3, 4, 5, 6, false] }]
  [{ color: [] }, { background: [] }], // 字體顏色、字體背景顏色-----[{ color: [] }, { background: [] }]
  [{ font: [] }], // 字體種類-----[{ font: [] }]
  [{ align: [] }], // 對齊方式-----[{ align: [] }]
  ["clean"], // 清除文本格式-----['clean']
  ["image", "video"] // 鏈接、圖片、視頻-----['link', 'image', 'video']
];

export default {
  name: "",
  components: {
    quillEditor
  },
  data() {
    return {
      uniqueId: "uniqueId",
      content: "", // 富文本編輯器默認內容
      editorOption: {
        //  富文本編輯器配置
        modules: {
          toolbar: toolbarOptions
        },
        theme: "snow",
        placeholder: "請輸入正文"
      }
    };
  },
  computed: {
    //當前富文本實例
    editor() {
      return this.$refs.myQuillEditor.quill;
    }
  },
  methods: {
    // 準備富文本編輯器
    onEditorReady() {},
    // 富文本編輯器 失去焦點事件
    onEditorBlur() {},
    // 富文本編輯器 獲得焦點事件
    onEditorFocus() {},
    // 富文本編輯器 內容改變事件
    onEditorChange() {},
    uploadImg: async function() {
      var _this = this;
      //構造formData對象
      var formData = new FormData();
      formData.append("file", document.getElementById(_this.uniqueId).files[0]);

      try {
        //調用上傳文件接口
        this.$http.productapi.uploadImgReq(formData).then(res => {
          //返回上傳文件的地址
          let url = res;
          if (url != null && url.length > 0) {
            let Range = _this.editor.getSelection();
            url = url.indexOf("http") != -1 ? url : "http:" + url;
            //上傳文件成功之後在富文本中回顯(顯示)
            _this.editor.insertEmbed(
              Range != null ? Range.index : 0,
              "image",
              url
            );
          } else {
            _this.$message.warning("圖片上傳失敗");
          }
          //成功之後,將文件的文本框的value置空
          document.getElementById(_this.uniqueId).value = "";
        });
      } catch ({ message: msg }) {
        document.getElementById(_this.uniqueId).value = "";
        _this.$message.warning(msg);
      }
    }
  },
  mounted() {
    var _this = this;
    var imgHandler = async function(image) {

      if (image) {
        var fileInput = document.getElementById(_this.uniqueId); //隱藏的file文本ID
        fileInput.click(); //加一個觸發事件
      }
    };
    _this.editor.getModule("toolbar").addHandler("image", imgHandler);
  }
};
</script>

樣式直接使用上面的css樣式配置即可

7.實現圖片在富文本中自由縮放

雖然實現了圖片上傳,解決了base64的問題,但是呢,我們發現圖片回顯的時候,體驗感比較差,佔滿了整個富文本窗口.所有呢,接下來我們要實現圖片能在富文本中可以自由縮放

1.安裝拖動和縮放的依賴

npm install quill-image-resize-module -S  //縮放
npm install quill-image-drop-module -S //拖動
//還需要安裝quill 因爲這幾個插件都是依賴於quill
npm install quill -S

2.加入相關引用

//加入以下引用
import Quill from "quill";
import ImageResize from "quill-image-resize-module"; // 引用
import { ImageDrop } from "quill-image-drop-module";
Quill.register("modules/imageDrop", ImageDrop);
Quill.register("modules/imageResize", ImageResize); // 註冊

3.配置editorOption

   editorOption: {
        theme: "snow",
        placeholder: "請輸入正文",
        modules: {
          imageDrop: true,
          imageResize: {
            displayStyles: {
              backgroundColor: "black",
              border: "none",
              color: "white"
            },
            modules: ["Resize", "DisplaySize", "Toolbar"]
          },
          //  富文本編輯器配置
          toolbar: {
            container: toolbarOptions
          }
        }
      }

至此,拖動自由縮放功能就搞定了