ckeditor富文本编辑器踩坑不完全指北

最近项目中需要开发一个问卷调查的模块,于是参考腾讯问卷使用ckeditor,该编辑器最大的优点就是可以使用行内模式(inline)。

根据官网的指引,将完整的项目包下到本地后,就可以在项目中使用了。

在项目中引入ckeditor.js即可立即使用。当然,需要在被替换的div上加上contenteditable="true"属性,该属性可以让当前dom元素可编辑。然后刷新页面,你就会发现div上方会出现toolbar工具栏。

此时会发现默认展示所有的工具,但这并不是我们想要的,因为实在太多了。这就需要我们定制config.js文件。在下载下来的插件目录中有一个index.html文件,进入根据页面提示就可以定制需要的配置文件。我的配置文件是这样的:


//定制工具栏,包括加粗、斜体、下划线、中划线、字体颜色、背景颜色、图片上传和超链接。

CKEDITOR.editorConfig = function( config ) {
    config.toolbarGroups = [
        { name: 'document', groups: [ 'mode', 'document', 'doctools' ] },
        { name: 'clipboard', groups: [ 'clipboard', 'undo' ] },
        { name: 'editing', groups: [ 'find', 'selection', 'spellchecker', 'editing' ] },
        { name: 'forms', groups: [ 'forms' ] },
        '/',
        { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ] },
        { name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi', 'paragraph' ] },
        { name: 'colors', groups: [ 'colors' ] },
        { name: 'insert', groups: [ 'insert' ] },
        { name: 'links', groups: [ 'links' ] },
        '/',
        { name: 'styles', groups: [ 'styles' ] },
        { name: 'tools', groups: [ 'tools' ] },
        { name: 'others', groups: [ 'others' ] },
        { name: 'about', groups: [ 'about' ] }
    ];


    config.removeButtons = 'Source,Save,NewPage,Preview,Print,Templates,Cut,Paste,Copy,PasteText,PasteFromWord,Undo,Redo,Find,Replace,SelectAll,Scayt,Form,Checkbox,Radio,TextField,Textarea,Select,Button,ImageButton,HiddenField,Subscript,Superscript,CopyFormatting,RemoveFormat,NumberedList,BulletedList,Outdent,Indent,CreateDiv,Blockquote,JustifyLeft,JustifyCenter,JustifyRight,JustifyBlock,BidiLtr,BidiRtl,Language,Unlink,Anchor,Flash,Table,HorizontalRule,Smiley,PageBreak,SpecialChar,Iframe,Styles,Format,Font,FontSize,Maximize,ShowBlocks,About';

    //超链接高级设置选项不显示
    config.linkShowAdvancedTab = false;

    //超链接目标选项不显示
    config.linkShowTargetTab = false;

    //鼠标悬停不展示title
    config.title = false;

    //图片上传到服务器的地址
    config.filebrowserImageUploadUrl = '/ck/upload';

    //图片上传方式
    config.filebrowserUploadMethod = 'form';

    //清空图片预览文本
    config.image_previewText=' ';

};

将配置放入到config.js后,刷新页面会发现出现定制后的工具栏。

如果项目不是SPA,或者页面中只需要一个行内富文本编辑器,到这里应该就可以了,但是公司项目采用的是VUE,这就涉及到一个加载顺序和渲染的问题了。

我这里的做法是每次新创建编辑器DOM的时候,就先把所有的编辑器实例销毁掉然后重新初始化。代码如下:

//全部重新初始化
setTimeout(()=>{
   let node = Object.keys(CKEDITOR.instances);

   for (let i = 0; i < node.length; i++) {
       let item = CKEDITOR.instances[node[i]];
       if (item) {
           //销毁所有实例
           item.destroy(true);
       }
   }
   
   //重新初始化
   CKEDITOR.inlineAll();
},100);

这样,页面就不报错了。

最难搞的要数图片上传。上面config的配置大部分都是来配置上传图片的内容。而且需要后台兄弟的配合,返回特定的内容。

当配置了图片上传到服务器的地址后,图片上传的dialog会出现上传的tab页,选好图片上传到指定服务器后,需要让服务器返回如下脚本:

// 图片地址为腾讯问卷返回的地址
<script>window.parent.CKEDITOR.tools.callFunction(1, 'https://cdn.ur.qq.com/uploadImages//2018-04-19/201804191805395ad869f38787d.PNG', '');</script>

//上传图片时,插件会自动在上传请求后拼接如下内容
CKEditor=editor&CKEditorFuncNum=1&langCode=zh-cn

//而返回脚本内方法的第一个参数就是拼接内容CKEditorFuncNum的值。此处为1

当成功返回后,dialog就会出现图片的绝对路径和预览。同时也会出现默认给图片设置宽高的style值。可是这并不是我们想要的,如果需要去除默认设置宽高,需要更改ckeditor image插件的配置文件了。下面方法适用于最新版本4.9.1。以前版本不保证可用。

打开目录ckeditor\plugins\image\dialogs中的image.js文件,找到如下代码的位置:

if ("true" == c.getCustomData("isReady"))
 { 
var d = a.getContentElement("info", "txtWidth"),
 f = a.getContentElement("info", "txtHeight"), g; 
b ? c = g = 0 : (g = c.$.width, c = c.$.height); 
d && d.setValue(g); f && f.setValue(c) 
}

setValue的值设置为null即可。然后刷新页面再上传图片就会发现默认值不存在了。

总结:这是目前为止,踩过的坑并找到的解决方案,期间阅读了不少次纯英文的API,实在是痛苦。大致来说,使用起来的流程如下:

下载完整版的插件,修改config.js并引入到项目中。将需要替换的div加上contenteditable="true",如果是SPA,还需要手动销毁所有已创建的实例,防止页面报错。难点是在图片上传,一定需要让后台配合修改。防止跨域,并返回指定的脚本内容。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,043评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,649评论 18 139
  • ckeditor是一个老牌的编辑器,GitHub上有一个第三方模块django-ckeditor封装了所有功能,把...
    Absolute_A阅读 4,496评论 16 7
  • 一个月没动过笔,高中练了那么久的字也算是废了。亦没怎么看书,文学离我倒不是很远,手头上书多着呢,但也有种距离感。不...
    真正的夏新旬阅读 165评论 0 0
  • 记忆中上一个儿童节好像还是昨天的事,我依稀还记得儿童节前几日,和同学们在操场上排练节目,无非就是简单的蹦蹦跳跳,在...
    手创派阅读 176评论 0 0