ADF node: rule

Description

The rule node represents a divider. It is equivalent to the HTML <hr> tag.

Example

Java

1
2
3
4
5
6
doc(
        p("Hello"),
        hr(),
        p("World")
);

ADF

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "version": 1,
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Hello"
        }
      ]
    },
    {
      "type": "rule"
    },
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "World"
        }
      ]
    },
  ]
}

Result

Hello

---

World

Compatibility

Products

Usage

• BodiedSyncBlockContent
• DocContent
• ExtensionFrameContent
• LayoutColumnContent
• NestedExpandContent
• NonNestableBlockContent
• PanelContent
• TableCellContent

Marks

❌ N/A

Attributes

Structure

• type - rule
• attrs?
  • localId? – string¹
  • color? – string (hex)² (Stage 0)
  • style? – enum (solid | dashed | dotted | sketch | fade)² (Stage 0)
  • weight? – number (1–3)² (Stage 0)

---

Footnotes

1. The localId, when present, will typically be a random UUID. This is not enforced by the schema. ↩

2. These attrs are Stage 0 and require a FeatureContext that enables stage-0 nodes. ↩ ↩² ↩³