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

ts
import { defineHorizontalRule } from 'prosekit/extensions/horizontalRule'

const extension = defineHorizontalRule()

Commands

insertHorizontalRule

ts
editor.commands.insertHorizontalRule()

Keyboard Interaction

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

API Reference