vue 富文本 Vue-Quill-Editor 的使用教程

资料

方法一

方法二 ==(建议使用)==

其他

1、下载Vue-Quill-Editor

npm install vue-quill-editor --save

2、下载quill(Vue-Quill-Editor需要依赖)

npm install quill --save

3、代码(1)

<script>
/**
 * 富文本vue-quill-editor 组件
 * name wangkai
 *-------------------设置文档----------------
 *---------- 1、toolbar工具栏-模块名----------
 *  background  --------------  背景颜色
 *  bold  --------------------  加粗
 *  color --------------------  颜色
 *  font  --------------------  字体
 *  code  --------------------  内联代码
 *  italic  ------------------  斜体
 *  link  --------------------  链接
 *  size  --------------------  大小
 *  strike  ------------------  删除线
 *  script  ------------------  上标/下标
 *  underline  ---------------  下划线
 *  blockquote  --------------  引用
 *  header  ------------------  标题
 *  indent  ------------------  缩颈
 *  list  --------------------  列表
 *  align  -------------------  文本对齐
 *  direction  ---------------  文本方向
 *  code-block  --------------  代码块
 *  formula  -----------------  公式
 *  image  -------------------  图片
 *  video  -------------------  视频
 *  clean  -------------------  清除字体样式
 */
import Quill from 'quill';
// quill图片可拖拽上传
import { ImageDrop } from 'quill-image-drop-module';

Quill.register('modules/imageDrop', ImageDrop);

export default {
  name: 'the_rich_text',
  data() {
    return {
      data: this.content,
      // toolbar工具栏设置
      editorOption: {
        modules: {
          toolbar: [
            ['bold', 'italic', 'underline', 'strike'],
            [{ color: [] }, { background: [] }],
            ['link', 'image'],
            ['blockquote', 'code-block'],
            [{ align: [] }],
            [{ list: 'ordered' }, { list: 'bullet' }],
            [{ script: 'sub' }, { script: 'super' }],
            // [{ header: 1 }, { header: 2 }],
            // [{ header: [1, 2, 3, 4, 5, 6, false] }],
            [{ size: ['small', false, 'large', 'huge'] }],
            [{ font: [] }],
            // [{ indent: '-1' }, { indent: '+1' }],
          ],
          imageDrop: true,
        },
      },
    };
  },
  props: {
    // 表格数据
    content: {
      type: String,
      default: () => (''),
      required: true,
    },
  },
  methods: {
    // 失去焦点事件
    onEditorBlur() {
      this.$emit('onEditorBlur', this.data);
    },
    // 获得焦点事件
    onEditorFocus() {
      this.$emit('onEditorFocus', this.data);
    },
    // 编辑器文本发生变化
    onEditorChange() {
      this.$emit('onEditorChange', this.data);
    },
  },
};
</script>

<template lang="pug">
  .the-rich-text
    quill-editor(
      v-model="data"
      ref="myQuillEditor"
      :options="editorOption"
      @blur="onEditorBlur"
      @focus="onEditorFocus"
      @change="onEditorChange")
</template>

<style lang="stylus" scoped>
.the-rich-text
  width 100%
  margin 20px 0px
  display inline-block
  background #ffffff
</style>

4、代码(2)

  • 依赖包
"quill": "^1.3.6",
"quill-image-extend-module": "^1.1.2",
"vue-quill-editor": "^3.0.6",
<script>
/**
 * 富文本 vue-quill-editor 组件
 * Author: wangkai
 */
import { quillEditor, Quill } from 'vue-quill-editor';
import { container, ImageExtend, QuillWatch } from 'quill-image-extend-module';
import 'quill/dist/quill.core.css';
import 'quill/dist/quill.snow.css';
import 'quill/dist/quill.bubble.css';

Quill.register('modules/ImageExtend', ImageExtend);

export default {
  name: 'the_rich_text',
  components: {
    quillEditor,
  },
  data() {
    return {
      content: '',
    };
  },
  model: {
    event: 'change',
  },
  props: {
    value: {
      type: String,
      default: () => (''),
      required: true,
    },
    action: {
      type: String,
      default: null,
    },
    name: {
      type: String,
      default: 'file',
    },
    headers: {
      type: Object,
      default: () => ({}),
    },
    size: {
      type: Number,
      default: null,
    },
    formData: {
      type: Object,
      default: () => ({}),
    },
  },
  computed: {
    options() {
      const { name, action, headers, size } = this;
      return {
        modules: {
          ImageExtend: {
            loading: true,
            name,
            action,
            size,
            headers: (xhr) => {
              Object.entries(headers).forEach((ary) => {
                xhr.setRequestHeader(ary[0], ary[1]);
              });
            },
            response: res => res.url,
            sizeError() {

            },
            start: () => {

            },
            end: () => {
            },
            error: () => {

            },
            success: () => {

            },
            change: (xhr, formData) => {
              Object.entries(this.formData).forEach((ary) => {
                formData.append(ary[0], ary[1]);
              });
            },
          },
          toolbar: {
            container,
            handlers: {
              image() {
                QuillWatch.emit(this.quill.id);
              },
            },
          },
        },
      };
    },
  },
  methods: {
    // 失去焦点事件
    onEditorBlur(...args) {
      this.$emit('blur', ...args);
    },
    // 获得焦点事件
    onEditorFocus(...args) {
      this.$emit('focus', ...args);
    },
    // 编辑器文本发生变化
    onEditorChange({ html }) {
      this.$emit('change', html);
    },
  },
};
</script>

