react-editor-js

Unofficial react component for Editor.js (https://editorjs.io/).

Demo

You can see react-editor-js in action on both codesandbox and netlify.

Getting started

npm i @appigram/react-editor-js --save

# or
yarn add @appigram/react-editor-js

PeerDependencies

You have to install the required peerDependencies (eg. React >= 16.8), which are listed by the command:

npm info "@appigram/react-editor-js@latest" peerDependencies

If using npm 5+, use this shortcut:

npx install-peerdeps --dev @appigram/react-editor-js

# or
yarn add @appigram/react-editor-js -D --peer

Usage

// index.js
import EditorJs from '@appigram/react-editor-js'

const App = () => {
  return <EditorJs data={data} />
}

Whereas data looks similar to this example. It is based on the example output presented on editorjs.io.

Configuration

EditorJs passes all given props straight to the editorjs instance. It is basically just a wrapper component in React. Take a look at the configuration page in the editor.js documentation for more details.

Advanced example with callbacks, custom element and instance access

// index.js
import EditorJs from '@appigram/react-editor-js'

const App = () => {
  const editor = null

  const onReady = () => {
    // https://editorjs.io/configuration#editor-modifications-callback
    console.log('Editor.js is ready to work!')
  }

  const onChange = () => {
    // https://editorjs.io/configuration#editor-modifications-callback
    console.log("Now I know that Editor's content changed!")
  }

  const onSave = async () => {
    // https://editorjs.io/saving-data
    try {
      const outputData = await editor.save()
      console.log('Article data: ', outputData)
    } catch (e) {
      console.log('Saving failed: ', e)
    }
  }

  return (
    <div>
      <button onClick={onSave}>Save</button>
      {/* docs: https://editorjs.io/configuration */}
      <EditorJs
        data={data}
        // will be `editorjs` by default
        holder="custom-editor-container"
        onReady={onReady}
        onChange={onChange}
        editorInstance={editorInstance => {
          // invoked once the editorInstance is ready
          editor = editorInstance
        }}
      >
        <div id="custom-editor-container" />
      </EditorJs>
    </div>
  )
}

Plugins / Tools

If you want to add more tools simply pass a tools property to the EditorJs component:

// index.js
import EditorJs from '@appigram/react-editor-js'
import Header from '@editorjs/header'

const App = () => {
  return <EditorJs data={data} tools={{ header: Header }} />
}

EditorJs already comes with a basic config for @editorjs/paragraph and @editorjs/header. Take a look on their Github page to find more available plugins (or take a look at the storybook example).

Additional Props

| Name | Type | Default | Description | | :------------------------ | :-------: | :-----: | :----------------------------------------------------------------------------------------------------------------------- | | reinitializeOnPropsChange | boolean | false | editor-js is initialised again on componentDidUpdate |

References

• Debug GitHub Action with tmate

Licence

MIT

This project is not affiliated, associated, authorized, endorsed by or in any way officially connected to EditorJS (editorjs.io).

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!