Jira Cloud platform Developer

Jira Cloud platform Developer

Rate this page:

Node - orderedList

Purpose

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

Type

orderedList is a top-level block node.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "type": "orderedList",
  "attrs": {
    "order": 3
  },
  "content": [
    {
      "type": "listItem",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "Hello world"
            }
          ]
        }
      ]
    }
  ]
}

Fields

NameRequiredTypeValue
typestring"orderedList"
contentarrayAn array of nodes
attrsobject
attrs.orderintegerA positive integer

Content

content can contain one or more listItem nodes.

Attributes

order defines the number of the first item in the list. For example, 3 would mean the list starts at number three. When not specified, the list starts from 1.

Rate this page: