
以下是一份详细的UEditor使用指南,结合官方文档及最佳实践编写功能说明:
(基于百度UEditor富文本编辑器,版本适配2025年最新配置)
下载资源包
ueditor.config.js
(配置文件)、ueditor.all.js
(核心库)及themes
(主题文件)等。引入资源文件
在HTML页面头部添加以下代码:
<!-- 引入CSS样式 -->
<link rel="stylesheet" href="/ueditor/themes/default/css/ueditor.css">
<!-- 引入核心JS -->
<script src="/ueditor/ueditor.config.js"></script>
<script src="/ueditor/ueditor.all.js"></script>
创建编辑器容器
<div id="editor-container" style="height: 500px;"></div>
初始化编辑器
在页面底部添加初始化脚本:
var ue = UE.getEditor('editor-container', {
initialFrameWidth: '100%', // 宽度自适应
initialFrameHeight: 500, // 初始高度
autoHeightEnabled: false, // 关闭自动增高(适合固定高度场景)
toolbars: [ // 自定义工具栏按钮
['bold', 'italic', 'underline', 'fontsize', 'forecolor'],
['insertimage', 'insertvideo', 'link', 'undo', 'redo']
]
});
常用配置项说明
autoClearinitialContent: false
:保留初始化内容。 elementPathEnabled: false
:隐藏底部元素路径栏。 serverUrl: '/upload'
:文件上传接口地址(需后端支持)。 lang: 'zh-cn'
:设置中文界面。数据获取与提交
var content = ue.getContent(); // 带HTML格式的内容
var plainText = ue.getContentTxt(); // 纯文本内容
ue.ready(function() {
ue.setContent('初始文本或HTML内容');
});
图片与文件上传
ueditor.config.js
中的serverUrl
,指向后端接口(如/ueditor/upload
)。 UE.getEditor('editor-container', {
imageAllowFiles: ['.png', '.jpg', '.jpeg'], // 允许的图片格式
fileMaxSize: 5 * 1024 * 1024 // 文件大小限制5MB
});
安全设置
ue.options.XSSFilter = true; // 默认开启,过滤危险HTML标签
whitList
,仅允许特定标签及属性。自定义工具栏按钮
toolbars
数组配置按钮分组,例如: toolbars: [
['fullscreen', 'source', 'undo', 'redo'],
['insertcode', 'preview', 'emotion'] // 添加代码插入、预览、表情功能
]
插件扩展
UE.registerUI('markdown', function(editor) {
// 插件逻辑
});
多语言支持
引入语言包文件(如zh-cn.js
),并在配置中设置lang: 'zh-cn'
。
交互体验增强
contentChange
事件监听内容变化。 enableAutoSave: true
。响应式布局
UE.getEditor('editor-container', {
autoHeightEnabled: true // 高度随内容自适应
});
主题定制
修改themes/default/css/ueditor.css
,覆盖默认样式以实现与网站风格统一。
编辑器未显示
window.onload
)。图片上传失败
serverUrl
配置是否正确,后端接口需返回标准JSON响应。 参考来源:
UEditor功能组件与配置说明
工具栏定制与数据初始化方法
高级配置与上传接口设置
安全策略与主题定制
安装部署与基础使用
通过本指南,您可快速搭建功能完善且风格统一的UEditor在线Demo。如需进一步扩展,可参考UEditor官方文档或社区资源。