extension-horizontal-rule
package @remirror/extension-horizontal-rule
class HorizontalRuleExtension
Adds a horizontal line to the editor.
Signature:
export declare class HorizontalRuleExtension extends NodeExtension<HorizontalRuleOptions>
Extends: NodeExtension<HorizontalRuleOptions>
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "horizontalRule";
method createInputRules
Signature:
createInputRules(): InputRule[];
Returns:
InputRule[]
method createNodeSpec
Signature:
createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): NodeExtensionSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | NodeSpecOverride |
Returns:
method createTags
Signature:
createTags(): "block"[];
Returns:
"block"[]
method insertHorizontalRule
Inserts a horizontal line into the editor.
Signature:
insertHorizontalRule(): CommandFunction;
Returns:
CommandFunction
interface HorizontalRuleOptions
Signature:
export interface HorizontalRuleOptions
property insertionNode
The name of the node to insert after inserting a horizontalRule.
Set to false to prevent adding a node afterwards.
Signature:
insertionNode?: string | false;