/ Editor

Wysiwyg editor components built using ReactJS and Prosemirror

Wysiwyg editor components built using ReactJS and Prosemirror

NIB

Despite various options available for rich text editing in html, it continues to be extremely challenging area. I found prosemirror to be the best available solution for the problem. It is great work by author Marijn Haverbeke.

Making an editor ground up from a framework is still much work, the project aims at building react components for rich text editing using prosemirror. These components can be quickly integrated into react or even ron-react applications.

Setup

Setup of the editor is straight forward. Editor is a package on npm, and toolbars and each plugin is a package of its own and is required to be installed from npm.

Installing packages:

Either npm or yarn commands can be used.

npm i nib-core --save

Writing editor component:

import React from "react";
import Editor from "nib-core";

const MyEditor = () => (
  <Editor
    plugins="block inline"
    toolbar={{ htop: "block inline" }}
  />
);

Props

Props supported by the editor.

S.No. Name Description
1 defaultValue Value to initialize editor content
2 onChange Callback which is called when the content of the editor changes
3 plugins List of plugins to be added, currently supported plugins are: inline, block, list
4 toolbar Object with details of toolbars to be added to the editor. Currently cupported toolbars are htop, inline

Editor is in initial phase of development and right now api is not stable.

GitHub