HorizontalRule · QuireKit

Inserts a separator block with canonical line styling. nextNodeType controls the following editable block at the document end.

@quirekit/extension-horizontal-rule · MIT

Editor compatibility

Layer：Shared document capability

Editor	Status	Assembly and boundaries
Classic	Supported	classicEditorPreset — Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model.
Block	Supported	createBlockEditorPreset — The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See status and integration rules. Licensing is shown separately.

Installation

pnpm add @quirekit/extension-horizontal-rule@alpha

Install in Editor extensions. The host supplies a view, container and persistence; see Quick start.

Included in StarterKit. Configure its horizontalRule child, or disable that child before installing a replacement.

import { HorizontalRule } from '@quirekit/extension-horizontal-rule'

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see support and licensing.

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

Classic · Supported

Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model.

classicEditorPreset

import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'

const instance = createClassicEditor({ element })

Block · Supported

The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

createBlockEditorPreset

import { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'

const instance = createBlockEditor({
  element,
  content: { type: 'doc', content: [{ type: 'paragraph' }] },
})

Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.

HTMLAttributes

HTML attributes added when the horizontal rule serializes to HTML.

Type：Record<string, unknown>

Default：{}

nextNodeType

Default block node type inserted after a trailing horizontal rule.

Type：string

Default："paragraph"

defaultStyle

Canonical style used when imported or inserted content omits attributes.

Type：HorizontalRuleStyle

Default：See default below

Object.freeze({ variant: "single", color: "#111827", thicknessPt: 1.5, widthPercent: 100, alignment: "center" })

Commands and runtime

These commands are supplied directly by this extension. Availability depends on the installed schema, selection and protection policy; query editor.can() first.

Command	Parameter signature
`setHorizontalRule`	`setHorizontalRule(style?: Partial<HorizontalRuleStyle> \| undefined)`
`updateHorizontalRule`	`updateHorizontalRule(style: Partial<HorizontalRuleStyle>)`

These are parameter signatures. See commands and controls to connect UI while retaining one transaction/history authority.

Other public exports

HorizontalRule · @quirekit/starter-kit

Next steps

Return to all plugins, or read configuration to distinguish options, attributes and commands.

See extension development for custom capabilities and Build a product for complete hosting.