Content Delivery API Client/com.storyblok.cdn.schema/RichText

RichText

@Serializable

sealed class RichText(source)

Base class for Storyblok rich text nodes.

Represents the hierarchical structure of rich text content from the Storyblok editor.

Inheritors

Types

Blockquote

@Serializable

@SerialName(value = "blockquote")

class Blockquote : RichText, RichText.Composite

Block quote node.

Blok

@Serializable

@SerialName(value = "blok")

class Blok : RichText

Embedded component block within rich text.

BulletList

@Serializable

@SerialName(value = "bullet_list")

class BulletList : RichText, RichText.Composite

Unordered (bullet) list node.

CodeBlock

@Serializable

@SerialName(value = "code_block")

class CodeBlock : RichText, RichText.Composite

Code block node with optional language hint.

Composite

sealed interface Composite

Interface for rich text nodes that contain child nodes.

Document

@Serializable

@SerialName(value = "doc")

open class Document : RichText, RichText.Composite

Root document node containing all rich text content.

Emoji

@Serializable

@SerialName(value = "emoji")

class Emoji : RichText

Emoji node with fallback image support.

HardBreak

@Serializable

@SerialName(value = "hard_break")

class HardBreak(val marks: List<RichText.Mark> = emptyList()) : RichText

Hard line break node.

Heading

@Serializable

@SerialName(value = "heading")

class Heading : RichText, RichText.Composite

Heading node with configurable level (1-6).

HorizontalRule

@Serializable

@SerialName(value = "horizontal_rule")

class HorizontalRule : RichText

Horizontal rule (divider) node.

Image

@Serializable

@SerialName(value = "image")

class Image : RichText

Image node with source and metadata.

ListItem

@Serializable

@SerialName(value = "list_item")

class ListItem : RichText, RichText.Composite

List item node.

Mark

@Serializable

sealed class Mark : RichText

Base class for text formatting marks.

OrderedList

@Serializable

@SerialName(value = "ordered_list")

class OrderedList : RichText, RichText.Composite

Ordered (numbered) list node.

Paragraph

@Serializable

@SerialName(value = "paragraph")

class Paragraph : RichText, RichText.Composite

Paragraph node with optional text alignment.

Table

@Serializable

@SerialName(value = "table")

class Table : RichText, RichText.Composite

Table container node.

TableCell

@Serializable

@SerialName(value = "tableCell")

class TableCell : RichText.TableElement

Table data cell.

TableElement

@Serializable

sealed class TableElement : RichText, RichText.Composite

Base class for table cells (header and data cells).

TableHeader

@Serializable

@SerialName(value = "tableHeader")

class TableHeader : RichText.TableElement

Table header cell.

TableRow

@Serializable

@SerialName(value = "table_row")

class TableRow : RichText, RichText.Composite

Table row node.

Text

@Serializable

@SerialName(value = "text")

class Text(val text: String = "", val marks: List<RichText.Mark> = emptyList()) : RichText

Text node containing plain text with optional marks (formatting).

TextAlign

enum TextAlign : Enum<RichText.TextAlign>

Text alignment options for paragraph and heading nodes.

Properties

type

val type: String

Technical name of the node type.