富文本编辑器-2-组件封装

目前github上已经有将Quill封装一层的vue-quill-editor,对于使用Vue且想直接用Quill基本功能的同学,可以直接安装使用。由于公司业务需要定制一些功能,用vue-quill-editor或直接用quill没有太大区别,都需要自行封装组件,所以没有引入vue-quill-editor,而是参考其封装。

主要的props

  1. value: v-model绑定内容
  2. toolbarOptions:指定工具栏功能项,可以传入数组,也可以传入类或id,如'.toolbar'。一开始考虑用html的方式实现工具栏,以更灵活地进行改写,绑定事件等。但这样做,如果使用者想用组件已有几种功能,也必须在外部重写toolbar的slot。最后选择默认使用options数组。
defaultToolbarOptions: [
  ['undo', 'redo'],
  [{ 'size': this.sizeList }],
  [{ 'header': [1, 2, 3, 4, 5, 6, false] }],
  ['blockquote', 'divider'],
  ['clean', 'formatBrush'],
  ['link', 'emoji', 'image'],
  ['bold', 'italic', 'underline', 'strike'],
  [{ 'color': [] }, {'background': []}],
  [{ 'script': 'sub' }, { 'script': 'super' }],
  [{ 'indent': '-1' }, { 'indent': '+1' }, { 'align': [] }, { 'direction': 'rtl' }],
  [{ 'list': 'ordered' }, { 'list': 'bullet' }]
]
...
// 初始化
let toolbarOptions = this.toolbarOptions || this.defaultToolbarOptions
  1. options: 指定整个Quill初始化的options。用toolbarOptions可以满足大部分业务,但不排除部分业务处理方法也需要定制,所以也应该支持由外部来指定初始化的options。
  2. disabled: 是否可写

基础文本模块的封装

一开始考虑直接在组件中添加/重写模块,分为以下4步:

  1. 组件引入格式类
  2. 组件引入handler.js
  3. 统一增加对应的工具栏图标
  4. 注册引入的格式
  5. 绑定点击工具栏图标的handler
···
  // 1.引入对应的格式类
  import Blockquote, {BlockquoteItem} from './editor-blot/blockquote.js'
  import Divider from './editor-blot/divider.js'
// 2.引入handler
  import {undo, redo, insertDivider, copyFormat} from './editor-blot/handler.js'
···
  init () {
        Quill.register('modules/imageResize', ImageResize)
        // 3.图标增加
        this.addIcons()
        // 4.重写/添加格式功能
        this.registerFormats()
        this.options = {
          modules: {
            toolbar: {
              container: this.$refs.toolbar,
              // 5.改写handler
              handlers: {
                'undo': () => { undo(this.quill) },
                'redo': () => { redo(this.quill) },
                'divider': () => { insertDivider(this.quill) },
                'formatBrush': () => { copyFormat(this.quill, this.copyFormatting) },
                'emoji': function () {},
                'image': () => {
                  this.img.show = true
                }
              }
            },
            imageResize: {},
            toolbar_emoji: true,
            short_name_emoji: true,
            textarea_emoji: false,
            tooltip: true
          },
          readOnly: this.readOnly,
          placeholder: '请输入内容',
          theme: 'snow'
        }
        this.quill = new Quill(this.$refs.editor, this.options)
      },
      /* 添加icons */
      addIcons () {
        let icons = Quill.import('ui/icons')
        for (let key in ToolIcons) {
          icons[key] = ToolIcons[key]
        }
      },
      /* 注册格式 */
      registerFormats () {
        // 字号重写
        let Size = Quill.import('attributors/style/size')
        Size.whitelist = ['12px', '14px', '16px', '18px', '20px', '24px']
        Quill.register({
          // 字号
          'formats/size': Size,
          // 段落
          'formats/blockquote': Blockquote,
          'formats/blockquote-item': BlockquoteItem,
          // 分割线
          'formats/divider': Divider
        })
      },

但这样做,存在问题:

  1. 如果使用者使用options属性定制整个Quill,且又需要段落、分割线等模块,则需要将步骤1,2, 4 , 5重复写一遍。
  2. handler中需要传入组件的this.quill,意味着在使用文件需要用this.refs.editor.refs.quill来传参,显然这种方式不太友好。

为了解决这些问题,最终决定参考github的其他Quill功能模块(如quill-emoji),多一步封装过程,合并格式类和handler,将功能模块化:
1.编写格式类
2.编写模块类,编写对应的handler,并注册到Quill的modules上(模块对应的index.js)
3.使用时,(组件/外部)直接引入模块,并在options设置模块为true
这样一来,即便以后需要实现其他个性化业务,使用者也能用步骤3,简单地引用已有模块。如果需要新的模块,可以编写后在组件引入。

...
  // 引入模块
  import './quill-tooltip/tooltip-body.js'
  import './quill-blockquote/index.js'
  import './quill-divider/index.js'
  import './quill-undo-redo/index.js'
  import './quill-format-brush/index.js'
...
  init () {
        Quill.register('modules/imageResize', ImageResize)
        this.addIcons()
        this.registerFont()
        let toolbarOptions = this.toolbarOptions || this.defaultToolbarOptions
        this.defaultOptions = {
          modules: {
            toolbar: {
              container: toolbarOptions,
              handlers: {
                'emoji': () => {},
                'image': () => { this.img.show = true }
              }
            },
            imageResize: {},
            toolbar_emoji: true,
            short_name_emoji: true,
            textarea_emoji: false,
            //  设置需要的模块为true,从外部传入模块时,直接设置即可
            tooltip: true,
            divider: true,
            undo_redo: true,
            format_brush: true
          },
          placeholder: '请输入内容',
          theme: 'snow'
        }
        let options = this.options || this.defaultOptions
        this.quill = new Quill(this.$refs.editor, options)
        this.quill.enable(false)
        this.initContent()
        if (!this.disabled) {
          this.quill.enable(true)
        }
        this.addEvents()
      }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,265评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,274评论 1 288
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,087评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,479评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,782评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,218评论 1 207
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,594评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,316评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,955评论 1 237
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,274评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,803评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,177评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,732评论 3 229
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,953评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,687评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,263评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,189评论 2 258

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    X先生_未知数的X阅读 15,933评论 3 118
  • 基于Vue的组件库 https://github.com/ElemeFE/element" element 饿了...
    _执着执着再执着阅读 32,542评论 4 230
  • 上班路上,穿梭在车流中,望望车窗外,天朗气清,干净整洁。 这个小城,永远闲适静谧,车辆适中。突然,侧前方一个轿车里...
    银子姐阅读 279评论 0 2
  • 古人云:“读万卷书,行万里路。”哲人也说:“书籍是人类进步的阶梯。”培养阅读习惯,当你的孩子爱上阅读,他将同时学会...
    伊呀学语阅读 122评论 0 0
  • 今天由于自己没有管住自己,向自己的父亲大声呵斥,说完之后虽然心里痛快了,但总觉得有点难受。 对不起,老爸。其实我想...
    尼诚阅读 343评论 0 0