CKEditor系列(四)支持动态多语言i18n
CKEditor系列(四)支持动态多语言i18n
多语言文件结构
先看下CKEditor4的多语言文件长什么样子
//src/lang/zh-cn.js
CKEDITOR.lang[ 'zh-cn' ] = {
editor: '所见即所得编辑器',
common: {
editorHelp: '按 ALT+0 获得帮助',
keyboard: {
8: '退格键',
},
}
};
也就是直接将对应的语言值提前写入到文件中去。
使用多语言变量
有时候公司会有自己的多语言平台,公司项目实现多语言语言将它改成这样才行
//src/lang/zh-cn.js
CKEDITOR.lang[ 'zh-cn' ] = {
editor: window.i18n['ck4.editor'],
common: {
editorHelp: window.i18n['ck4.common.editorHelp'],
keyboard: {
8: window.i18n['ck4.common.keyboard'],
},
}
};
然后我们再根据项目中的语言来控制对应的window.i18n
里面的值。
为了让CKEditor的更方便独立管理,我们有时需要将它独立成一个项目。这时候CKEditor这个项目在打包的时候,其实很可能是没有window.i18n的,及时有也不行(以/src/lang/zh-cn.js
里面的editor
为例),我们需要的是让它的value为window.i18n['ck4.editor'],而不是它当前的值所见即所得编辑器,因为我们需的是个动态的变量,而不是当前某个静态的字符串。
将字符串替换成"变量"
因为我们直接简单JavaScript的话不容直接将一个变量作为value给一个对象,所以想到了可以借助于babel这样的工具,在它的眼里,一个js文件里面的值都只是字符串,所谓的变量也只是稍微有点“特殊”而已。
我们可以将自己多语言文件//src/lang/zh-cn.js简单改造后,再解析成AST(抽象语法树),然后再进行后续操作。
CKEDITOR.lang[ 'zh-cn' ] = {
editor: "window.i18n['ck4.editor']",
common: {
editorHelp: "window.i18n['ck4.common.editorHelp']",
keyboard: {
8: "window.i18n['ck4.common.keyboard']",
},
}
};
对的,就是将这个变量的作为string来作为value,bable的工作就是把"window.i18n['ck4.editor']"
替换成window.i18n['ck4.editor']
。
babel插件
我们可以将上述的转换过程写成一个babel插件
module.exports = function({types, template}, options, dirname){
return {
visitor: {
StringLiteral: function (path, state) {
// 未转换前value形如为"window.i18n['ck4.editor']"的字符串
if (path.node.value.match(/^window/)) {
path.replaceWithSourceString(path.node.value);
// path.replaceWith(template.ast(path.node.value)); // 亦可
}
}
}
}
};
上的注释写的很清楚了,使用path.replaceWithSourceString(path.node.value)
或者 path.replaceWith(template.ast(path.node.value))
两种方式都可以完成需求
总结
我们根据公司的多语言平台的使用要求改造CKEditor编辑的多语言文件内容,主要的难点在于怎么把里面key的value只是使用变量,而非该变量的值,变量的求值过程是在我们项目使用的时候进行,这样就实现了多语言的动态化。借助babel和AST来帮助我们处理这个转换过程。
- 分类:
- Web前端
相关文章
CKEditor系列(一)CKEditor4项目怎么跑起来的
我们先看CKEditor的入口ckeditor.js,它里面有一部分是压缩版,压缩版部分对应的源码地址为src/core/ckeditor_base.js // src/core/ckedit 阅读更多…
2021年的一点工作总结(二)富文本编辑器
邮件项目的核心功能就是编辑邮件了,所以文本的编辑特别容易被用户吐槽了。用户报障的时候一个万能的吐槽点“没有xxx功能,不支持xxx,没有Outlook好用”。 其实作为一个web产品,如果需要更加公 阅读更多…
CKEditor富文本编辑器职责分离
背景 CKEditor富文本 编辑器 (生产版本1.1.1及以前)里面包含富文本基础插件及当前最新的邮件特定的业务插件(签名、快捷回复、邀评、默认样式、选择颜色、插入图片、粘贴模式) O端 阅读更多…
富文本编辑器CKEditor4迁移方案
之前写过 《富文本编辑器wangEditor迁移CKEditor前后效果对比》 ,结合大家的反馈后进行了调整。 增加了具体案例的展示CKEditor插件和事件系统,重新整理成迁移方案。 一、背景 阅读更多…
CKEditor系列(三)粘贴操作是怎么完成的
在上一篇文章 CKEditor系列(二)事件系统是怎么实现的 中,我们了解了CKEditor中事件系统的运行流程,我们先简单回顾下: 用户注册回调函数时可以指定优先级,值越小的优先级越高,默 阅读更多…
富文本编辑器wangEditor迁移CKEditor前后效果对比
一、背景 富文本编辑器wangEditor的工具栏如图所示 富文本编辑器CKEditor4工具栏如图所示 二、wangEditor编辑器存在问题 1. 字号和字体设置 阅读更多…