Horizontal Rules

Super Editor ships with support for horizontal rules.

A horizontal rule is a thin horizontal line that spans across the document.

Horizontal Rule Node

A horizontal rule is represented in a Document with a HorizontalRuleNode.

final document = MutableDocument(nodes: [
  HorizontalRuleNode(
    id: Editor.createNodeId(),
  ),
]);

Visual Presentation

By default, SuperEditor includes a HorizontalRuleComponentBuilder, which builds a HorizontalRuleComponent widget to display within an editor. Therefore, no additional steps are required to display a horizontal rule.

To change how horizontal rules are rendered in an editor, replace the built in HorizontalRuleComponentBuilder and the HorizontalRuleComponent with your own implementation.

References