Wiki
adf-builder-java / node-inlineCard
Node: inlineCard
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
p( text("Hello "), inlineCard("https://jira.atlassian.com/browse/JRACLOUD-72220"), text(" world") );
ADF
{ "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
Confluence | Jira |
---|---|
✅ | ✅ |
Usage
Marks
❌ N/A
Structure
- type -
inlineCard
- attrs - must specify either
data
orurl
, but not both
-
The
localId
, when present, will typically be a random UUID. This is not enforced by the schema. ↩
Updated