Skip to content

prosekit/extensions/horizontal-rule

type HorizontalRuleCommandsExtension = Extension<{ Commands: { insertHorizontalRule: []; }; }>


type HorizontalRuleSpecExtension = Extension<{ Nodes: { horizontalRule: Attrs; }; }>


type HorizontalRuleExtension = Union<[HorizontalRuleSpecExtension, HorizontalRuleCommandsExtension]>

function insertHorizontalRule(): Command

Returns a command that inserts a horizontal rule at the current selection.


function defineHorizontalRuleCommands(): HorizontalRuleCommandsExtension


function defineHorizontalRuleInputRule(): PlainExtension

Replaces --- at the start of a text block with a horizontal rule.


function defineHorizontalRuleSpec(): HorizontalRuleSpecExtension


function defineHorizontalRule(): HorizontalRuleExtension