Django-Unfold项目集成CKEditor 5的暗色模式适配方案

在Django-Unfold项目中集成第三方富文本编辑器CKEditor 5时，开发者可能会遇到编辑器界面无法跟随系统暗色模式自动适配的问题。本文将详细介绍如何通过CSS变量和JavaScript实现CKEditor 5的暗色模式适配。

问题背景

Django-Unfold是一个现代化的Django后台管理界面框架，支持亮色和暗色模式切换。当集成CKEditor 5时，编辑器默认使用亮色主题，在暗色模式下会出现界面不协调的情况。这是因为CKEditor 5的界面颜色是通过CSS变量控制的，但默认情况下不会自动响应系统主题变化。

解决方案

核心思路

通过JavaScript检测系统主题变化，动态修改CKEditor 5的CSS变量值，实现暗色模式适配。具体步骤如下：

1. 保存CKEditor 5默认的亮色模式颜色变量
2. 检测HTML元素的class变化（Django-Unfold通过添加/移除"dark"类实现主题切换）
3. 根据当前主题动态设置CKEditor 5的CSS变量

实现代码

// 保存默认(亮色模式)CKEditor颜色变量
let defaultCKEditorColors = {
    background: getComputedStyle(document.documentElement).getPropertyValue('--ck-color-base-background'),
    text: getComputedStyle(document.documentElement).getPropertyValue('--ck-color-text'),
    border: getComputedStyle(document.documentElement).getPropertyValue('--ck-color-base-border'),
    // 其他颜色变量...
};

// 设置暗色模式颜色
function setDarkModeColors() {
    document.documentElement.style.setProperty('--ck-color-base-background', '#111827');
    document.documentElement.style.setProperty('--ck-color-text', '#ffffff');
    document.documentElement.style.setProperty('--ck-color-base-border', '#323b4b');
    // 其他暗色模式颜色设置...
}

// 恢复亮色模式颜色
function restoreLightModeColors() {
    document.documentElement.style.setProperty('--ck-color-base-background', defaultCKEditorColors.background);
    document.documentElement.style.setProperty('--ck-color-text', defaultCKEditorColors.text);
    // 其他亮色模式颜色恢复...
}

// 检测主题变化
const observer = new MutationObserver((mutations) => {
    mutations.forEach((mutation) => {
        if (mutation.attributeName === "class") {
            if (document.documentElement.classList.contains("dark")) {
                setDarkModeColors();
            } else {
                restoreLightModeColors();
            }
        }
    });
});

// 开始检测HTML元素变化
observer.observe(document.documentElement, {
    attributes: true
});

// 初始化检查
if (document.documentElement.classList.contains("dark")) {
    setDarkModeColors();
}

关键CSS变量说明

CKEditor 5使用以下主要CSS变量控制界面样式：

• --ck-color-base-background: 编辑器背景色
• --ck-color-text: 文本颜色
• --ck-color-base-border: 边框颜色
• --ck-color-button-default-hover-background: 按钮悬停背景色
• --ck-color-button-on-background: 激活按钮背景色
• --ck-color-list-button-on-background: 列表选中项背景色

集成到Django-Unfold

要将此解决方案集成到Django-Unfold项目中，可以通过以下步骤：

1. 创建一个JavaScript文件包含上述代码
2. 在Unfold配置中添加该JS文件和自定义CSS

# settings.py
UNFOLD = {
    "STYLES": [
        "css/unfold/ckeditor.css",
    ],
    "SCRIPTS": [
        "js/ckeditor-theme-adapter.js",
    ],
}

最佳实践建议

1. 颜色选择：建议使用Django-Unfold的主题色系保持一致，如示例中的#111827(背景)、#ffffff(文本)等。

2. 性能优化：对于频繁的主题切换，可以考虑使用CSS类切换而不是直接修改CSS变量。

3. 完整适配：除了基础颜色，还可以适配更多CKEditor 5的CSS变量以获得更完整的暗色模式体验。

4. 测试验证：特别注意测试编辑器工具栏、下拉菜单、对话框等组件的颜色适配情况。

通过这种方案，开发者可以轻松实现CKEditor 5在Django-Unfold项目中的暗色模式适配，提供一致的用户体验。