Braft Editor
一个基于draft-js的Web富文本编辑器,适用于React框架,兼容主流现代浏览器。
注意,项目当前版本为2.1,如果你使用的是1.x.x版本,请参阅旧版本文档
交流反馈请加QQ群:725634541
特性
- 完善的文本内容编辑功能
- 诸多开放的编辑接口,良好的可扩展性
- 允许插入图片、音视频等多媒体内容
- 允许自定义多媒体内容的上传接口
- 允许设置图片的左右浮动(即文字绕排功能)
- 允许设置编辑器可用的颜色列表、字号以及字体
- 允许自定义需要展示的控制按钮和展示顺序
- 允许增加额外的自定义按钮
- 多语言支持(目前已支持简体中文、繁体中文和英文)
- ...更多特性开发中
更新记录
- 2018-10-12 v2.1.6
- 修复controlBarClassName和controlBarStyle属性无效的问题
- 2018-10-11 v2.1.4
- 修复异步设置编辑器数据不会触发onChange的问题
- 2018-10-09 v2.1.3
- 2018-10-09 v2.1.2
- BraftEditor.use支持includeEditors和excludeEditors参数以针对不同编辑器启用不同扩展
- 修复问题#244
- 尝试优化#243
- 2018-10-08 v2.1.1
- 2018-10-08 v2.1.0
- 进一步增加可扩展性,包括增加自定义的entity、block和inline-style,以及扩展编辑器的转换规则
- 新增BraftEditor.use静态方法,用于载入全局扩展模块
- 新增单位转换功能(converts.unitImportFn和converts.unitExportFn属性)
- 新增onDelete、handleKeyCommand、handleReturn、handleBeforeInput等属性
- 新增defaultLinkTarget属性,用于指定链接的默认打开方式
- 新增editorState.isEmpty()实例方法,用于判断编辑器内容是否为空
- 新增段落缩进功能
- 其他细节优化
- 2018-09-29 v2.0.10
- 为onBlur和onFocus事件增加editorState参数
- 2018-09-29 v2.0.9
- 增加media.items属性用于初始化媒体库内容
- 2018-09-27 v2.0.8
- 修复了无法检测初始化内容中的文字颜色的问题
- 新增了BraftEditor.createEditorState静态方法
- 2018-09-26 v2.0.7
- 修复扩展下拉组件无法使用的问题
- 修复扩展弹窗组件再次点开时底栏消失的问题
- 2018-09-18 v2.0.6
- 部分控件支持开关模式,例如加粗、斜体等
- 支持拖动图片到编辑器区域
- 修复插入外部视频导致脚本报错的问题
- 2018-09-06 v2.0.5
- 2018-09-05 v2.0.4
- 修复defaultValue中包含图片时,鼠标移入图片导致报错的问题
- 2018-09-04 v2.0.3
- 修复代码块中按Tab导致报错的问题
- 修复控件文字提示被遮挡的问题
- 2018-09-04 v2.0.1
- 2018-09-03 v2.0.0
- v2.0.0船新版本发布,几需体验3分钟,你就会爱上杰个编辑器
安装
yarn add braft-editor
npm install braft-editor --save
使用
编辑器支持value和onChange属性,这类似于React中原生的input组件。通常情况下,可以用典型的受控组件的形式来使用本编辑器:
import React from 'react'
import BraftEditor from 'braft-editor'
import 'braft-editor/dist/index.css'
export default class EditorDemo extends React.Component {
state = {
editorState: null
}
async componentDidMount () {
const htmlContent = await fetchEditorContent()
this.setState({
editorState: BraftEditor.createEditorState(htmlContent)
})
}
submitContent = async () => {
const htmlContent = this.state.editorState.toHTML()
const result = await saveEditorContent(htmlContent)
}
handleEditorChange = (editorState) => {
this.setState({ editorState })
}
render () {
const { editorState } = this.state
return (
<div className="my-component">
<BraftEditor
value={editorState}
onChange={this.handleEditorChange}
onSave={this.submitContent}
/>
</div>
)
}
}
当然本编辑器也支持defaultValue属性,因此你也可以将本编辑器作为一个非受控组件来使用。