Braft Editor扩展模块包

目前包含的模块列表

表格模块 Table

代码高亮模块 CodeHighlighter

高级取色器模块 ColorPicker

表情包扩展模块 Emoticon

输入字数限制模块 MaxLength

标题区块(h1-h6)id模块 HeaderId

安装

npm install braft-extensions --save

# 或者

yarn add braft-extensions

使用

需要分别import本模块包下面的各个模块，参见下方各模块的基本使用介绍

表格模块

支持添加/删除行列、合并/拆分单元格等基本操作

基本使用

import 'braft-editor/dist/index.css'

import 'braft-extensions/dist/table.css'

import BraftEditor from 'braft-editor'

import Table from 'braft-extensions/dist/table'

const options = {

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'] // 指定该模块对哪些BraftEditor无效

}

BraftEditor.use(Table(options))

使用注意事项

使用表格模块，请升级braft-editor、braft-convert和braft-utils至最新版本

暂不支持在表格中插入图片等媒体资源，因为draftjs不支持嵌套block，而每一个单元格和图片等都是一个单独的block，所以无法实现

每个表格前后都需要有一个空行才能正常展示，有疑问的请自行查阅源码

请勿在表格内进行过于复杂�的操作，例如任性合并/拆分单元格等，以免进入程序死角导致报错

调整列宽的功能会在后续版本中支持

代码高亮模块

使用prismjs和draft-js-prism开发的一个代码高亮模块，能在编辑器中实现代码高亮编辑功能，内置html、js和css语言支持，可扩展更多语言，在线演示

安装依赖

npm install prismjs draft-js-prism --save

# 或者

yarn add prismjs draft-js-prism

基本使用

import 'braft-editor/dist/index.css'

import 'braft-extensions/dist/code-highlighter.css'

import BraftEditor from 'braft-editor'

import CodeHighlighter from 'braft-extensions/dist/code-highlighter'

const options = {

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'] // 指定该模块对哪些BraftEditor无效

}

BraftEditor.use(CodeHighlighter(options))

扩展语言支持

请访问PrismJs官网查看全部支持的语言

// 首先需要从prismjs中引入需要扩展的语言库

import 'prismjs/components/prism-java'

import 'prismjs/components/prism-php'

// 通过opitons.

const options = {

syntaxs: [

{

name: 'JavaScript',

syntax: 'javascript'

}, {

name: 'HTML',

syntax: 'html'

}, {

name: 'CSS',

syntax: 'css'

}, {

name: 'Java',

syntax: 'java',

}, {

name: 'PHP',

syntax: 'php'

}

]

}

BraftEditor.use(CodeHighlighter(options))

使用其他Prism配色主题

该功能将在后续版本中支持

使用注意事项

使用该模块，必须引入braft-extensions/dist/code-highlighter.css文件

该模块仅用于对编辑器内的代码块进行高亮展示，并不会更改编辑器输出的实际内容，如果需要在展示页面进行代码高亮，请单独使用Prism.js或其他代码高亮方案进行处理

在展示页使用PrismJS进行代码高亮的时候，需要参考PrismJS/prism#598做一下处理

高级取色器模块

使用react-color来替换编辑器自身的颜色选择模块，设置颜色更自由！在线演示

安装依赖

npm install react-color --save

# 或者

yarn add react-color

基本使用

import 'braft-editor/dist/index.css'

import 'braft-extensions/dist/color-picker.css'

import BraftEditor from 'braft-editor'

import ColorPicker from 'braft-extensions/dist/color-picker'

const options = {

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'], // 指定该模块对哪些BraftEditor无效

theme: 'light', // 指定取色器样式主题，支持dark和light两种样式

}

BraftEditor.use(ColorPicker(options))

使用注意事项

使用该模块，必须引入braft-extensions/dist/color-picker.css文件

表情包扩展模块

替换内置的emoji组件，可以插入图片形式的表情，在线演示

基本使用

import 'braft-editor/dist/index.css'

import BraftEditor from 'braft-editor'

// 引入表情包扩展模块样式文件

import 'braft-extensions/dist/emoticon.css'

// 引入表情包扩展模块和默认表情包列表

import Emoticon, { defaultEmoticons } from 'braft-extensions/dist/emoticon'

// 转换默认表情包列表，让webpack可以正确加载到默认表情包中的图片，请确保已对png格式的文件配置了loader

// 如果你使用的webpack版本不支持动态require，或者使用的其他打包工具，请勿使用此写法

const emoticons = defaultEmoticons.map(item => require(`braft-extensions/dist/assets/${item}`))

// 也可以使用自己的表情包资源，不受打包工具限制

// const emoticons = ['http://path/to/emoticon-1.png', 'http://path/to/emoticon-2.png', 'http://path/to/emoticon-3.png', 'http://path/to/emoticon-4.png', ...]

const options = {

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'], // 指定该模块对哪些BraftEditor无效

emoticons: emoticons, // 指定可用表情图片列表，默认为空

}

BraftEditor.use(Emoticon(options))

使用注意事项

使用该模块，必须引入braft-extensions/dist/emoticon.css文件

输入字数限制模块

为编辑器增加maxLength和onReachMaxLength属性，用于限制输入字数

基本使用

import 'braft-editor/dist/index.css'

import BraftEditor from 'braft-editor'

import MaxLength from 'braft-extensions/dist/max-length'

const options = {

defaultValue: 100, // 指定默认限制数，如不指定则为Infinity(无限)

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'], // 指定该模块对哪些BraftEditor无效

}

BraftEditor.use(MaxLength(options))

使用MaxLength扩展之后，可为编辑器组件传入maxLength和onReachMaxLength:

console.log('不能再输入了！')} />

使用注意事项

粘贴内容时如果超过了限制字数，则整个粘贴内容都不会被粘贴到编辑器

对于富文本编辑器，限制输入字符数并不是一个很适合的做法

可通过editorState.toText().length获取到内容长度再进行友好提示

标题区块(h1-h6)id模块

为标题区块(h1-h6)增加随机的id，便于在展示页支持锚点跳转功能

基本使用

import 'braft-editor/dist/index.css'

import BraftEditor from 'braft-editor'

import HeaderId from 'braft-extensions/dist/header-id'

const options = {

includeEditors: ['editor-id-1'], // 指定该模块对哪些BraftEditor生效，不传此属性则对所有BraftEditor有效

excludeEditors: ['editor-id-2'], // 指定该模块对哪些BraftEditor无效

}

BraftEditor.use(HeaderId(options))