Sulu 2.2.1配置CKEditor5字体插件后单媒体选择组件报错排查
Sulu CMS 2.2.1 CKEditor5字体颜色配置与媒体选择组件冲突解决
已执行操作流程
- 在
assets/admin/package.json的dependencies对象块新增依赖声明:"@ckeditor/ckeditor5-font": "^23.0.0" - 在
assets/admin/index.js新增代码:import {ckeditorPluginRegistry, ckeditorConfigRegistry} from 'sulu-admin-bundle/containers'; import Font from '@ckeditor/ckeditor5-font/src/font'; ckeditorPluginRegistry.add(Font); ckeditorConfigRegistry.add((config) => ({ toolbar: [...config.toolbar, 'fontColor', 'fontBackgroundColor'], })); - 执行构建更新命令
bin/console sulu:admin:update-build,命令交互环节依次选择:- 不覆盖本地版本的
index.js文件:【否N】 - 不覆盖本地版本的
package.json文件:【否N】 - 按提示规则合并
package.json内容:【是Y】 - 立即执行构建:【是Y】
- 不覆盖本地版本的
异常表现
- 构建完成后,text_editor内容类型的字体颜色、背景色设置功能可正常使用
- 尝试通过single_media_selection内容类型添加图片时,会跳转至空白页,浏览器控制台抛出报错
TypeError: (void 0) is not a function - 移除所有新增的配置代码后,single_media_selection组件可正常工作,但CKEditor的颜色修改功能丢失
冲突原因
存在两层触发问题:
- 配置合并逻辑缺陷:原代码中ckeditorConfigRegistry的回调直接返回仅包含toolbar字段的对象,没有保留config中的其他内置配置(包括与single_media_selection联动的图片插入、媒体选择弹窗的关联函数配置),导致这部分配置被清空,对应调用时拿到undefined的方法,触发类型报错。
- 插件版本不匹配:Sulu CMS 2.2.1内置捆绑的CKEditor5核心版本为20.0.0,所引入的
@ckeditor/ckeditor5-font@23.0.0依赖了更高版本核心才导出的内部工具函数,构建后出现模块引用错位,单线程JS执行流中,插件注册阶段的未定义函数引用会进一步放大组件加载错误。
解决步骤
- 调整依赖版本:将
assets/admin/package.json中的ckeditor-font依赖替换为与内置核心匹配的20.0.0版本:"@ckeditor/ckeditor5-font": "20.0.0" - 优化插件注册逻辑:调整
assets/admin/index.js中的代码,按需引入功能子模块,避免全局入口导入带来的兼容问题,同时完善配置合并逻辑,防止覆盖原有内置配置:import {ckeditorPluginRegistry, ckeditorConfigRegistry} from 'sulu-admin-bundle/containers'; // 按需引入对应功能模块,替代全局Font入口 import FontColor from '@ckeditor/ckeditor5-font/src/fontcolor'; import FontBackgroundColor from '@ckeditor/ckeditor5-font/src/fontbackgroundcolor'; // 分别注册所需插件子模块 ckeditorPluginRegistry.add(FontColor); ckeditorPluginRegistry.add(FontBackgroundColor); // 安全合并配置,保留原有工具栏配置 ckeditorConfigRegistry.add((config) => { const existingToolbar = config.toolbar || []; return { ...config, toolbar: [...existingToolbar, 'fontColor', 'fontBackgroundColor'], }; }); - 重新执行构建更新命令:
交互选择与之前保持一致即可,构建完成后双重验证功能可用性:确认text_editor的颜色设置功能正常,且single_media_selection的图片添加流程可正常加载。bin/console sulu:admin:update-build
注意事项:所有第三方CKEditor插件的版本号需与对应Sulu版本内置的CKEditor核心版本完全对齐,不可使用跨大版本的插件依赖;配置合并时必须保留原有config的所有字段,不可直接覆盖返回仅含修改字段的对象,避免丢失内置的组件联动逻辑。
内容的提问来源于stack exchange,提问作者Quentin H
相关产品推荐
相关产品推荐

