bq Editor

Simple and Bqeautiful React Rich Text Editor.

Installation

npm i bq-editor

yarn add bq-editor

Usage

Render

To render the editor with default extensions we simply do:

<Editor />

Extensions

Extensions indicate what type of content the editor can handle.

<Editor
  extensions={[
    [
      {
        name: "heading",
        attrs: {
          levels: [1, 2, 3]
        }
      },
      {
        name: "bold"
      },
      {
        name: "italic"
      }
    ],
    [
      {
        name: "text-color",
        attrs: {
          color: #ffffff
        }
      }
    ]
  ]}
/>

It is an matrix, whose order and separations will define the toolbar.

Everything you type will be passed through with keybindings to the extensions. Users can even bold text via input rules: Type **bold** to add bold text.

Some extensions have additional parameters, run the storybook or go to the examples folder to see them.

Content

Editor provides an onChange function to export and save the contents.

export const MyEditor<{ content: ProsemirrorNode }> = ({ content }) => {
  const [doc, setDoc] = useState<ProsemirrorNode>();

  return (
    <Editor
      initialContent={JSON.stringify(content)}
      onChange={setDoc}
    />
  );
};

The output content is a ProsemirrorNode type.

The input content is a string, which will be handle as ProsemirrorNode type except if a specific string handle is activated.

Html Editor

Two remirror functions are exposed to handle html content: editorNodeToHtml and htmlToEditorNode.

export const MyHtmlEditor<{ html: string }> = ({ html }) => {
  const [doc, setDoc] = useState<ProsemirrorNode>();

  return (
    <Editor
      initialContent={html}
      onChange={setDoc}
      stringHandler="html"
    />
  );
};

Markdown Editor

Due to the limitations of markdown some extensions do not work.

export const MyMarkdownEditor<{ markdown: string }> = ({ markdown }) => {
  const [doc, setDoc] = useState<ProsemirrorNode>();

  return (
    <Editor
      initialContent={markdown}
      onChange={setDoc}
      stringHandler="markdown"
    />
  );
};

Code Editor

The code editor is activated with the codeEditor variable, there is no need to add extensions.

export const MyCodeEditor<{ content: ProsemirrorNode }> = ({ content }) => {
  const [doc, setDoc] = useState<ProsemirrorNode>();

  return (
    <Editor
      codeEditor
      initialContent={JSON.stringify(content)}
      onChange={setDoc}
    />
  );
};

Visor

To view non-editable content:

export const MyVisor<{ content: ProsemirrorNode }> = ({ content }) => {
  return (
    <Visor content={JSON.stringify(content)} />
  );
};

Corresponding extensions, handler or codeEditor must be added so visor can interpret the content.

Storybook

To see more examples and play with them, download the project, install dependencies and run our storybook:

yarn sb-start

Contribute

First of all, thanks for using bq editor!

If you run into any issues, open an issue in our github repository or create a pull request with your improvement proposal, explaining in detail the problem and the solution.

Please be patient, as this is a work in progress project.

Credits

This editor uses the wonderful Remirror React library.

All credits and applause go to the Remirror team.

License

This project is licensed under the MIT License. See LICENSE file for more details.