ADF node: mediaInline

Node

Description

The mediaInline node type works much like a media node with a file or link type, except that instead of being placed inside the mediaGroup and mediaSingle block nodes, they are used in places that InlineContent is used, such as within a paragraph.

Compatibility

Products

Usage

• InlineContent

Marks

• link

Structure

• type - mediaInline
• attrs
  • alt? - string
  • type? - file | link1 | image
  • collection - string2
  • height? - number
  • id - string – not empty
  • occurrenceKey? - string – not empty
  • width? - number
  • data? - object
  • localId? - string3
• marks? - array(link | border | annotation …)

---

1. Most of the support for link media no longer functions in the editor code base, so clients are unlikely to encounter it in the wild and should not use it in new ADF. It is unclear what it means for the type attribute to be left unset, but the schema permits it.↩︎
2. Media collections are being phased out, but the collection ID is still required by the schema. In most circumstances, an empty string ("") should be provided for it. This library will do this automatically when the value is left unset.↩︎
3. The localId, when present, will typically be a random UUID. This is not enforced by the schema.↩︎