1. Atlassian Avatar Atlassian
  2. Product Fabric
  3. adf-builder-java

Wiki

Clone wiki

adf-builder-java / node-taskList

View History

Node: taskList

Description

Task lists provide lists that look much like a bulletList, but there are differences in their visual representation. They can be nested (although at least one taskItem has to be provided before any nested task lists). The task items also require identifier strings that can be used to associate them with information in other systems.

Example

Java

taskList(
        "test-list-id",
        taskItem()
                .todo()
                .localId("test-id1")
                .content("Do this!"),
        taskItem()
                .localId("test-id2")
                .state(DONE)
                .content("This is completed")
);

ADF

{
  "type": "taskList",
  "attrs": {
    "localId": "test-list-id"
  },
  "content": [
    {
      "type": "taskItem",
      "attrs": {
        "localId": "test-id1",
        "state": "TODO"
      },
      "content": [
        {
          "type": "text",
          "text": "Do this!"
        }
      ]
    },
    {
      "type": "taskItem",
      "attrs": {
        "localId": "test-id2",
        "state": "DONE"
      },
      "content": [
        {
          "type": "text",
          "text": "This is completed"
        }
      ]
    }
  ]
}

Result

  • Do this!
  • This is completed

Compatibility

Products

Confluence Jira
✅ ❌

Usage

Marks

❌ N/A

Structure

  • type - taskList
  • content - array(TaskListContent) (at least 1; cannot use taskList at index 0)
  • attrs
    • localId - string (likely to be a UUID, but this is not enforced)

Updated