Node - rule

Purpose

The rule node is an block node that represents a divider (e.g. <hr/>).

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "version": 1,
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Hello world"
        }
      ]
    },
    {
      "type": "rule"
    }
  ]
}

Content

rule is an immutable block node in the top-level blocks group that can not be modified.

Marks

rule does not support any marks.

Fields

NameMandatoryTypeValueNotes
typestring"rule"