<template lang="pug">
  .the-rich-text
    quill-editor(
      ref="myQuillEditor"
      :value="value"
      :options="options"
      @blur="onEditorBlur"
      @focus="onEditorFocus"
      @change="onEditorChange")
</template>

<style lang="stylus" scoped>
.the-rich-text
  width 100%
  margin 20px 0px
  display inline-block
  background #ffffff
</style>

5、组件使用

//-富文本
  the-rich-text(
    v-model="data"
    action="http://api.pay-star.com/admin/images"
    :headers="{ 'company-token': '4P6snTNhfADVykzxYkLAvs' }")

修改后的组件(支持自定义设置toolbar-工具栏)

6、代码(3)

<script>
/**
 * 富文本 vue-quill-editor 组件
 * Author: wangkai
 */
import { quillEditor, Quill } from 'vue-quill-editor';
import { ImageExtend, QuillWatch } from 'quill-image-extend-module';
import 'quill/dist/quill.core.css';
import 'quill/dist/quill.snow.css';
import 'quill/dist/quill.bubble.css';

Quill.register('modules/ImageExtend', ImageExtend);

export default {
  name: 'the_rich_text',
  components: {
    quillEditor,
  },
  data() {
    return {
      content: '',
    };
  },
  model: {
    event: 'change',
  },
  props: {
    value: {
      type: String,
      default: () => (''),
      required: true,
    },
    action: {
      type: String,
      default: null,
    },
    name: {
      type: String,
      default: 'file',
    },
    headers: {
      type: Object,
      default: () => ({}),
    },
    size: {
      type: Number,
      default: null,
    },
    formData: {
      type: Object,
      default: () => ({}),
    },
    container: {
      type: Array,
      default: () => ([]),
    },
  },
  computed: {
    options() {
      const { name, action, headers, size, container } = this;
      return {
        modules: {
          ImageExtend: {
            loading: true,
            name,
            action,
            size,
            headers: (xhr) => {
              Object.entries(headers).forEach((ary) => {
                xhr.setRequestHeader(ary[0], ary[1]);
              });
            },
            response: res => res.url,
            sizeError() {

            },
            start: () => {

            },
            end: () => {
            },
            error: () => {

            },
            success: () => {

            },
            change: (xhr, formData) => {
              Object.entries(this.formData).forEach((ary) => {
                formData.append(ary[0], ary[1]);
              });
            },
          },
          toolbar: {
            container,
            handlers: {
              image() {
                QuillWatch.emit(this.quill.id);
              },
            },
          },
        },
      };
    },
  },
  methods: {
    // 失去焦点事件
    onEditorBlur(...args) {
      this.$emit('blur', ...args);
    },
    // 获得焦点事件
    onEditorFocus(...args) {
      this.$emit('focus', ...args);
    },
    // 编辑器文本发生变化
    onEditorChange({ html }) {
      this.$emit('change', html);
    },
  },
};
</script>

<template lang="pug">
  .the-rich-text
    quill-editor(
      ref="myQuillEditor"
      :value="value"
      :options="options"
      @blur="onEditorBlur"
      @focus="onEditorFocus"
      @change="onEditorChange")
</template>

<style lang="stylus" scoped>
.the-rich-text
  width 100%
  margin 20px 0px
  display inline-block
  background #ffffff
</style>

7、组件使用(修改后)

//-富文本-HTML
  the-rich-text(
    v-model="data"
    :container="toolbar", // 添加自定义功能。
    action="http://api.pay-star.com/admin/images"
    :headers="{ 'company-token': '4P6snTNhfADVykzxYkLAvs' }")
  • 设置文档
 * 富文本vue-quill-editor 组件
 * name wangkai
 *-------------------设置文档----------------
 *---------- 1、toolbar工具栏-模块名----------
 *  background  --------------  背景颜色
 *  bold  --------------------  加粗
 *  color --------------------  颜色
 *  font  --------------------  字体
 *  code  --------------------  内联代码
 *  italic  ------------------  斜体
 *  link  --------------------  链接
 *  size  --------------------  大小
 *  strike  ------------------  删除线
 *  script  ------------------  上标/下标
 *  underline  ---------------  下划线
 *  blockquote  --------------  引用
 *  header  ------------------  标题
 *  indent  ------------------  缩颈
 *  list  --------------------  列表
 *  align  -------------------  文本对齐
 *  direction  ---------------  文本方向
 *  code-block  --------------  代码块
 *  formula  -----------------  公式
 *  image  -------------------  图片
 *  video  -------------------  视频
 *  clean  -------------------  清除字体样式
  • 数据结构
toolbar: [
    ['bold', 'italic', 'underline', 'strike'],
    [{ color: [] }, { background: [] }],
    ['link', 'image'],
    ['blockquote', 'code-block'],
    [{ align: [] }],
    [{ list: 'ordered' }, { list: 'bullet' }],
    [{ script: 'sub' }, { script: 'super' }],
    // [{ header: 1 }, { header: 2 }],
    // [{ header: [1, 2, 3, 4, 5, 6, false] }],
    [{ size: ['small', false, 'large', 'huge'] }],
    [{ font: [] }],
    // [{ indent: '-1' }, { indent: '+1' }],
  ],
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容