RenderInlineContent

An inline content element.

enum RenderInlineContent

Discussion

Typically, a renderer will append inline elements to previous inline elements. Apart from simple content like an image or a piece of plain text, a renderer uses inline elements to style content.

These elements don’t introduce a break in their container’s layout flow like RenderBlockContent elements do.

[ Paragraph
   [Text] [Strong [Text]] [Text] [Emphasize [Reference]] ...
]
- - - - - - - -
[ Paragraph
  ...
]

Inline elements can be nested, for example, an inline piece of text can be wrapped in an emphasis element. Block elements cannot be nested in inline elements.

Topics

Inline content types

case codeVoice(code: String)
A piece of code like a variable name or a single operator.
case emphasis(inlineContent: [RenderInlineContent])
An emphasized piece of inline content.
case image(identifier: RenderReferenceIdentifier, metadata: RenderContentMetadata?)
An image element.
case inlineHead(inlineContent: [RenderInlineContent])
An inline heading.
case newTerm(inlineContent: [RenderInlineContent])
A piece of content that introduces a new term.
case reference(identifier: RenderReferenceIdentifier, isActive: Bool, overridingTitle: String?, overridingTitleInlineContent: [RenderInlineContent]?)
A reference to another resource.
case strikethrough(inlineContent: [RenderInlineContent])
A strikethrough piece of content.
case strong(inlineContent: [RenderInlineContent])
A strongly emphasized piece of inline content.
case `subscript`(inlineContent: [RenderInlineContent])
A subscript piece of content.
case superscript(inlineContent: [RenderInlineContent])
A superscript piece of content.
case text(String)
A piece of plain text.

Getting a plain text representation

var plainText: String
Returns a lossy conversion of the formatted content to a plain-text string.