PortableTextContent class

A content item that renders rich text content using the Portable Text format.

Portable Text supports:

  • Basic text formatting (bold, italic, underline)
  • Code blocks with syntax highlighting
  • Lists (ordered and unordered)
  • Custom blocks (cards, groups, dividers)
  • Custom marks with interactive behavior

Example:

final content = PortableTextContent(
  blocks: [
    TextBlockItem(children: [
      Span(text: 'Italic Text, ', marks: ['em']),
      Span(text: 'Bold Text, ', marks: ['strong']),
    ]),
    Card(title: 'Embedded Card'),
    TextBlockItem(children: [
      Span(text: 'Code: ', marks: ['code']),
    ]),
  ],
);
Inheritance
  • Object
  • ContentItem
  • PortableTextContent
Annotations
  • @JsonSerializable()

Constructors

PortableTextContent.new({List<PortableBlockItem>? blocks, LayoutConfiguration<ContentItem>? layout, List<ContentModifierConfiguration>? modifiers})
PortableTextContent.fromJson(Map<String, dynamic> json)
factory

Properties

blocks → List<PortableBlockItem>?
final
hashCode → int
The hash code for this object.
no setterinherited
layout → LayoutConfiguration<ContentItem>?
The layout configuration for the content item.
finalinherited
modifiers → List<ContentModifierConfiguration>?
finalinherited
parent ↔ ContentItem?
The parent content item of this content item. This is used internally by the content system.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaType → String
The schema type of the content item.
finalinherited

Methods

getLayout() → LayoutConfiguration<ContentItem>?
Gets the layout to use for the ContentItem. By default its the layout itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying layouts.
inherited
getModifiers() → List<ContentModifierConfiguration>?
Gets the modifiers to use for the ContentItem. By default its the modifiers itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying modifiers.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setParent(Iterable<ContentItem?> children) → void
Sets the parent content item for the given list of children.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

contentBuilder → _PortableTextContentBuilder
final
typeDescriptor → TypeDescriptor<PortableTextContent>
final

Static Methods

blockItemsFromJson(dynamic value) → List<PortableBlockItem>?

Constants

schemaName → const String