Braft Editor
一个基于draft-js的Web富文本编辑器，适用于React框架，兼容主流现代浏览器。
使用文档 在线演示
注意，项目当前版本为2.x，如果你使用的是1.x.x版本，请参阅旧版本文档
编辑器专用扩展包已发布，请查看Braft Extensions
表格扩展模块已发布测试版本，请升级braft-editor和braft-utils到最新版本，并安装最新版本的braft-extensions，使用方式请查看[表格扩展模块]
交流反馈请加QQ群：725634541
特性
- 完善的文本内容编辑功能
- 诸多开放的编辑接口，良好的可扩展性
- 允许插入图片、音视频等多媒体内容
- 允许自定义多媒体内容的上传接口
- 允许设置图片的左右浮动（即文字绕排功能）
- 允许设置编辑器可用的颜色列表、字号以及字体
- 允许自定义需要展示的控制按钮和展示顺序
- 允许增加额外的自定义按钮
- 多语言支持（目前已支持简体中文、繁体中文、英文和波兰语）
- ...更多特性开发中
鸣谢
- 感谢Jyoti Puri 开发的draftjs-utils 提供的帮助和react-draft-wysiwyg 提供的参考，Thanks！
- 感谢HubSpot 开发的draft-convert，Thanks！
- 感谢Samy Pessé 开发的draft-js-multidecorators，Thanks！
- 感谢JackLam提供的繁体中文语言自持，Thanks!
- 感谢Paweł Krefta提供的波兰语言支持，Thanks!
近期更新记录
- 2019-01-11 v2.2.4
- 新增editorId属性，作用与id属性完全一样，用于解决在Ant Design Form组件中id属性会被覆盖导致无法正常使用扩展模块的问题
- 2019-01-11 v2.2.2
- 优化音视频和嵌入式媒体的播放交互，改为在模态框中播放
- 2019-01-06 v2.2.1
- 完善index.d.ts(PR#340)
- 2018-12-29 v2.2.0
安装
# 使用yarn安装
yarn add braft-editor
# 使用npm安装
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 () {
// 假设此处从服务端获取html格式的编辑器内容
const htmlContent = await fetchEditorContent()
// 使用BraftEditor.createEditorState将html字符串转换为编辑器需要的editorState数据
this.setState({
editorState: BraftEditor.createEditorState(htmlContent)
})
}
submitContent = async () => {
// 在编辑器获得焦点时按下ctrl+s会执行此方法
// 编辑器内容提交到服务端之前，可直接调用editorState.toHTML()来获取HTML格式的内容
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属性，因此你也可以将本编辑器作为一个非受控组件来使用。
更多介绍请查看详细文档
Buy me a beer
如果你想感谢本编辑器为你的项目节省了时间，或者单纯地喜欢这个编辑器，可以扫码赞赏几块钱来请我喝杯啤酒喔！
