ADF nodes

About Nodes

Nodes specify the structure and content of ADF. Broadly speaking, ADF consists of block nodes, which give the overall document structure, and inline nodes, which declare the displayable content.

With the exception of text nodes that have a special text property, all nodes are restricted to these well-defined properties:

• type – required to identify each node
• attrs – a map of additional properties that affect the node’s behavior; may be either optional or required, depending on the node’s type.
• content – used by “block nodes”, this is array of the child nodes of this block, in order. These child nodes are not arbitrary: content nodes always restrict which child nodes are allowed. Refer to each node’s documentation for details on these restrictions, or ContentNodes for general information about working with them.
• marks – For nodes that accept them, this is an array of the Marks on that node. This library tries to preserve the order that marks are provided to it, but this order is not expected to be significant.

Context-Sensitive Restrictions

Nodes that have a content field only permit certain other nodes to be placed in them. The convention used by this library is as follows:

1. Where the parent node has a specialized list of permitted child nodes, this library uses a marker interface named after the parent node with a “Content” suffix. For example, the doc node’s content field holds nodes marked with the DocContent interface.
2. Where there is only a single type of node that is permitted in the content section, and no reason to expect this to ever change, a dedicated interface is generally not created. For example, a table node can only contain tableRow nodes as content, so there is no explicit TableContent interface.
3. Where the parent node shares the declaration of permitted content with one or more other parent nodes, this library uses a name derived from whatever it is called in the JSON schema if it makes any sense, but with a “Content” suffix. For example, the schema declares paragraph as containing inline_node items in its content and that content type is shared with several other node types (such as heading, so this library marks them as InlineContent.

Node Usage

• BlockquoteContent
• BodiedExtensionContent
• BodiedSyncBlockContent
• CaptionContent
• DocContent
• ExpandContent
• ExtensionFrameContent
• InlineContent
• LayoutColumnContent
• ListItemContent
• NestedExpandContent
• NonNestableBlockContent
• PanelContent
• TableCell
• TableRowContent
• TaskListContent

Node Reference

See the Index.