README.md

bb-editor

This project is in beta , please use it with caution.

This is a UI component built in React. It's based on Draft.js, an rich text editor framework for React.

Demo

Have a look

Install

Install with npm

$ npm install bb-editor --save

Install with yarn

$ yarn add bb-editor

Introduction

bb-editor is a rich text editor based on draftjs and ant design. It support typescript. if your project is based on react or based on react and typescript, bb-editor may be for you.

The core idea of the project is to enable people to build their own editors like building blocks. This is also the origin of the project name.

usage

import { Editor, ToolBar, EditorStateGenerator } from 'bb-editor'

class MyEditor extend React.Component {
    editorState = EditorStateGenerator()
    afterChange = (editorState) => {
        // do something
    }
    render() {
        return (
            <Editor
                value={this.editorState}
                afterChange={this.afterChange}>
                <ToolBar>
                    <ToolBar.Buttons.Bold />
                    <ToolBar.Buttons.Italic />
                    <ToolBar.Buttons.UnderLine />
                    <ToolBar.Buttons.StrikeThrough />

                    <ToolBar.Divider />

                    <ToolBar.Buttons.Header />
                    <ToolBar.Buttons.OrderedList />
                    <ToolBar.Buttons.UnorderedList />
                    <ToolBar.Buttons.Blockquote />
                    <ToolBar.Buttons.CodeBlock />
                    <ToolBar.Buttons.Divider />

                    <ToolBar.Divider />

                    <ToolBar.Buttons.Link />
                    <ToolBar.Buttons.Image />
                </ToolBar>
            </Editor>
        )
    }
}