ADF node: hardBreak

Node

Description

The hardBreak node inserts a new line in a text string. It’s the equivalent to a <br> in HTML.

Although it has no functional impact, the hardBreak mark is permitted to have a text attribute. If it is provided, then its value of must be "\n".

Example

Java

1
2
3
4
5
6
doc(p(
        text("Hello"),
        br(),
        text("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
{
  "version": 1,
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Hello"
        },
        {
          "type": "hardBreak"
        },
        {
          "type": "text",
          "text": "world"
        }
      ]
    }
  ]
}

Result

Hello world

Compatibility

Products

Usage

• CaptionContent
• InlineContent

Marks

❌ N/A

Structure

• type - hardBreak
• attrs?
  • text? - "\n" (the only valid value is a string containing a literal newline char)
  • localId? - string¹

---

Footnotes

1. This was mistakenly added to the schema and is retained only in the interest of preserving strict backwards compatibility. The library deliberately does not provide methods for setting this value and will silently discard it from parsed JSON sources. ↩