后端配置项说明
ueditor的配置项分为两类:前端配置项 和 后端配置项
前端配置项具体看这个文档:前端配置项说明
本文档介绍后端配置项的使用
参数配置
前后端的配置统一写在后端(PHP版本的config在php/config.json),编辑器实例化时,异步读取后端配置信息,覆盖到前端的配置里。
各处配置优先级
后端获取的配置项 > 实例化传入的配置项 > ueditor.config.js文件的配置项。
读取配置项
读取配置项可以通过getOpt方法读取
var lang = ue.getOpt('lang'); //默认返回:zh-cn
相关方法和事件
实例化的ue对象上有以下几个方法:
-
[方法]:loadServerConfig 执行这个方法,会向后端请求config
-
[方法]:isServerConfigLoaded 判断是否已加载后端config
-
[方法]:afterConfigReady 加载后端配置项结束后会执行回调函数,假如已加载,立即执行该回调函数
-
[事件]:serverConfigLoaded 加载后端配置项结束后,会触发这个事件
配置项说明
1. 上传图片配置项
- imageActionName {String} [默认值:"uploadimage"] //执行上传图片的action名称,
- imageFieldName {String} [默认值:"upfile"] //提交的图片表单名称
- imageMaxSize {Number} [默认值:2048000] //上传大小限制,单位B
- imageAllowFiles {String} , //上传图片格式显示
//默认值: [".png", ".jpg", ".jpeg", ".gif", ".bmp"]
- imageCompressEnable {Boolean} [默认值:true] //是否压缩图片,默认是true
- imageCompressBorder {Number} [默认值:1600] //图片压缩最长边限制
- imageInsertAlign {String} [默认值:"none"] //插入的图片浮动方式
- imageUrlPrefix {String} [默认值:""] //图片访问路径前缀
- imagePathFormat {String} [默认值:"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
2. 涂鸦图片上传配置项
- scrawlActionName {String} [默认值:"uploadscrawl"] //执行上传涂鸦的action名称
- scrawlFieldName {String} [默认值:"upfile"] //提交的图片表单名称
- scrawlPathFormat {String} [默认值:"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
- scrawlMaxSize {Number} [默认值:2048000] //上传大小限制,单位B
- scrawlUrlPrefix {String} [默认值:""] //图片访问路径前缀
- scrawlInsertAlign {String} [默认值:"none"]
3. 截图工具上传
- snapscreenActionName {String} [默认值:"uploadimage"] //执行上传截图的action名称
- snapscreenPathFormat {String} [默认值:"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
- snapscreenUrlPrefix {String} [默认值:""] //图片访问路径前缀
- snapscreenInsertAlign {String} "none", //插入的图片浮动方式
4. 抓取远程图片配置
- catcherLocalDomain {Array} 默认值:["127.0.0.1", "localhost", "img.baidu.com"]//例外的图片抓取域名
- catcherActionName {String} [默认值:"catchimage"] //执行抓取远程图片的action名称
- catcherFieldName {String} [默认值:"source"] //提交的图片列表表单名称
- catcherPathFormat {String} [默认值:"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
- catcherUrlPrefix {String} [默认值:""] //图片访问路径前缀
- catcherMaxSize {Number} [默认值:2048000] //上传大小限制,单位B
- catcherAllowFiles {Array}, //抓取图片格式显示
//默认值: [".png", ".jpg", ".jpeg", ".gif", ".bmp"]
5. 上传视频配置
- videoActionName {String} [默认值:"uploadvideo"] //执行上传视频的action名称
- videoFieldName {String} [默认值:"upfile"] //提交的视频表单名称
- videoPathFormat {String} [默认值:"/ueditor/php/upload/video/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
- videoUrlPrefix {String} [默认值:""] //视频访问路径前缀
- videoMaxSize {Number} [默认值:102400000] //上传大小限制,单位B,默认100MB,注意修改服务器的大小限制
- videoAllowFiles {Array}, //上传视频格式显示
//默认值: [ ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg", ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid" ]
6. 上传文件配置
- fileActionName {String} [默认值:"uploadfile"] //controller里,执行上传视频的action名称
- fileFieldName {String} [默认值:"upfile"] //提交的文件表单名称
- filePathFormat {String} [默认值:"/ueditor/php/upload/file/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置
- fileUrlPrefix {String} [默认值:""] //文件访问路径前缀
- fileMaxSize {Number} [默认值:51200000] //上传大小限制,单位B,默认50MB,注意修改服务器的大小限制
- fileAllowFiles {Array}, //上传文件格式显示
//默认值: [ ".png", ".jpg", ".jpeg", ".gif", ".bmp", ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg", ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid", ".rar", ".zip", ".tar", ".gz", ".7z", ".bz2", ".cab", ".iso", ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".pdf", ".txt", ".md", ".xml" ]
7. 列出指定目录下的图片
- imageManagerActionName {String} [默认值:"listimage"] //执行图片管理的action名称
- imageManagerListPath {String} [默认值:"/ueditor/php/upload/image/"] //指定要列出图片的目录
- imageManagerListSize {String} [默认值:20] //每次列出文件数量
- imageManagerUrlPrefix {String} [默认值:""] //图片访问路径前缀
- imageManagerInsertAlign {String} [默认值:"none"] //插入的图片浮动方式
- imageManagerAllowFiles {Array}, //列出的文件类型
//默认值: [".png", ".jpg", ".jpeg", ".gif", ".bmp"]
8. 列出指定目录下的文件
- fileManagerActionName {String} [默认值:"listfile"] //执行文件管理的action名称
- fileManagerListPath {String} [默认值:"/ueditor/php/upload/file/"] //指定要列出文件的目录
- fileManagerUrlPrefix {String} [默认值:""] //文件访问路径前缀
- fileManagerListSize {String} [默认值:20] //每次列出文件数量
- fileManagerAllowFiles {Array} //列出的文件类型
//默认值: [ ".png", ".jpg", ".jpeg", ".gif", ".bmp", ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg", ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid", ".rar", ".zip", ".tar", ".gz", ".7z", ".bz2", ".cab", ".iso", ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".pdf", ".txt", ".md", ".xml" ]