extension-hard-break

package @remirror/extension-hard-break

class HardBreakExtension

An extension which provides the functionality for inserting a hardBreak <br /> tag into the editor.

Signature:

export declare class HardBreakExtension extends NodeExtension 

Extends: NodeExtension

Remarks:

It will automatically exit when used inside a codeClock. To prevent problems occurring when the codeblock is the last node in the doc, you should add the TrailingNodeExtension which automatically appends a paragraph node to the last node.

(Some inherited members may not be shown because they are not represented in the documentation.)

property name

Signature:

get name(): "hardBreak";

method createKeymap

Signature:

createKeymap(): KeyBindings;

Returns:

KeyBindings

method createNodeSpec

Signature:

createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): NodeExtensionSpec;

Parameters:

Parameter	Type	Description
extra	ApplySchemaAttributes
override	NodeSpecOverride

Returns:

NodeExtensionSpec

method createTags

Signature:

createTags(): "inline"[];

Returns:

"inline"[]

method insertHardBreak

Inserts a hardBreak <br /> tag into the editor.

Signature:

insertHardBreak(): CommandFunction;

Returns:

CommandFunction