QuillJs扩展使用——富文本编辑支持表格

quill v1.0 版本不支持插入表格,v2的dev版本支持表格编辑,但目前只能实现在工具栏以外的地方放置按钮,实现点击按钮添加/操作表格,作者已声明:You can do npm install quill@2.0.0-dev.2 but yes use at your own risk.(最新版本为quill@2.0.0-dev.3)

实现目标:在工具栏添加表格操作按钮

初选方案一

在quill v1.0 版本基础上对quil添加扩展代码从而支持表格,在github上有找到对应的项目https://github.com/dost/quilljs-table ,这个项目中包含两个demo以不同的方式支持表格,分别在quilljs-table和table文件夹中。

优点:

  • 在工具栏插入表格操作按钮
  • 插入表格的行数和列数可选
  • 支持修改表格背景色

缺点:

  • 某些表格操作会导致控制台报错
  • 工具栏中的表格操作按钮用文本表示(无图标)

终选方案二

在工具栏添加表格操作图标,使用quill@2.0.0-dev.3中的表格操作方法为图标添加自定义处理方法 ,可实现简单的表格操作,目前较为稳定,暂未发现问题。

quill支持配置自定义的工具栏图标container和事件处理程序handlers

  1. 配置自定义容器
    • 配置toolbar的数组选项从而定制工具栏的功能
      <div id="editor"></div>
      <script>
        var toolbarOptions = [
          'bold',
          'italic',
          'underline',
          [
            { 'table-body': 'TBODY' },
            { 'table-insert-rows': 'ITR' },
            { 'table-insert-columns': 'TIC' },
            { 'table-delete-rows': 'IDR' },
            { 'table-delete-columns': 'TDC' },
            { 'table-delete-body': 'TDB' }
          ]
        ];
        // 工具栏支持加粗、斜体、下划线等功能,quilljs会根据这些名称在工具栏创建对应的按钮(button标签),绑定对应的class
        
        const quill = new Quill('#editor', { // 'editor'为编辑框对应元素的id
          modules: {
            toolbar: {
              container: toolbarOptions
            }
          }
        });
       </script>
      
    • 上面的方法只能在工具栏创建quilljs内部定好的按钮格式,如果想创建完全自定义的工具栏,参考下面代码
      <div id="toolbar">
        <!-- 此类按钮,quill会根据类名添加对应的事件处理程序 -->
        <button class="ql-bold"></button>
        <button class="ql-italic"></button>
        
        <!--此类自定义按钮,可自行添加对应的事件处理程序 -->
        <button id="custom-button"></button>
      </div>
      <div id="editor"></div>
      
      <script>
        const quill = new Quill('#editor', {
         modules: {
            toolbar: '#toolbar'
          }
        });
      </script>
      
  2. 配置自定义处理程序
    <script>
      let toolbarOptions = {
        handlers: {
          'table-body': function (val) {
            this.quill.getModule('table').insertTable(2, 2) // this引用工具栏实例, val表示按钮是否处于活动状态active
          },
          'table-insert-rows': function () {
            this.quill.getModule('table').insertRowBelow()
          },
          'table-insert-columns': function () {
            this.quill.getModule('table').insertColumnRight()
          },
          'table-delete-rows': function () {
            this.quill.getModule('table').deleteRow()
          },
          'table-delete-columns': function () {
           this.quill.getModule('table').deleteColumn()
          },
          'table-delete-body': function () {
            this.quill.getModule('table').deleteTable()
          }
        }
      }
      const quill = new Quill('#editor', {
        modules: {
          toolbar: toolbarOptions
        }
      });
    
      // 也可以按照如下方法添加自定义处理程序
      const toolbar = quill.getModule('toolbar');
      toolbar.addHandler('image', showImageUI);
    </script>
    
  3. 注意事项
  • quilljs升级到v2.0,pasteHTML方法改为dangerouslyPasteHTML,如果使用vue-quill-editor,需要修改对应方法;
  • 在创建Quill实例时,配置项中的module属性需要设置table: true,从而使quill实例能够使用table操作方法;
  • 在工具栏toolbar中添加表格按钮后,quill并不会自动拿到对应的图标,需要手动为按钮添加图标,如:
    <script>
      const TB = document.getElementsByClassName('ql-table-body')[0]
      TB.innerHTML = `<svg viewbox="0 0 18 18"><rect class="ql-stroke" height="12" width="12" x="3" y="3"></rect><rect class="ql-fill" height="2" width="3" x="5" y="5"></rect><rect class="ql-fill" height="2" width="4" x="9" y="5"></rect><g class="ql-fill ql-transparent"><rect height="2" width="3" x="5" y="8"></rect><rect height="2" width="4" x="9" y="8"></rect><rect height="2" width="3" x="5" y="11"></rect><rect height="2" width="4" x="9" y="11"></rect></g></svg>`
    </script>
    
  • 如果不使用2中所述方法添加自定义处理程序,而是通过获取按钮元素并对其添加点击事件处理程序的方法,则会导致首次点击按钮报错,这可能是quill为toolbar中所有按钮添加了默认处理程序的原因,所以最好使用官方提供的方法。
  1. 参考资料
  1. 结果展示
Quill富文本编辑支持表格.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • 内容 抽屉菜单 ListView WebView SwitchButton 按钮 点赞按钮 进度条 TabLayo...
    小狼W阅读 1,608评论 0 10
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,943评论 4 60
  • 1 最近刷微博,看到一则消息,吉林长春一位妈妈顺利剖宫产下两男两女四胞胎,我心里在想,这个妈妈实在太不容易了,希望...
    夜楠往事阅读 2,657评论 4 13
  • 熟悉中数着你的心跳 你的名字是风铃编成的歌谣 就这样陪你变老 在最好的年纪 遇到最美的你 我想这便是人生中最美好的...
    张云祈阅读 527评论 2 7
  • 第一城:杭州 桂花谢了,穿毛衣爬山会微微出汗的天儿是好秋天。 昨晚见了朋友回到民宿,刚好遇到匆忙拉开木门进入厅内的...
    山女画眉鸟阅读 282评论 0 1