react-editor-js

🍞 DEMO

- CodeSandbox

🍀 Supported Official Plugin

- [x] Paragraph (default)
- [x] Embed
- [x] Table
- [x] List
- [x] Warning
- [x] Code
- [x] Link
- [x] Image
- [x] Raw
- [x] Header
- [x] Quote
- [x] Marker
- [x] CheckList
- [x] Delimiter
- [x] InlineCode
- [x] SimpleImage

🤟🏻 Getting Started

$3

``bash
npm install --save react-editor-js @editorjs/editorjs @editorjs/paragraph ...other plugins
`

`tsx
import { createReactEditorJS } from 'react-editor-js'

const ReactEditorJS = createReactEditorJS()


`

📙 API

Allow all options of editor-js

| Name | Type | Description |
| ------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| defaultValue | OutputData | Initial data when using editor js as uncontrolled component. highly recommend it |
| value | OutputData | data when using editor js as controlled component.
⚠️ Don't use it with onChange prop. Infinite loops can occur. |
| onInitialize | (editorCore?: EditorCore) => void | Call after editor-js is initialized |

🧐 FAQ

$3

There is an only Paragraph block already included in Editor.js. Probably you want to use several Block Tools that should be installed and connected.

To add more Block Tools, simply add them to your repo and pass them as tools-property to your editor:

`
npm install --save-dev @editorjs/checklist
`

`tsx
import { createReactEditorJS } from 'react-editor-js'
import CheckList from '@editorjs/checklist'

const ReactEditorJS = createReactEditorJS()


`

We recommend to create a tools.js file and export your tools as a constant. Here is an example using all of the default plugins:

`ts
// tools.js
import Embed from '@editorjs/embed'
import Table from '@editorjs/table'
import Paragraph from '@editorjs/paragraph'
import List from '@editorjs/list'
import Warning from '@editorjs/warning'
import Code from '@editorjs/code'
import LinkTool from '@editorjs/link'
import Image from '@editorjs/image'
import Raw from '@editorjs/raw'
import Header from '@editorjs/header'
import Quote from '@editorjs/quote'
import Marker from '@editorjs/marker'
import CheckList from '@editorjs/checklist'
import Delimiter from '@editorjs/delimiter'
import InlineCode from '@editorjs/inline-code'
import SimpleImage from '@editorjs/simple-image'

export const EDITOR_JS_TOOLS = {
// NOTE: Paragraph is default tool. Declare only when you want to change paragraph option.
// paragraph: Paragraph,
embed: Embed,
table: Table,
list: List,
warning: Warning,
code: Code,
linkTool: LinkTool,
image: Image,
raw: Raw,
header: Header,
quote: Quote,
marker: Marker,
checklist: CheckList,
delimiter: Delimiter,
inlineCode: InlineCode,
simpleImage: SimpleImage,
}
`

`tsx
import { createReactEditorJS } from 'react-editor-js'
import { EDITOR_JS_TOOLS } from './tools'

const ReactEditorJS = createReactEditorJS()


`

You can read more about plugins/tools at editor-js: Tools installation

$3

It's simpleeeee

`tsx