Mark types that be used for text spans
Types allowed as children of this block
Allowed block styles (eg normal
, blockquote
, h3
etc)
Allowed list item types (eg number
, bullet
etc)
Type name identifying this as a portable text block.
All items within a portable text array should have a _type
property.
Usually 'block', but can be customized to other values
Array of inline items for this block. Usually contain text spans, but can be configured to include inline objects of other types as well.
Optional
_keyA key that identifies this block uniquely within the parent array. Used to more easily address the block when editing collaboratively, but is also very useful for keys inside of React and other rendering frameworks that can use keys to optimize operations.
Optional
markArray of mark definitions used in child text spans. By having them be on the block level, the same mark definition can be reused for multiple text spans, which is often the case with nested marks.
Optional
styleVisual style of the block Common values: 'normal', 'blockquote', 'h1'...'h6'
Optional
listIf this block is a list item, identifies which style of list item this is Common values: 'bullet', 'number', but can be configured
Optional
levelIf this block is a list item, identifies which level of nesting it belongs within
A Portable Text Block can be thought of as one paragraph, quote or list item. In other words, it is a container for text, that can have a visual style associated with it. The actual text value is stored in portable text spans inside of the
childen
array.