Skip to content
ProseKit

prosekit/extensions/horizontal-rule

Type Aliases

Section titled “Type Aliases”

HorizontalRuleCommandsExtension

Section titled “HorizontalRuleCommandsExtension”

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

HorizontalRuleSpecExtension

Section titled “HorizontalRuleSpecExtension”

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

HorizontalRuleExtension

Section titled “HorizontalRuleExtension”

type HorizontalRuleExtension = Union<[HorizontalRuleSpecExtension, HorizontalRuleCommandsExtension]>

Functions

Section titled “Functions”

insertHorizontalRule()

Section titled “insertHorizontalRule()”

function insertHorizontalRule(): Command

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

defineHorizontalRuleCommands()

Section titled “defineHorizontalRuleCommands()”

function defineHorizontalRuleCommands(): HorizontalRuleCommandsExtension

defineHorizontalRuleInputRule()

Section titled “defineHorizontalRuleInputRule()”

function defineHorizontalRuleInputRule(): PlainExtension

defineHorizontalRuleSpec()

Section titled “defineHorizontalRuleSpec()”

function defineHorizontalRuleSpec(): HorizontalRuleSpecExtension

defineHorizontalRule()

Section titled “defineHorizontalRule()”

function defineHorizontalRule(): HorizontalRuleExtension