Horizontal Rule

Type: Node

Horizontal Rule inserts a divider between sections. Renders as <hr> in HTML output.

Demo

import { HorizontalRule } from "@arkpad/extension-horizontal-rule";

The extension registers one primary command for inserting dividers:

// Inserts a horizontal rule at the current selection
editor.runCommand("setHorizontalRule");

You can chain commands to insert a horizontal rule and immediately focus the editor:

editor.chain().focus().setHorizontalRule().run();

Shortcut	Action
`Mod-Shift-h`	Inserts a horizontal rule

Type any of the following shortcuts on a new line to quickly convert it to a divider:

const isActive = editor.isActive("horizontalRule");

Name	Type	Default	Description
`HTMLAttributes`	`Record<string, any>`	`{}`	Key-value pairs of attributes to render on the `<hr>` DOM element.

HorizontalRule.configure({
  HTMLAttributes: {
    class: "custom-divider-styling",
  },
});