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

Wiki

Clone wiki

adf-builder-java / node-extension

View History

Node: extension

Description

Extensions provide hook points for ecosystem add-ons to integrate with how ADF content is rendered. Like bodiedExtension nodes, the generic extension node type is used in contexts that only permit "block" content, such as the top-level doc node itself. However, there are some important differences:

  • extension nodes are leaves, but bodiedExtension nodes wrap other content
  • extension nodes can be used in places that bodiedExtension can not, such as inside tableCell, tableHeader, or bodiedExtension itself.

Compatibility

Products

Confluence Jira
✅ ⚠️1

Usage

Marks

Structure

  • type - extension
  • attrs
    • extensionKey - string – not empty
    • extensionType - string – not empty
    • localId? - string – not empty, UUID2
    • layout? - wide | full-width | default
    • parameters? - object
    • text? - string
  • marks? - array(dataConsumer?, fragment?)

  1. This node is not documented for Jira, so it is assumed to be unsupported for now ↩

  2. Not enforced by the schema, which only requires that this field be non-empty ↩

Updated