ADF node: inlineCard

Node

Description

An Atlassian link card with a type icon and content description derived from the link. The inlineCard node must specify either a URL or a JSON-LD representation of the link, but not both.

Example

Java

1
2
3
4
5
6
p(
        text("Hello "),
        inlineCard("https://jira.atlassian.com/browse/JRACLOUD-72220"),
        text(" world")
);

ADF

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "type": "paragraph",
  "content": [
    {
      "type": "text",
      "text": "Hello "
    },
    {
      "type": "inlineCard",
      "attrs": {
        "url": "https://jira.atlassian.com/browse/JRACLOUD-72220"
      }
    },
    {
      "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 inline card, so while it gives a vague impression of what an “inline 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

• CaptionContent
• InlineContent

Marks

❌ N/A

Structure

• type - inlineCard
• attrs - must specify either data or url, but not both
  • data? - object – JSON-LD
  • url? - string - URI
  • localId? – string1

---

1. The localId, when present, will typically be a random UUID. This is not enforced by the schema.↩︎