当前位置:

首页 > 编程开发 > 最新版CKEditor的配置方法及插件(Plugin)编写示例

最新版CKEditor的配置方法及插件(Plugin)编写示例

CKEditor是开源HTML编辑器,通过编辑config.js配置文件可自定义工具栏和字体大小。插件开发以分页插件为例:在插件目录plugins下创建名为apage的子文件夹,编写plugin.js实现对话框或直接插入分页符,需在配置中声明extraPlugins参数以加载该插件。

本文目录

    FCKEditor重写了JS框架,并更名为CKEditor。第一次在官方demo页面上看到它时,就被那种清爽的界面和扎实的功能吸引住了——毫不夸张地说,CKEditor称得上是目前开源领域最优秀的多媒体HTML编辑器之一。

    这篇文章会详细记录整个配置过程,同时以文章分页插件为例,简单梳理一下CKEditor插件的编写思路。先从官网http://ckeditor.com/download下载最新版,解压到项目目录,准备工作就算完成了。

    1. 调用CKEditor方法

    在页面里加载核心JS文件:。然后像往常一样放置一个textarea,比如:

    在textarea后面加上一行JS:,这就搞定了。其他调用方式可以参考 _samples 目录下的示例。

    2. 配置个性化工具栏

    CKEditor默认的工具栏里有很多按钮其实用不上,或者对中文场景来说不太合适。最省事的办法就是直接修改配置文件 config.js。下面是我的配置内容:

    CKEDITOR.editorConfig = function( config ) {
        // Define changes to default configuration here. For example:
        // config.language = 'fr';
        config.uiColor = '#ddd';
        config.toolbar = 'Cms';
        config.toolbar_Cms = [
            ['Source','-'],
            ['Cut','Copy','Paste','PasteText','PasteFromWord','-'],
            ['Undo','Redo','-','Find','Replace','RemoveFormat'],['Link','Unlink','Anchor'],
            ['Image','Flash','Table','HorizontalRule', '-'],['Maximize'],
            '/',
            ['Bold','Italic','Underline','Strike','-'],
            ['FontSize'],['TextColor','BGColor'],
            ['NumberedList','BulletedList','-','Outdent','Indent','pre'],
            ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
            ['PageBreak', 'Page']
        ];
        config.filebrowserUploadUrl = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files';
        config.fontSize_sizes = '10/10px;12/12px;14/14px;16/16px;18/18px;20/20px;22/22px;24/24px;28/28px;32/32px;48/48px;';
        config.extraPlugins = 'apage';
    };

    3. 将编辑器内文字修改为14px

    默认12px对中文显示效果不太理想,改为14px会舒服很多。需要改两个地方:

    • 可视化编辑里的默认字体大小:修改根目录下的 contents.css,把 body 中的 font-size: 12px 改为 font-size: 14px。
    • 源代码视图的字体大小:修改 skins\kama\editor.css,在最后加上一句:.cke_skin_kama textarea.cke_source { font-size:14px; }。

    4. 插件编写流程和实例代码

    下面就以一个文章分页插件为例,走一遍完整的插件开发流程。

    4.1 创建插件目录和文件

    在 plugins 目录下新建文件夹 apage,然后在里面新建 plugin.js,内容如下:

    CKEDITOR.plugins.add( 'apage', {
        init : function( editor ) {
            // Add the link and unlink buttons.
            editor.addCommand( 'apage', new CKEDITOR.dialogCommand( 'apage' ) );
            editor.ui.addButton( 'Page', {
                //label : editor.lang.link.toolbar,
                label : "Page",
                //icon: 'images/anchor.gif',
                command : 'apage'
            } );
            //CKEDITOR.dialog.add( 'link', this.path + 'dialogs/link.js' );
            CKEDITOR.dialog.add( 'apage', function( editor ) {
                return {
                    title : '文章分页',
                    minWidth : 350,
                    minHeight : 100,
                    contents : [
                        {
                            id : 'tab1',
                            label : 'First Tab',
                            title : 'First Tab',
                            elements : [
                                {
                                    id : 'pagetitle',
                                    type : 'text',
                                    label : '请输入下一页文章标题
    (不输入默认使用当前标题+数字形式)' } ] } ], onOk : function() { editor.insertHtml("[page="+this.getValueOf( 'tab1', 'pagetitle' )+"]"); } }; } ); }, requires : [ 'fakeobjects' ] } );

    4.2 在工具栏中添加按钮并声明扩展插件

    在工具栏中加一项 Page,并在配置中声明扩展插件 config.extraPlugins = 'apage';。有两种方法:

    • 方法一:直接在 config.js 中添加(参考上面第2节的示例)。
    • 方法二:在引用CKEditor的地方加配置参数,比如:
    CKEDITOR.replace( 'editor1', {
        extraPlugins : 'examenLink',
        toolbar : [
            ['Undo','Redo','-','Cut','Copy','Paste'],
            ['ExamenLink','Bold','Italic','Underline',],
            ['Link','Unlink','Anchor','-','Source'],['Page']
        ]
    });

    此时你会看到编辑器里多了一个空白的按钮。

    最新版CKEditor的配置方法及插件(Plugin)编写示例

    4.3 解决空白按钮的问题

    空白按钮是因为插件没有指定图标。有两种解决办法:

    • 方法1:修改插件代码,在 plugin.js 中将 icon 定义为一个存在的图标。
    • 方法2:让按钮显示Label文字。在放置编辑器的页面里加CSS:

    注意CSS中的 cke_button_apage 名称需要与实际保持一致。

    如果你的分页只需要插入一个分页符,不需要填写标题,那更简单,直接修改插件代码即可。下面给出两种常见实现:

    4.4 分页插件完整代码示例

    插件1:弹出对话框,提示输入下一页标题

    CKEDITOR.plugins.add( 'apage',{
        init : function( editor ){
            // Add the link and unlink buttons.
            editor.addCommand( 'apage', new CKEDITOR.dialogCommand( 'apage' ) );
            editor.ui.addButton( 'Page',{
                //label : editor.lang.link.toolbar,
                label : "Page",
                //icon: 'images/anchor.gif',
                command : 'apage'
            } );
            //CKEDITOR.dialog.add( 'link', this.path + 'dialogs/link.js' );
            CKEDITOR.dialog.add( 'apage', function( editor ){
                return {
                    title : '文章分页',
                    minWidth : 350,
                    minHeight : 100,
                    contents : [{
                        id : 'tab1',
                        label : 'First Tab',
                        title : 'First Tab',
                        elements :[{
                            id : 'pagetitle',
                            type : 'text',
                            label : '请输入下一页文章标题
    (不输入默认使用当前标题+数字形式)' }] }], onOk : function(){ editor.insertHtml("[page="+this.getValueOf( 'tab1', 'pagetitle' )+"]"); } }; } ); }, requires : [ 'fakeobjects' ] } );

    插件2:直接插入分页符
    (注意:使用过程中需要将『page』中的『』去掉,因为编辑器默认会转码)

    CKEDITOR.plugins.add( 'apage',{
        var cmd = {
            exec:function(editor){
                editor.insertHtml("[[『page』]]");
            }
        }
        init : function( editor ){
            // Add the link and unlink buttons.
            editor.addCommand( 'apage', cmd );
            editor.ui.addButton( 'Page',{
                //label : editor.lang.link.toolbar,
                label : "Page",
                //icon: 'images/anchor.gif',
                command : 'apage'
            } );
        },
        requires : [ 'fakeobjects' ]
    } );
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    ckeditor和ueditor那个好 CKEditor和UEditor使用比较
    ckeditor和ueditor那个好 CKEditor和UEditor使用比较

    CKEditor功能成熟但需自行编写较多逻辑;UEditor界面美观、开箱即用,但前后台交互较复杂,上传配置需注意路径前缀,还需处理Struts过滤器对静态请求的拦截问题。两者各有侧重,需根据项目需求选择。

    ckeditor syntaxhighlighter代码高亮插件配置分享
    ckeditor syntaxhighlighter代码高亮插件配置分享

    通过整合SyntaxHighlighter插件,为CKEditor添加代码高亮功能。需下载编辑器与插件,创建insertcode插件并编写plugin.js与dialog.js,修改ckeditor.js配置以注册插件并添加工具栏按钮,最后在语言文件中添加映射。该方法支持多种编程语言代码的插入与高亮显示。

    CKEditor中加入syntaxhighlighter代码高亮插件
    CKEditor中加入syntaxhighlighter代码高亮插件

    在CKEditor3.3.1中集成SyntaxHighlighter需新建insertcode插件目录,包含plugin.js、对话框配置及图标;修改ckeditor.js添加插件引用,调整语言文件,在前端引入样式与脚本,完成插入代码高亮功能。

    dedecms ckeditor编辑器添加链接默认新窗口打开的修改方法
    dedecms ckeditor编辑器添加链接默认新窗口打开的修改方法

    用DEDECMS做网站的朋友,多半都遇到过这个小小的困扰:文章页里插入的链接,默认总是直接在当前窗口跳转,而不是在新标签页打开。去网上搜一下,找到的教程几乎全是针对老版FCKeditor的,而DEDECMS v5.7 默认搭载的已经是ckeditor编辑器了。这里简单记一下修改方法,希望能帮到同样被

    ckeditor插件开发简单实例
    ckeditor插件开发简单实例

    具体步骤:在CKeditor中开发自定义插件,先创建插件文件夹并放置图标,然后编写plugin.js实现选中文字后自动插入一个带超链接的图标,最后修改config.js加载插件并配置工具栏按钮,即可在编辑器中使用该插件。

    SyntaxHighlighter配合CKEditor插件轻松打造代码语法着色
    SyntaxHighlighter配合CKEditor插件轻松打造代码语法着色

    基于3.0.83版SyntaxHighlighter与3.5.3版CKEditor,整理了一套代码语法着色集成方案。在CKEditor中开发insertcode插件,通过配置config.js添加工具栏按钮,实现在页面中插入代码并高亮显示,支持多种编程语言,提升代码可读性。

    PHP中CKEditor和CKFinder配置问题小结
    PHP中CKEditor和CKFinder配置问题小结

    在PHP中配置CKEditor和CKFinder时,需预设config.js的默认设置,使用PHP类生成编辑器,设置CKFinder的CheckAuthentication函数通过session验证,利用session定位上传路径,并采用日期重命名上传文件以防乱码,最后通过CKFinder::SetupCKEditor实现两者配合,提升安全性。

    ckeditor syntaxhighlighter代码高亮插件,完美修复
    ckeditor syntaxhighlighter代码高亮插件,完美修复

    针对CKeditor与FCKeditor对象模型差异,采用先插入新节点再删除原节点的方法修复代码高亮插件。高级配置新增“不自动转换超链接”选项,用户可自由控制代码中网址是否自动转为超链接,提升灵活性。

    当使用ckeditor控件时,需要校验输入内容是否为空的一种解决办法(转帖)
    当使用ckeditor控件时,需要校验输入内容是否为空的一种解决办法(转帖)

    CKEditor内容非空验证失效,因编辑器在表单提交后才更新隐藏域,验证脚本提前读取空值。解决方法:在验证函数中取消表单提交,利用setTimeout延迟50毫秒,待编辑器完成同步后再执行验证和提交。

    CKeditor与syntaxhighlight打造joomla代码高亮
    CKeditor与syntaxhighlight打造joomla代码高亮

    具体步骤如下:在Joomla1.5.9版本中,首先安装CKEditor编辑器及SyntaxHighlighter语法高亮插件,然后修改ckeditor.js文件,在其中添加插件引用和工具栏按钮配置,最后在模板index.php文件中引入对应的JavaScript和CSS文件,最终即可成功实现代码语法高亮显示功能。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。