ADF node: orderedList

Node

Description

The orderedList node is a container for a numbered list of items. It’s the ordered equivalent of bulletList.

Example

Java

1
2
3
4
5
6
orderedList(
        3,
        li("Hello"),
        li("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
29
30
31
32
33
34
35
36
37
{
  "type": "orderedList",
  "attrs": {
    "order": 3
  },
  "content": [
    {
      "type": "listItem",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "Hello"
            }
          ]
        }
      ]
    },
    {
      "type": "listItem",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "World"
            }
          ]
        }
      ]
    }
  ]
}

Result

1. Hello
2. World

Compatibility

Products

Usage

• BlockquoteContent
• DocContent
• LayoutColumnContent
• ListItemContent1
• NestedExpandContent
• NonNestableBlockContent
• PanelContent
• TableCellContent

Marks

❌ N/A

Structure

• type - orderedList
• attrs?
  • order? - number - min value 0, indicating the first index for the list
  • localId? - string2
• content - array([→ listItem]…) – at least 1

---

1. Although bulletList and orderedList can be nested inside another list’s listItem, they cannot be the first child node. Specify an empty paragraph node for the first child as a workaround if no other content is available.↩︎
2. The localId, when present, will typically be a random UUID. This is not enforced by the schema.↩︎