一个基于draft-js的Web富文本编辑器，适用于React框架，兼容主流现代浏览器。
墙裂感谢@petitspois提供支持
- 2017-12-14 v1.1.8
- 修复与jquery等库存在冲突的问题，感谢@juyongxia反馈
- 2017-11-30 v1.1.7
- 修复bug #13，感谢@melissaloves反馈
- 修复粘贴内容时文字背景颜色显示错误的问题，感谢@sunhongfeiraven反馈
- 2017-10-25 v1.1.6
- 修复SwitchButton激活状态显示异常的bug
- 2017-09-18 v1.1.0
- addonControls更名为extendControls
- extendControls支持弹出框控件
- 增加media.validateFn属性，用于在选择本地文件时进行校验
- 音频和视频内容增加删除按钮和简单预览功能
- 2017-09-06 v1.0.0
- 升级架构，抽象编辑器操作模块，大幅提升可扩展性
移步: http://margox.github.io/braft-editor/
- 完善的文本内容编辑功能
- 诸多开放的编辑接口，良好的可扩展性
- 允许插入图片、音视频等多媒体内容
- 允许自定义多媒体内容的上传接口
- 允许设置图片的左右浮动（即文字绕排功能）
- 允许设置编辑器可用的颜色列表、字号以及字体
- 允许自定义需要展示的控制按钮和展示顺序
- 允许增加额外的自定义按钮
- 多语言支持（目前已支持简体中文和英文）
- ...更多特性开发中
# 使用yarn安装
yarn add braft-editor
# 使用npm安装
npm install braft-editor --save# 运行dev-server
yarn start
# 启动上传服务器
cd example/server
node index.js
# 访问 http://localhost:5998
# 打包编译
yarn buildimport React from 'react'
import ReactDOM from 'react-dom'
// 引入编辑器以及编辑器样式
import BraftEditor from 'braft-editor'
import 'braft-editor/dist/braft.css'
class Demo extends React.Component {
state = {
content: null
}
render () {
const editorProps = {
height: 500,
initialContent: this.state.content,
onChange: this.handleChange,
onHTMLChange: this.handleHTMLChange
}
return (
<div className="demo">
<BraftEditor {...editorProps}/>
</div>
)
}
handleChange = (content) => {
console.log(content)
}
handleHTMLChange = (html) => {
console.log(html)
}
}用于指定initialContent和onChange的内容格式，raw表示使用编辑器原始数据作为输入和输出类型, html表示使用HTML字符串作为输入和输出类型，默认为raw。
为了保证内容的可编辑性，强烈建议使用raw格式，并通过onHTMLChange获取HTML格式的内容
编辑器的初始内容，根据contentFormat类型传入html字符串或者raw字符串
指定编辑器内容发生变化时候的回调
指定编辑器内容发生变化时候的回调，参数为Raw格式的编辑器内容
指定编辑器内容发生变化时候的回调，参数为HTML格式的编辑器内容
指定控制栏组件，默认值如下：
[
'undo', 'redo', 'split', 'font-size', 'font-family', 'text-color',
'bold', 'italic', 'underline', 'strike-through', 'superscript',
'subscript', 'text-align', 'split', 'headings', 'list_ul', 'list_ol',
'blockquote', 'code', 'split', 'link', 'split', 'media'
]原addonControls已更名为extendControls
指定自定义控制组件，目前仅支持分割线和按钮以及下拉框。 示例：
[
{
type: 'split'
},
{
type: 'button',
text: 'Hello',
className: 'preview-button',
onClick: () => console.log('Hello World!')
}, {
type: 'dropdown',
text: 'Foo',
showDropDownArrow: false,
component: <YourComponent />
}, {
type: 'modal',
text: 'Bar',
modal: {
title: '这是一个弹出框',
showClose: true,
showCancel: true,
showConfirm: true,
confirmable: true,
onConfirm: () => console.log(1),
onCancel: () => console.log(2),
onClose: () => console.log(3),
children: (
<div style={{width: 480, height: 320, padding: 30}}>
<span>Hello World！</span>
</div>
)
}
}
]指定编辑区域的高度，不包括控制栏，默认是500
指定编辑器的语言，目前支持zh和en，默认zh
设置placeholder文本
指定编辑器的包裹容器的选择器字符串（例如'#wrapper', '.container'），用于下拉菜单等组件的位置自适应，默认为body
指定编辑器可用的颜色列表，用于设定文本颜色和文本背景颜色，只支持6位16进制写法，默认可用颜色：
[
'#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff',
'#61a951', '#16a085', '#07a9fe', '#003ba5', '#8e44ad', '#f32784',
'#c0392b', '#d35400', '#f39c12', '#fdda00', '#7f8c8d', '#2c3e50'
]指定编辑器可用的字号列表，用于设定文本内容的字号，默认可用字号：
[
12, 14, 16, 18, 20, 24,
28, 30, 32, 36, 40, 48,
56, 64, 72, 96, 120, 144
]指定编辑器可用的字体列表，用于设定文本内容的字体，默认可用字体：
[
{
name: 'Araial',
family: 'Arial, Helvetica, sans-serif'
}, {
name: 'Georgia',
family: 'Georgia, serif'
}, {
name: 'Impact',
family: 'Impact, serif'
}, {
name: 'Monospace',
family: '"Courier New", Courier, monospace'
}, {
name: 'Tahoma',
family: "tahoma, arial, 'Hiragino Sans GB', 宋体, sans-serif"
}
]配置编辑器的多媒体插入功能:
{
image: true, // 开启图片插入功能
video: true, // 开启视频插入功能
audio: true, // 开启音频插入功能
validateFn: null, // 指定本地校验函数，说明见下文
uploadFn: null // 指定上传函数，说明见下文
}在选择文件之后，编辑器会调用此函数对每一个选择的文件进行校验，如果该函数返回false，则对应的文件不会被添加到媒体库：
// 示例，不允许选择大于100K的文件
const validateFn = (file) => {
return file.size < 1024 * 100
}指定上传函数，未指定时无法上传视频和音频，可上传图片，但只限本地预览。
编辑器在调用该函数时，会传入一个包含文件体、文件在媒体库的ID、进度回调、成功回调和失败回调的对象作为参数：
{
file: [File Object],
progress: function (progress) {
// progress为0到100
},
libraryId: 'XXXXX',
success: function (res) {
// res须为一个包含已上传文件url属性的对象：
},
error: function (err) {
}
}uploadFn示例:
const uploadFn = (param) => {
const serverURL = 'http://upload-server'
const xhr = new XMLHttpRequest
const fd = new FormData()
// libraryId可用于通过mediaLibrary示例来操作对应的媒体内容
console.log(param.libraryId)
const successFn = (response) => {
// 假设服务端直接返回文件上传后的地址
// 上传成功后调用param.success并传入上传后的文件地址
param.success({
url: xhr.responseText
})
}
const progressFn = (event) => {
// 上传进度发生变化时调用param.progress
param.progress(event.loaded / event.total * 100)
}
const errorFn = (response) => {
// 上传发生错误时调用param.error
param.error({
msg: 'unable to upload.'
})
}
xhr.upload.addEventListener("progress", progressFn, false)
xhr.addEventListener("load", successFn, false)
xhr.addEventListener("error", errorFn, false)
xhr.addEventListener("abort", errorFn, false)
fd.append('file', param.file)
xhr.open('POST', serverURL, true)
xhr.send(fd)
}绝大多数的非get类方法都会返回编辑器实例，即支持链式调用
<BraftEditor ref={instance => this.editorInstance = instance}/>// 获取指定格式的内容，format为获取内容的格式，默认与contentFormat一致， 另有getHTMLContent和getRawContent方法可用
this.editorInstance.getContent(format)// 设置编辑器内容，用于需要异步填入编辑器内容的场景，format为填入内容的格式，默认与contentFormat一致
this.editorInstance.setContent(content, format)获取编辑器实例的editorState，一般情况下无需使用
this.editorInstance.getEditorState()强制编辑器内容重新渲染，一般情况下无需使用
this.editorInstance.forceRender()获取draft内核的实例，用于调用draft的API
const draftInstance = this.editorInstance.getDraftInstance()
// 使编辑器获得焦点
draftInstance.focus()更多关于draft的资料，请参阅：https://draftjs.org/
获取内置媒体库实例，可用于外部操作媒体库内容
// 示例
const mediaLibrary = this.editorInstance.getMediaLibraryInstance()
const libraryId = new Date().getTime()
// 往媒体库添加一个图片
mediaLibrary.addItem({
id: libraryId,
type: 'IMAGE',
name: 'Foo',
url: 'http://path/to/image'
})
// 从媒体库删除先前插入的图片
setTimeout(() => {
mediaLibrary.removeItem(libraryId)
}, 1000)媒体库实例的具体使用请参阅：https://github.com/margox/braft-editor/tree/master/src/helpers/MediaLibrary/index.js
判断当前是否选中内容
this.editorInstance.selectionCollapsed()获取选中内容的区块类型
this.editorInstance.getSelectionBlockType()切换选中内容的区块类型，可用的区块类型请参见可用区块类型
this.editorInstance.toggleSelectionBlockType('blockquote')获取选中内容的行内样式
this.editorInstance.getSelectionInlineStyle()判断选中内容是否包含指定的行内样式
this.editorInstance.selectionHasInlineStyle('BOLD')切换选中内容的行内样式, 同时可传入一个需要移除的样式数组
// 加粗文字，同时移除文字斜体样式
this.editorInstance.toggleSelectionInlineStyle('BOLD', ['ITALIC'])切换选中内容的文本对齐方式，参数可以是left/center/right
this.editorInstance.toggleSelectionAlignment('center')切换选中内容的文字颜色，参数为可用颜色中的一个
this.editorInstance.toggleSelectionColor('#ffffff')切换选中内容的文字背景颜色，参数为可用颜色中的一个
this.editorInstance.toggleSelectionBackgroundColor('#000000')切换选中内容的文字大小，参数为可用字号中的一个
this.editorInstance.toggleSelectionFontSize(24)切换选中内容的文字字体，参数为可用字体中的一个(name)
this.editorInstance.toggleSelectionFontFamily('Impact')为选中内容添加超链接
this.editorInstance.toggleSelectionLink('http://www.baidu.com', '_blank')
// 移除所选内容的超链接
this.editorInstance.toggleSelectionLink(false)插入内容到光标之后，如果当前已选中内容并且replace为true，则会替换被选中内容，replace默认为true
this.editorInstance.insertText('Hello World!')插入媒体内容到编辑器，medias为数组，格式如下：
this.editorInstance.insertMedias([
{
type: 'IMAGE',
name: 'New Photo',
url: 'http://path/to/image.png'
}, {
type: 'VIDEO',
name: 'New Video',
url: 'http://path/to/image-2.mp4'
}, {
type: 'AUDIO',
name: 'New Audio',
url: 'http://path/to/image-2.mp3'
}
])插销一次操作
this.editorInstance.undo()重做一次操作
this.editorInstance.redo()使编辑器获得焦点
this.editorInstance.focus()使编辑器失去焦点
this.editorInstance.blur()- 支持图片修改宽度
- 支持多实例共存
- 使用html作为contentFormat时，文字字体(fontFamily)的的转换难以实现
- 从外部复制HTML内容粘贴到编辑器时，文字字体(fontFamily)的识别难以实现
- 编辑器内容为空时插入列表，placeholder文本不消失，输入任意文本内容后placeholder文本消失
[
'header-one',
'header-two',
'header-three',
'header-four',
'header-five',
'header-six',
'unstyled',
'blockquote',
'code-block',
'unordered-list-item',
'ordered-list-item'
]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent