ADF node: blockCard

Node

Description

The blockCard node is an Atlassian link card with a type icon and content description derived from the link. It provides the same functionality that inlineCard does, but renders its link as a standalone block rather than in combination with the other inline content in a paragraph or similar container.

Example

Java

1
2
3
4
5
6
doc(
        p("Hello"),
        blockCard("https://jira.atlassian.com/browse/JRACLOUD-72220"),
        p("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
{
  "type": "doc",
  "version": 1,
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Hello"
        }
      ]
    },
    {
      "type": "blockCard",
      "attrs": {
        "url": "https://jira.atlassian.com/browse/JRACLOUD-72220"
      }
    },
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "World"
        }
      ]
    }
  ]
}

Result

Hello

JRACLOUD-72220 – Java client for building/parsing ADF IN PROGRESS

World

Note: This example output is not using AtlasKit to render the block card, so while it gives a vague impression of what a “block card” is, it does not faithfully reproduce the actual presentation in Atlassian products. In particular, it isn’t possible to set the font color, so the “IN PROGRESS” status lozenge is not shown correctly, here.

Compatibility

Products

Usage

• DocContent
• LayoutColumnContent
• NonNestableBlockContent
• PanelContent
• TableCellContent

Marks

❌ N/A

Structure

• type - blockCard
• attrs - must specify at least one of data, url, or datasource, and data cannot be combined with the others
  • localId? - string2
  • data? - object
  • url? - string (URI)
  • datasource? - object3
    • id - string
    • parameters - object
    • views - array(object), where each object has:
      • type - string
      • properties? - object

---

1. The localId, when present, will typically be a random UUID. This is not enforced by the schema.↩︎
2. The localId, when present, will typically be a random UUID. This is not enforced by the schema.↩︎
3. The datasource type is currently under development and not yet fully documented. Its initial use is expected to be in Confluence with respect to reimplementing the Jira Issue Macro, and it will not initially be supported in Jira. More information will be provided here as it becomes available.↩︎