当前位置:

首页 > 编程开发 > CKEDITOR二次开发之插件开发方法

CKEDITOR二次开发之插件开发方法

CKEditor插件开发需在plugins目录创建插件文件夹,包含plugin.js注册插件与命令、图标文件,以及dialogs目录定义对话框逻辑。随后修改ckeditor.js注册插件,添加语言文件,并配置工具栏,即可实现自定义按钮功能。

本文目录

    在开始之前,先聊聊CKEditor源码的组织形式,对于理解后续的插件开发会很有帮助。CKEditor的源文件都放在ckeditor_source目录下。核心功能,比如DOM元素操作、事件处理、初始化脚本和一些环境设置,集中在ckeditor_source\core文件夹里。而其他功能,比如格式化、复制粘贴、图片和链接,都是以插件形式实现的,放在ckeditor_source\plugins文件夹内。每个插件都有一个独立的文件夹,里面有个plugin.js文件,存放了该插件的核心代码。

    你可以看到,源代码被分散在不同的文件中。为了减少HTTP请求,CKEditor最终把这些文件压缩打包成ckeditor.js和ckeditor_basic.js,加载起来更高效。

    创建一个日期插件(date)

    接下来,我们一步步实现一个日期插件。整个过程可以分为几个清晰的步骤。

    1. 创建插件目录与核心文件

    首先,在ckeditor\plugins\目录下新建一个名为date的文件夹。然后,在date文件夹内创建plugin.js文件,并输入以下代码。这段代码的作用是注册插件,并绑定一个对话框命令。

    CKEDITOR.plugins.add('date', {  requires: ['dialog'],  init: function (a) {    var b = a.addCommand('date', new CKEDITOR.dialogCommand('date'));    a.ui.addButton('date', {      label: a.lang.date.toolbar,      command: 'date',      icon: this.path + 'images/date.jpg'    });    CKEDITOR.dialog.add('date', this.path + 'dialogs/date.js');  }});

    2. 准备图标文件

    在date文件夹下新建一个images目录,放入一张名为date.jpg的图标图片。可以从网上找一张16x16像素的图标,大小刚好合适。

    3. 编写对话框逻辑

    在date文件夹下新建一个dialogs目录,然后创建date.js文件,输入以下代码。这个文件定义了插件弹出的对话框内容,包括输入框和说明文字。

    CKEDITOR.dialog.add('date', function(editor){  var escape = function(value){    return value;  };  return {    title: '日历控件',    resizable: CKEDITOR.DIALOG_RESIZE_BOTH,    minWidth: 300,    minHeight: 80,    contents: [{      id: 'cb',      name: 'cb',      label: 'cb',      title: 'cb',      elements: [{        type: 'text',        label: '请输入日期控件名称',        id: 'lang',        required: true,      },{        type:'html',        html:'

    说明:日历控件选择的日期、时间将回填到该输入框中。

    ' }] }], onOk: function(){ lang = this.getValueOf('cb', 'lang'); editor.insertHtml("

    " + lang + "

    "); }, onLoad: function(){ } };});

    4. 将插件注册到CKEditor核心

    下一步,需要将插件加入到CKEditor的配置中。这里我们直接修改核心文件ckeditor.js。以现有的about插件为参考,查找about,找到类似这样的行:

    fullPage:false,height:200,plugins:'about,basicstyles

    在about后面加上date,变成:

    plugins:'about,date,basicstyles

    继续查找about,找到类似这样的代码段:

    j.add('about',{init:function(l){var m=l.addCommand('about',new a.dialogCommand('about'));m.modes={wysiwyg:1,source:1};m.canUndo=false;l.ui.addButton('About',{label:l.lang.about.title,command:'about'});a.dialog.add('about',this.path+'dialogs/about.js');}});

    在这段代码前面,插入新插件的注册代码:

    j.add('date', {requires: ['dialog'],init: function(l){l.addCommand('date', new a.dialogCommand('date'));l.ui.addButton('date', {label: l.lang.date.toolbar,command: 'date',icon: this.path + 'images/code.jpg'});a.dialog.add('date', this.path + 'dialogs/date.js');}});

    接下来,查找i.toolbar_Basic=,这是CKEditor默认的工具栏配置。在工具栏中合适的位置添加date,例如:

    ['Maximize','ShowBlocks','-','date']

    5. 添加语言文件

    打开ckeditor\lang\zh-cn.js文件,在里面增加一行语言配置,让中文界面能正确显示插件名称:

    ,date:{toolbar: '日期控件'}, link: { toolbar: '编辑超链接', other: '<其他>', 

    6. 配置工具栏显示

    如果需要自定义工具栏,可以打开config.js进行配置。例如,在配置数组中添加date按钮:

    /*Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.For licensing, see LICENSE.html or http://ckeditor.com/license*/CKEDITOR.editorConfig = function( config ){  config.toolbar =  [    ['Source'],    ['Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Print', 'Link', 'Unlink', 'Anchor'],    ['Undo', 'Redo', '-', 'Find', 'Replace', '-', 'SelectAll', 'ImageButton', 'Image'],    ['Styles', 'Format', 'Font', 'FontSize'],    ['TextColor', 'BGColor'],    ['date'] // 刚创建的日期插件(date)  ];};

    到这里,对CKEditor的修改就完成了。运行后,工具栏上会出现一个新的日期控件按钮,点击即可弹出对话框进行操作。

    实例图片:

    CKEDITOR二次开发之插件开发方法

    CKEDITOR二次开发之插件开发方法

    CKEDITOR二次开发之插件开发方法

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

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

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

    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 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。