vue–富文本插件Quill(一)基础使用

  • Post author:
  • Post category:vue




简介

Quill是一个很流行的富文本编辑器,github上star大约21k:

github:

https://github.com/quilljs/quill/

官网:

https://quilljs.com/



简单demo

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
  <link href="https://cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet">
</head>
<body>
  <div id="editor">
    <p>Hello World!</p>
    <p>Some initial <strong>bold</strong> text</p>
    <p><br></p>
  </div>
   
  <!-- Include the Quill library -->
  <script src="https://cdn.quilljs.com/1.3.6/quill.js"></script>
   
  <!-- Initialize Quill editor -->
  <script>
    var quill = new Quill('#editor', {
      theme: 'snow'
    });
  </script>
</body>
</html>

在这里插入图片描述



vue组件使用

  • 安装
npm install quill@1.3.6
  • 简单demo
<template>
  <div>
    <div id="editor">
      <p>Hello World!</p>
      <p>啊嘞 <strong>加粗</strong> 文字</p>
      <p><br></p>
    </div>
  </div>
</template>
 
<script>
import Quill from 'quill'
import "quill/dist/quill.core.css";
import "quill/dist/quill.snow.css";
import "quill/dist/quill.bubble.css";
export default {
  name: "QuillEditor",
  mounted () {
    this.initQuill()
  },
  beforeDestroy () {
    this.quill = null
    delete this.quill
  },
  methods: {
    initQuill () {
      const quill = new Quill('#editor', {
        theme: 'snow'
      })
      this.quill = quill
    },
  }
}
</script>

在这里插入图片描述

  • Quill实例需要两个参数,container(区域)与options(工具栏)


    container可以是css选择器,也可以是DOM对象:

     const editor = new Quill('#editor')
     或者
     const container = document.getElementById('editor');
     const editor = new Quill(container);
    


    Options:包括theme、formats、modules等

    const options = {
      debug: 'info', // 去除默认栏下的空显示
      modules: {
        toolbar: '#toolbar'
      },
      placeholder: 'Compose an epic...',
      readOnly: true,
      theme: 'snow'
    };
    const editor = new Quill('#editor', options);
    
  • 获取与显示编辑内容

    富文本编辑器的主要作用是编辑文本、保存、显示等。

    获取编辑完成的内容:

    const html = document.querySelector('#editor').children[0].innerHTML
    console.log(html)
    

    获取内容后置于编辑器中显示:

    const html = document.querySelector('#editor').children[0].innerHTML
    this.quill.pasteHTML('<h3>哇哈哈哈</h3>' + html)
    

    显示:

    在这里插入图片描述

  • Toolbar定制栏格式区

const toolbarOptions = ['bold', 'italic', 'underline', 'strike'];
    
   const quill = new Quill('#editor', {
     modules: {
       toolbar: toolbarOptions
     }
   });

效果:

在这里插入图片描述

更多:

const toolbarOptions = [
  ['bold', 'italic', 'underline', 'strike'],        // toggled buttons
  ['blockquote', 'code-block'],
 
  [{ 'header': 1 }, { 'header': 2 }],               // custom button values
  [{ 'list': 'ordered'}, { 'list': 'bullet' }],
  [{ 'script': 'sub'}, { 'script': 'super' }],      // superscript/subscript
  [{ 'indent': '-1'}, { 'indent': '+1' }],          // outdent/indent
  [{ 'direction': 'rtl' }],                         // text direction
 
  [{ 'size': ['small', false, 'large', 'huge'] }],  // custom dropdown
  [{ 'header': [1, 2, 3, 4, 5, 6, false] }],
 
  [{ 'color': [] }, { 'background': [] }],          // dropdown with defaults from theme
  [{ 'font': [] }],
  [{ 'align': [] }],
 
  ['clean']                                         // remove formatting button
];
 
const quill = new Quill('#editor', {
  modules: {
    toolbar: toolbarOptions
  },
  theme: 'snow'
});

效果:

在这里插入图片描述

同一组会置于同一中。

也可以使用css选择器,最全的

toolbar

:

<template>
<div>
  <div id="toolbar">
    <span class="ql-formats">
      <select class="ql-font"></select>
      <select class="ql-size"></select>
    </span>
    <span class="ql-formats">
      <button class="ql-bold"></button>
      <button class="ql-italic"></button>
      <button class="ql-underline"></button>
      <button class="ql-strike"></button>
    </span>
    <span class="ql-formats">
      <select class="ql-color"></select>
      <select class="ql-background"></select>
    </span>
    <span class="ql-formats">
      <button class="ql-script" value="sub"></button>
      <button class="ql-script" value="super"></button>
    </span>
    <span class="ql-formats">
      <button class="ql-header" value="1"></button>
      <button class="ql-header" value="2"></button>
      <button class="ql-blockquote"></button>
      <button class="ql-code-block"></button>
    </span>
    <span class="ql-formats">
      <button class="ql-list" value="ordered"></button>
      <button class="ql-list" value="bullet"></button>
      <button class="ql-indent" value="-1"></button>
      <button class="ql-indent" value="+1"></button>
    </span>
    <span class="ql-formats">
      <button class="ql-direction" value="rtl"></button>
      <select class="ql-align"></select>
    </span>
    <span class="ql-formats">
      <button class="ql-link"></button>
      <button class="ql-image"></button>
      <button class="ql-video"></button>
      <button class="ql-formula"></button>
    </span>
    <span class="ql-formats">
      <button class="ql-clean"></button>
    </span>
  </div>
  <div id="editor"></div>
</div>
</template>
<script>
import Quill from 'quill'
import "quill/dist/quill.core.css";
import "quill/dist/quill.snow.css";
import "quill/dist/quill.bubble.css";
export default {
  name: "QuillEditor",
  mounted () {
    this.initQuill()
  },
  beforeDestroy () {
    this.quill = null
    delete this.quill
  },
  methods: {
    initQuill () {
      const quill = new Quill('#editor', {
        modules: {
          toolbar: '#toolbar'
        },
        theme: 'snow'
      });
      this.quill = quill
    },
  }
}
</script>

效果:这里的图片上传是以base64格式上传的

在这里插入图片描述

  • toolbar里的control与Quill的format是对应的,可以用来添加或者移除format

  • formats
  • 我们可以添加定制的handler来改变默认行为:
const toolbarOptions = {
 handlers: {
   // handlers object will be merged with default handlers object
   'link': function(value) {
     if (value) {
       var href = prompt('Enter the URL');
       this.quill.format('link', href);
     } else {
       this.quill.format('link', false);
     }
   }
 }
}

const quill = new Quill('#editor', {
 modules: {
   toolbar: toolbarOptions
 }
});

// Handlers can also be added post initialization
const toolbar = quill.getModule('toolbar');
toolbar.addHandler('image', showImageUI);

还可以定制handler来进行图片视频上传。



版权声明:本文为weixin_43909743原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。