Skip to content

Horizontal Rule

The horizontalRule node is used to represent a thematic break in the document, typically rendered as a horizontal line.

Usage

import { defineHorizontalRulefunction defineHorizontalRule(): HorizontalRuleExtension@public } from 'prosekit/extensions/horizontal-rule'

const extensionconst extension: HorizontalRuleExtension = defineHorizontalRulefunction defineHorizontalRule(): HorizontalRuleExtension@public()

Commands

insertHorizontalRule

editorconst editor: Editor<HorizontalRuleExtension>.commandsEditor<HorizontalRuleExtension>.commands: ToCommandAction<{
    insertHorizontalRule: [];
}>All 
{@link 
CommandAction
}
s defined by the editor..insertHorizontalRuleinsertHorizontalRule: CommandAction
() => booleanExecute the current command. Return `true` if the command was successfully
executed, otherwise `false`.()

Keyboard Interaction

Type three hyphens (---) on an empty line. This will automatically create a horizontal rule.

API Reference

prosekit/extensions/horizontal-rule