@remirror/extension-paragraph

@remirror/extension-paragraph

Group your words into paragraphs and render each statement a harmonious symphony.

Installation

yarn add @remirror/extension-paragraph@next @remirror/pm@next # yarn
pnpm add @remirror/extension-paragraph@next @remirror/pm@next # pnpm
npm install @remirror/extension-paragraph@next @remirror/pm@next # npm

This is included by default when you install the recommended remirror package. All exports are also available via the entry-point, remirror/extension/paragraph.

Usage

When added to your editor it will provide the insertParagraph which inserts a paragraph into the editor.

import { ExtensionPriority, RemirrorManager } from 'remirror/core';
import { DocExtension } from 'remirror/extension/doc';
import { ParagraphExtension } from 'remirror/extension/paragraph';
import { TextExtension } from 'remirror/extension/text';

// Create the extension
const paragraphExtension = new ParagraphExtension();
const docExtension = new DocExtension({ priority: ExtensionPriority.Low });
const textExtension = new TextExtension({ priority: ExtensionPriority.Low });

// Create the Editor Manager with the paragraph extension passed through.
const manager = RemirrorManager.create([paragraphExtension, docExtension, textExtension]);

// Pass the dom element to the editor. If you are using `@remirror/react` this is done for you.
const element = document.createElement('div');
document.body.append(element);

// Add the view to the editor manager.
manager.addView(element);

// Access the commands and insert a paragraph.
manager.commands.insertParagraph();

Alternatives

There are several presets which contain this extension and make the installation process less verbose. As a result you probably won't ever need to manage it directly.