Ricos Document

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

A Ricos document object defines rich content.

The object structure of a Ricos document is a tree of nodes that represent blocks of content. Some nodes are basic, such as paragraphs, and some nodes are complex, such as tables.

A Ricos document has a similar structure to HTML, in which node types resemble tags, fields resemble attributes, and nodes resemble the children of HTML tags. The main difference is that a Ricos document has more constraints, which makes it easier to manipulate it and display the content in different environments.

Important:

When creating a Ricos Document to use with a Wix API, make sure to check which plugins the API enables.

Playground

While using this reference, you can build, view, or edit your rich content using the Ricos playground. You can build your content in the Editor tab, view it in the Viewer tab, and edit or copy and paste it from the Document tab.

Key concepts

Here are some key concepts that you may need to build your Ricos document.

Node IDs

Every node in a Ricos object must have a unique ID. A node ID must start with a letter and can contain only letters, numbers, hyphens, and underscores.

The Ricos playground automatically generates node IDs, but if you aren't using the playground, you must add node IDs yourself.

Tagged unions

Some nodes, which are specified in this reference are tagged unions. Tagged unions are a way to represent a value that can be one of several different, but fixed, types. In Ricos, these types are different nodes.

Tagged unions contain a tag that define which type the value is. In Ricos, this tag is the type field, and it tells the Ricos Content viewer how to display the content.

Learn more about tagged unions.

Formats

FormatDescription
WEB_URLA URL that starts with http:// or https://.
COLOR_HEXA color in hexadecimal RGB or RGBA format, for example #FF0000 or #FF000050. COLOR_HEX accepts shorthand, for example #F00 or #F005.
NODE_IDSee Node ID.

Plugins

Full list of Ricos plugins:

Root-level type

RicosDocument
FieldTypeDescription
nodes
Required
Array <RootNode>Array of nodes representing content elements, such as ParagraphNode or HeadingNode.
metadataMetadataInformation about the Ricos document itself, such as its version. Only relevant when building the Ricos document using the Ricos playground, in which case it is auto-generated.
documentStyleDocumentStyleIncludes styling to be applied throughout the Ricos document for the specified node types. For example, you can define general styling for headerOne, and then override some of the properties separately for a specific header.

Nodes

Nodes are the containers for content. Each node is used for a different type of content.

Available nodes, sorted alphabetically.
RootNode

Used in: RicosDocument

Nodes that can be added to the root level of nodes array.

This type is a Tagged Union.

VariantTag valueDescription
AppEmbedNodeAPP_EMBEDEmbeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps.
AudioNodeAUDIOEmbeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio.
BlockquoteNodeBLOCKQUOTEUsed to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content.
BulletedListNodeBULLETED_LISTBulleted list.
ButtonNodeBUTTONButton to trigger an action.
CodeBlockNodeCODE_BLOCKPresents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code.
CollapsibleListNodeCOLLAPSIBLE_LISTList of items where each item can be expanded or collapsed.
DividerNodeDIVIDERHorizontal line between different content.
EmbedNodeEMBEDEmbedded content when you include a link to a resource, without having to parse the resource directly. This provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers. To learn more, see oembed.
FileNodeFILEFile that is uploaded and accessed in a page. Files can be different types of content, such as text documents, images, and videos.
GalleryNodeGALLERYCollection of images displayed together.
GifNodeGIFGIF images.
HeadingNodeHEADINGIndicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.
HtmlNodeHTMLHTML block that incorporates external content, such as interactive maps or entire web pages.
ImageNodeIMAGEStandalone images in a page.
LinkPreviewNodeLINK_PREVIEWPreview or summary of a webpage. Link previews include elements such as the title of the linked page, a brief description or excerpt of the content, and sometimes a thumbnail image or other relevant information.
OrderedListNodeORDERED_LISTNumbered list.
ParagraphNodePARAGRAPHStructures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.
PollNodePOLLProvides a question with several options, where the options' cumulative total may be shown.
TableNodeTABLEData in rows and columns.
VideoNodeVIDEOEmbeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video.

ParagraphNode

Used in: RootNode, BlockquoteNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Structures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.

Example: Paragraph
FieldTypeDescription
type
Required
"PARAGRAPH"Node type.
Must be PARAGRAPH.
nodesArray <TextNode>Paragraph children.
idstring
format NODE_ID
Node ID.
styleNodeStyleVertical padding.
Note: This node requires the lineSpacing plugin to be enabled.
paragraphDataParagraphDataParagraph node attributes.
ParagraphData

Used in: ParagraphNode

FieldTypeDescription
textStyleTextStyleParagraph text styling.
indentationint32
Paragraph margin from the left side.
The indentation is measured relative to 40px. For example, if the indentation is 2, then the margin is equal to 80px.

TextNode

Used in: ParagraphNode, HeadingNode, CodeBlockNode, CaptionNode

Text nodes hold the text itself, similar to how span tags hold text in HTML. Text nodes can't be nested and must contain a non-empty string. Their appearance and behavior can be modified using decorations.

Example: Text
FieldTypeDescription
type
Required
"TEXT"Node type.
Must be TEXT.
textData
Required
TextDataText options.
idstring
format NODE_ID
Node ID.
TextData

Used in: TextNode

FieldTypeDescription
text
Required
string

minLength: 1
Non-empty string to display as text.
decorationsArray <Decoration>
Unique Tags
Array of text decorations. A decoration can't appear twice in the array.

HeadingNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Indicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.

Example: Heading sizes
FieldTypeDescription
type
Required
"HEADING"Node type.
Must be HEADING.
nodesArray <TextNode>Child nodes to define the heading text.
idstring
format NODE_ID
Node ID.
styleNodeStyleHeading styling, such as padding and background color.
Note: This node requires the lineSpacing plugin to be enabled.
headingDataHeadingDataHeading options.
HeadingData

Used in: HeadingNode

FieldTypeDescription
levelint32

minimum: 1
maximum: 6
Heading size.
Mi: 1
Max: 6
textStyleTextStyleHeading text styling, such as text alignment and line height.
indentationint32
Heading margin from the left side.
The indentation is measured relative to the font size em units by a ratio of 1.5. For example, if the indentation is 2, then the margin is equal to 3em. Therefore the margin is 3 times the size of the font.

ImageNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `image` plugin to be enabled.

Standalone images in a page.

FieldTypeDescription
type
Required
"IMAGE"Node type.
Must be IMAGE.
imageData
Required
ImageDataImage options.
idstring
format NODE_ID
Node ID.
nodesArray <CaptionNode>Child nodes to define an image caption.
ImageData

Used in: ImageNode

FieldTypeDescription
image
Required
MediaImage file details.
containerDataPluginContainerDataImage container styling.
linkLinkImage link details.
disableExpandboolean
Whether the image expands to the full screen when clicked.
Default: false
altTextstring
Alternate text to display when the image doesn't load.
caption
Deprecated
string
Deprecated. Use CaptionNode instead.
disableDownloadboolean
Whether the download image button is disabled.
Default: false

CaptionNode

Used in: VideoNode, GifNode, ImageNode

Caption container to be attached to media elements, such as images. Captions support formatted text content and can be styled independently from their parent nodes.

FieldTypeDescription
type
Required
"CAPTION"Node type.
Must be CAPTION.
nodes
Required
Array <TextNode>
idstring
Caption node ID.
styleNodeStyleDefines the caption styling, such as padding and background color.
Note: This node requires the lineSpacing plugin to be enabled.
captionDataCaptionDataCaption options.
CaptionData

Used in: CaptionNode

FieldTypeDescription
textStyleTextStyleCaption text styling.

OrderedListNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Numbered list.

Example: Ordered list
FieldTypeDescription
type
Required
"ORDERED_LIST"Node type.
Must be ORDERED_LIST.
nodes
Required
Array <ListItemNode>
minItems: 1
List items.
idstring
format NODE_ID
Node ID.
orderedListDataOrderedListDataOrdered list details.
OrderedListData

Used in: OrderedListNode

FieldTypeDescription
indentation
Deprecated
int32
List margin from the left side.
The indentation is measured relative to the font size em units by a ratio of 1.5. For example, if the indentation is 2, then the margin is equal to 3em. Therefore the margin is 3 times the size of the font.
offsetint32
Additional indentation of a list node. When offset is 0, the list node appears at its default nesting level. Higher values cause increased indentation.
startint32
Number at the top of the numbered list.
Default: 1

BulletedListNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Bulleted list.

Example: Bulleted list
FieldTypeDescription
type
Required
"BULLETED_LIST"Node type.
Must be BULLETED_LIST.
nodes
Required
Array <ListItemNode>
minItems: 1
List items.
idstring
format NODE_ID
Node ID.
bulletedListDataBulletedListDataBulleted list details.
BulletedListData

Used in: BulletedListNode

FieldTypeDescription
indentation
Deprecated
int32
offsetint32
Additional indentation of a list node. When offset is 0, the list node appears at its default nesting level. Higher values cause increased indentation.
ListItemNode

Used in: BulletedListNode, OrderedListNode

Items in the nodes field must have the following structure and order:

(PARAGRAPH|HEADING|IMAGE|VIDEO|GIF|GALLERY) (PARAGRAPH|BULLETED_LIST|ORDERED_LIST|HEADING|IMAGE|VIDEO|GIF|GALLERY)*

Must start with a paragraph or heading, followed by any number of paragraphs, bulleted lists, or ordered lists.

FieldTypeDescription
type
Required
"LIST_ITEM"Node type.
Value: LIST_ITEM
nodes
Required
Array <ListItemChildNode>Child nodes that the list item contains.
Array items must adhere to the pattern described above this table.
idstring
format NODE_ID
Node ID.
ListItemChildNode

Used in: ListItemNode

This type is a Tagged Union.

VariantTag valueDescription
BulletedListNodeBULLETED_LISTBulleted list.
GalleryNodeGALLERYCollection of images displayed together.
GifNodeGIFGIF images.
HeadingNodeHEADINGIndicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.
ImageNodeIMAGEStandalone images in a page.
OrderedListNodeORDERED_LISTNumbered list.
ParagraphNodePARAGRAPHStructures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.
VideoNodeVIDEOEmbeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video.

BlockquoteNode

Used in: RootNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content.

Example: Blockquote
FieldTypeDescription
type
Required
"BLOCKQUOTE"Node type.
Must be BLOCKQUOTE.
nodes
Required
Array <ParagraphNode>
minItems: 1
maxItems: 1
Child nodes to define a blockquote paragraph.
idstring
format NODE_ID
Node ID.
blockquoteDataBlockquoteDataBlockquote details.
styleNodeStyleDefines the blockquote style, such as padding and background color.
Note: This node requires the lineSpacing plugin to be enabled.
BlockquoteData

Used in: BlockquoteNode

FieldTypeDescription
indentationint32
Blockquote margin from the left side.
The indentation is measured relative to the font size em units by a ratio of 1.5. For example, if the indentation is 2, then the margin is equal to 3em. Therefore the margin is 3 times the size of the font.

GifNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `giphy` plugin to be enabled.

GIF images.

Example: GIF
FieldTypeDescription
type
Required
"GIF"Node type.
Must be GIF.
gifData
Required
GIFDataGIF details.
idstring
format NODE_ID
Node ID.
nodesArray <CaptionNode>Child nodes to define a GIF caption.
GIFData

Used in: GifNode

FieldTypeDescription
containerDataPluginContainerDataGIF container styling.
originalGIFSource for the full size GIF.
downsizedGIFSource for the downsized GIF.
heightint32
Height in pixels.
widthint32
Width in pixels.
GIF

Used in: GIFData

FieldTypeDescription
gifstring
format WEB_URL
GIF source URL.
mp4string
format WEB_URL
MP4 source URL.
stillstring
format WEB_URL
GIF thumbnail URL.

VideoNode

Used in: RootNode, ListItemChildNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `video` plugin to be enabled.

Embeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video.

FieldTypeDescription
type
Required
"VIDEO"Node type.
Must be VIDEO.
videoData
Required
VideoDataVideo details.
idstring
format NODE_ID
Node ID.
nodesArray <CaptionNode>Child nodes to define a video caption.
VideoData

Used in: VideoNode

FieldTypeDescription
video
Required
MediaVideo file details.
containerDataPluginContainerDataVideo container styling.
thumbnailMediaVideo thumbnail details.
disableDownloadboolean
Whether the video download button is disabled.
Default: false
titlestring
Video title.
optionsPlaybackOptionsPlayback details.
PlaybackOptions

Used in: VideoData

FieldTypeDescription
autoPlayboolean
Whether the media automatically starts playing after opening a page.
playInLoopboolean
Whether the media is looped.
showControlsboolean
Whether to show the media controls.

TableNode

Used in: RootNode, CollapsibleItemBodyChildNode

Note: This type requires the `table` plugin to be enabled.

Data in rows and columns.

Example: Basic table
FieldTypeDescription
type
Required
"TABLE"Node type.
Must be TABLE.
nodes
Required
Array <TableRowNode>
minItems: 1
Child nodes to define table rows.
idstring
format NODE_ID
Node ID.
tableDataTableDataTable details.
TableRowNode

Used in: TableNode

FieldTypeDescription
type
Required
"TABLE_ROW"Node type.
Must be TABLE_ROW.
nodes
Required
Array <TableCellNode>
minItems: 1
Child nodes to define table cells.
idstring
format NODE_ID
Node ID.
TableData

Used in: TableNode

FieldTypeDescription
containerDataPluginContainerDataTable container styling.
dimensionsTableData_DimensionsTable dimensions.
rowHeaderboolean
Whether the table's first row is a heading.
Default: false
columnHeaderboolean
Whether the table's first column is a heading.
Default: false
TableData_Dimensions

Used in: TableData

FieldTypeDescription
colsWidthRatioArray <float64
>
Each column width as a fraction to the width of table.
rowsHeightArray <uint32
>
Height of each row.
colsMinWidthArray <uint32
>
Minimum width of each column.
TableCellNode

Used in: TableRowNode

FieldTypeDescription
type
Required
"TABLE_CELL"Node type.
Must be TABLE_CELL.
nodes
Required
Array <TableCellChildNode>
minItems: 1
Child nodes to define cell content.
idstring
format NODE_ID
Node ID.
tableCellDataTableCellDataTable cell details.
TableCellChildNode

Used in: TableCellNode

Table cell content node.

This type is a Tagged Union.

VariantTag valueDescription
AppEmbedNodeAPP_EMBEDEmbeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps.
AudioNodeAUDIOEmbeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio.
BlockquoteNodeBLOCKQUOTEUsed to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content.
BulletedListNodeBULLETED_LISTBulleted list.
ButtonNodeBUTTONButton to trigger an action.
CodeBlockNodeCODE_BLOCKPresents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code.
DividerNodeDIVIDERHorizontal line between different content.
EmbedNodeEMBEDEmbedded content when you include a link to a resource, without having to parse the resource directly. This provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers. To learn more, see oembed.
FileNodeFILEFile that is uploaded and accessed in a page. Files can be different types of content, such as text documents, images, and videos.
GifNodeGIFGIF images.
HeadingNodeHEADINGIndicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.
HtmlNodeHTMLHTML block that incorporates external content, such as interactive maps or entire web pages.
ImageNodeIMAGEStandalone images in a page.
LinkPreviewNodeLINK_PREVIEWPreview or summary of a webpage. Link previews include elements such as the title of the linked page, a brief description or excerpt of the content, and sometimes a thumbnail image or other relevant information.
OrderedListNodeORDERED_LISTNumbered list.
ParagraphNodePARAGRAPHStructures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.
VideoNodeVIDEOEmbeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video.
TableCellData

Used in: TableCellNode

FieldTypeDescription
cellStyleTableCellData_CellStyleCell styling.
borderColorsTableCellData_BorderColorsCell border colors.
TableCellData_CellStyle

Used in: TableCellData

FieldTypeDescription
verticalAlignmentenum: "TOP", "MIDDLE", "BOTTOM"Vertical alignment for the cell's text.
backgroundColorstring
format COLOR_HEX
Cell background color as a hexadecimal value.
TableCellData_BorderColors

Used in: TableCellData

FieldTypeDescription
leftstring
format COLOR_HEX
Left border color as a hexadecimal value.
rightstring
format COLOR_HEX
Right border color as a hexadecimal value.
topstring
format COLOR_HEX
Top border color as a hexadecimal value.
bottomstring
format COLOR_HEX
Bottom border color as a hexadecimal value.

AppEmbedNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `appEmbed` plugin to be enabled.

Embeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps.

FieldTypeDescription
type
Required
"APP_EMBED"Node type.
Must be APP_EMBED.
appEmbedData
Required
AppEmbedDataEmbedded Wix app.
idstring
format NODE_ID
Node ID.
AppEmbedData

Used in: AppEmbedNode

This type is a Tagged Union.

VariantTag valueDescription
AppEmbedDataBookingBOOKINGEmbeds a booking from Wix Bookings.
AppEmbedDataEventEVENTEmbeds an event from Wix Events.
AppEmbedDataProductPRODUCTEmbedded a product from Wix Stores.
AppEmbedDataProduct

Used in: AppEmbedData

Embedded a product from Wix Stores.

FieldTypeDescription
type
Required
"PRODUCT"Must be PRODUCT.
name
Required
string
Embedded content name.
url
Required
string
Embedded content URL.
imageMediaEmbedded content thumbnail.
itemIdstring
Embedded content ID.
imageSrc
Deprecated
string
Deprecated: Use image instead.
AppEmbedDataEvent

Used in: AppEmbedData

Embeds an event from Wix Events.

FieldTypeDescription
type
Required
"EVENT"Must be EVENT.
name
Required
string
Embedded content name.
url
Required
string
Embedded content URL.
eventDataAppEmbedData_EventDataEmbedded event content.
imageMediaEmbedded content thumbnail.
itemIdstring
Embedded content ID.
imageSrc
Deprecated
string
Deprecated: Use image instead.
AppEmbedDataBooking

Used in: AppEmbedData

Embeds a booking from Wix Bookings.

FieldTypeDescription
type
Required
"BOOKING"
name
Required
string
Embedded content name.
url
Required
string
Embedded content URL.
imageMediaEmbedded content thumbnail.
itemIdstring
Embedded content ID.
bookingDataAppEmbedData_BookingDataEmbedded booking content.
imageSrc
Deprecated
string
Deprecated: Use image instead.
AppEmbedData_BookingData

Used in: AppEmbedDataBooking

FieldTypeDescription
durationsstring
Booking duration in minutes.
AppEmbedData_EventData

Used in: AppEmbedDataEvent

FieldTypeDescription
schedulingstring
Event schedule.
locationstring
Event location.

EmbedNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `linkPreview` plugin to be enabled.

Embedded content when you include a link to a resource, without having to parse the resource directly. This provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers. To learn more, see oembed.

Example: oEmbed
FieldTypeDescription
type
Required
"EMBED"Node type.
Must be EMBED.
embedData
Required
EmbedDataoEmbed details.
idstring
format NODE_ID
Node ID.
EmbedData

Used in: EmbedNode

FieldTypeDescription
containerDataPluginContainerDataoEmbed node container styling.
oembedOembedoEmbed details.
srcstring
Original asset source.
Oembed

Used in: EmbedData

FieldTypeDescription
typestring
Resource type.
widthint32
Width of the resource specified in the url field in pixels.
heightint32
Height of the resource specified in the url field in pixels.
titlestring
Resource title.
urlstring
Resource source URL.
htmlstring
HTML to embed a video player. The HTML should have no padding or margins.
authorNamestring
Name of the author or owner of the resource.
authorUrlstring
URL for the author or owner of the resource.
providerNamestring
Name of the resource provider.
providerUrlstring
URL for the resource provider.
thumbnailUrlstring
Thumbnail image URL for the resource. If defined, thumbnailWidth and thumbnailHeight must also be defined.
thumbnailWidthstring
Resource's thumbnail image width. If defined, thumbnailUrl and thumbnailHeight must also be defined.
thumbnailHeightstring
Resource's thumbnail image height. If defined, thumbnailUrl and thumbnailWidthmust also be defined.
videoUrlstring
Embedded video URL.
versionstring
The oEmbed version number. Must be 1.0.

DividerNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `divider` plugin to be enabled.

Horizontal line between different content.

Example: Divider
FieldTypeDescription
type
Required
"DIVIDER"Node type.
Must be DIVIDER.
idstring
format NODE_ID
Node ID.
dividerDataDividerDataDivider details.
DividerData

Used in: DividerNode

FieldTypeDescription
containerDataPluginContainerDataDivider container styling.
lineStyleenum: "SINGLE", "DOUBLE", "DASHED", "DOTTED"Divider line style.
widthenum: "LARGE", "MEDIUM", "SMALL"Divider width.
alignmentenum: "CENTER", "LEFT", "RIGHT"Divider alignment.

CodeBlockNode

Used in: RootNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `codeBlock` plugin to be enabled.

Presents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code.

FieldTypeDescription
type
Required
"CODE_BLOCK"Node type.
VMust be CODE_BLOCK.
nodesArray <TextNode>Child nodes to define a code block text.
idstring
format NODE_ID
Node ID.
codeBlockDataCodeBlockDataCode block details.
styleNodeStyleCode block styling, such as padding and background color.
Note: This node requires the lineSpacing plugin to be enabled.
CodeBlockData

Used in: CodeBlockNode

FieldTypeDescription
textStyleTextStyleDefines the text styling, such as alignment and line height.

LinkPreviewNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `linkPreview` plugin to be enabled.

Preview or summary of a webpage. Link previews include elements such as the title of the linked page, a brief description or excerpt of the content, and sometimes a thumbnail image or other relevant information.

Example: Link preview
FieldTypeDescription
type
Required
"LINK_PREVIEW"Node type.
Must be LINK_PREVIEW.
linkPreviewData
Required
LinkPreviewDataLink preview details.
idstring
format NODE_ID
Node ID.
LinkPreviewData

Used in: LinkPreviewNode

FieldTypeDescription
containerDataPluginContainerDataLink preview container styling.
linkLinkLink details.
titlestring
Preview title.
thumbnailUrlstring
Preview thumbnail URL.
descriptionstring
Preview description.
htmlstring
Preview content as HTML.

AudioNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `audio` plugin to be enabled.

Embeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio.

Example: SoundCloud audio
FieldTypeDescription
type
Required
"AUDIO"Node type.
Must be AUDIO.
idstring
format NODE_ID
Node ID.
audioDataAudioDataAudio details.
AudioData

Used in: AudioNode

FieldTypeDescription
containerDataPluginContainerDataAudio node container styling.
audioMediaAudio file details.
disableDownloadboolean
Whether the audio download button is disabled.
Default: false
coverImageMediaCover image.
namestring
Track name.
authorNamestring
Author name.
htmlstring
HTML version of the audio node.

GalleryNode

Used in: RootNode, ListItemChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `gallery` plugin to be enabled.

Collection of images displayed together.

Example: Gallery
FieldTypeDescription
type
Required
"GALLERY"Node type.
Must be GALLERY.
galleryData
Required
GalleryDataGallery node details.
idstring
format NODE_ID
Node ID.
GalleryData

Used in: GalleryNode

FieldTypeDescription
items
Required
Array <GalleryData_Item>
minItems: 1
Gallery items details.
containerDataPluginContainerDataGallery container styling.
optionsGalleryOptionsGallery appearance options.
disableExpandboolean
Whether the expand button is disabled.
Default: false
disableDownloadboolean
Whether the download button is disabled.
Default: false
GalleryOptions

Used in: GalleryData

FieldTypeDescription
layoutGalleryOptions_LayoutGallery layout.
itemGalleryOptions_ItemStyleStyling for gallery items.
thumbnailsGalleryOptions_ThumbnailsStyling for gallery thumbnail images.
GalleryOptions_Layout

Used in: GalleryOptions

FieldTypeDescription
typeenum: "COLLAGE", "MASONRY", "GRID", "THUMBNAIL", "SLIDER", "SLIDESHOW", "PANORAMA", "COLUMN", "MAGIC", "FULLSIZE"Gallery layout. Supported values:
- COLLAGE: Presents images in various sizes and positions, creating an artistic or dynamic layout.
- MASONRY: Grid-based design that places items in optimal positions based on available vertical space, creating an arrangement where items of varying heights fit together like bricks in a wall.
- GRID: A layout structure that organizes items into rows and columns, creating a uniform arrangement of images.
- THUMBNAIL: Smaller, scaled-down version of an image that serves as a preview.
- SLIDER: Component that allows users to browse through a set of images by sliding or swiping through them, typically in a confined viewing area.
- SLIDESHOW: A component that automatically or manually transitions through a set of images in a designated area.
- PANORAMA: Wide-angle or 360-degree image that allows users to view an extended horizontal view of a scene.
- COLUMN: Arrangement of the gallery items in vertical sections.
- MAGIC: Visually stunning, dynamic effects that enhance the user experience.
- FULLSIZE: A layout where each image or item is displayed at its full size, sometimes taking up the entire viewport or a significant portion of the screen.
horizontalScrollboolean
Whether the horizontal scroll is enabled.
Default: true, unless the type field is set to GRID or COLLAGE.
orientationenum: "ROWS", "COLUMNS"Gallery orientation.
numberOfColumnsint32
Number of columns to display on computer screens.
mobileNumberOfColumnsint32
Number of columns to display on mobile phone screens.
GalleryOptions_ItemStyle

Used in: GalleryOptions

FieldTypeDescription
targetSizeint32
Dimensions for each gallery item in pixels. Behavior may change with gallery type.
ratiofloat64
Height to width ratio.
cropenum: "FILL", "FIT"Cropping strategy. Supported values:
- FILL: Each item in the gallery is cropped and resized to completely fill its container.
- FIT: Each item in the gallery is resized to fit exactly in its container without cropping.
spacingint32
Spacing between gallery items in pixels.
GalleryOptions_Thumbnails

Used in: GalleryOptions

FieldTypeDescription
placementenum: "TOP", "RIGHT", "BOTTOM", "LEFT", "NONE"Thumbnail alignment.
spacingint32
Spacing between thumbnails in pixels.
GalleryData_Item

Used in: GalleryData

You must provide exactly one of the following fields: image, video.
FieldTypeDescription
titlestring
Item title.
altTextstring
Item's alternative text.
image
Exactly one of
GalleryData_Item_ImageImage item.
video
Exactly one of
GalleryData_Item_VideoVideo item.
GalleryData_Item_Video

Used in: GalleryData_Item

FieldTypeDescription
media
Required
MediaVideo file details.
thumbnailMediaVideo thumbnail file details.
GalleryData_Item_Image

Used in: GalleryData_Item

FieldTypeDescription
media
Required
MediaImage file details.
linkLinkLink details for images, if relevant.

CollapsibleListNode

Used in: RootNode, CollapsibleItemBodyChildNode

Note: This type requires the `collapsibleList` plugin to be enabled.

List of items where each item can be expanded or collapsed.

Example: Collapsible List
FieldTypeDescription
type
Required
"COLLAPSIBLE_LIST"Node type.
Must be COLLAPSIBLE_LIST
nodes
Required
Array <CollapsibleItemNode>
minItems: 1
Collapsible list child nodes.
idstring
format NODE_ID
Node ID.
collapsibleListDataCollapsibleListDataCollapsible list details.
CollapsibleListData

Used in: CollapsibleListNode

FieldTypeDescription
containerDataPluginContainerDataCollapsible list container styling.
expandOnlyOneboolean
Whether only one item can be expanded at a time.
Default: false.
initialExpandedItemsenum: "FIRST", "ALL", "NONE"Sets which items are automatically expanded after the page loads.
directionenum: "LTR", "RTL"Direction of the text in the list. Supported values:
- LTR: Left to right.
- RTL: Right to left.
isQapageDataboolean
Whether the collapsible item will appear in search results as an FAQ.
CollapsibleItemNode

Used in: CollapsibleListNode

Items in the nodes field must have the following structure and order:

COLLAPSIBLE_ITEM_TITLE COLLAPSIBLE_ITEM_BODY

Must contain title as the first item and body as the second.

FieldTypeDescription
type
Required
"COLLAPSIBLE_ITEM"Node type.
Must be COLLAPSIBLE_ITEM
nodes
Required
Array <CollapsibleItemChildNode>Collapsible list item.
Array items must adhere to the pattern described above this table.
idstring
format NODE_ID
Node ID.
CollapsibleItemChildNode

Used in: CollapsibleItemNode

This type is a Tagged Union.

VariantTag valueDescription
CollapsibleItemBodyNodeCOLLAPSIBLE_ITEM_BODYCollapsible list item body.
CollapsibleItemTitleNodeCOLLAPSIBLE_ITEM_TITLECollapsible list item title.
CollapsibleItemTitleNode

Used in: CollapsibleItemChildNode

Collapsible list item title.

FieldTypeDescription
type
Required
"COLLAPSIBLE_ITEM_TITLE"Node type.
Must be COLLAPSIBLE_ITEM_TITLE.
nodes
Required
Array <CollapsibleTitleChildNode>
minItems: 1
maxItems: 1
Collapsible list item title child nodes.
idstring
format NODE_ID
Node ID.
CollapsibleTitleChildNode

Used in: CollapsibleItemTitleNode

This type is a Tagged Union.

VariantTag valueDescription
BlockquoteNodeBLOCKQUOTEUsed to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content.
BulletedListNodeBULLETED_LISTBulleted list.
CodeBlockNodeCODE_BLOCKPresents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code.
HeadingNodeHEADINGIndicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.
OrderedListNodeORDERED_LISTNumbered list.
ParagraphNodePARAGRAPHStructures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.
CollapsibleItemBodyNode

Used in: CollapsibleItemChildNode

Collapsible list item body.

FieldTypeDescription
type
Required
"COLLAPSIBLE_ITEM_BODY"Node type.
Must be COLLAPSIBLE_ITEM_BODY.
nodes
Required
Array <CollapsibleItemBodyChildNode>
minItems: 1
Collapsible list item body child nodes.
idstring
format NODE_ID
Node ID.
CollapsibleItemBodyChildNode

Used in: CollapsibleItemBodyNode

Collapsible list item body.

This type is a Tagged Union.

VariantTag valueDescription
AppEmbedNodeAPP_EMBEDEmbeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps.
AudioNodeAUDIOEmbeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio.
BlockquoteNodeBLOCKQUOTEUsed to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content.
BulletedListNodeBULLETED_LISTBulleted list.
ButtonNodeBUTTONButton to trigger an action.
CodeBlockNodeCODE_BLOCKPresents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code.
CollapsibleListNodeCOLLAPSIBLE_LISTList of items where each item can be expanded or collapsed.
DividerNodeDIVIDERHorizontal line between different content.
EmbedNodeEMBEDEmbedded content when you include a link to a resource, without having to parse the resource directly. This provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers. To learn more, see oembed.
FileNodeFILEFile that is uploaded and accessed in a page. Files can be different types of content, such as text documents, images, and videos.
GalleryNodeGALLERYCollection of images displayed together.
GifNodeGIFGIF images.
HeadingNodeHEADINGIndicates a heading or title of a section. There are 6 levels of headings, with 1 being the most prominent and 6 being the least.
HtmlNodeHTMLHTML block that incorporates external content, such as interactive maps or entire web pages.
ImageNodeIMAGEStandalone images in a page.
LinkPreviewNodeLINK_PREVIEWPreview or summary of a webpage. Link previews include elements such as the title of the linked page, a brief description or excerpt of the content, and sometimes a thumbnail image or other relevant information.
OrderedListNodeORDERED_LISTNumbered list.
ParagraphNodePARAGRAPHStructures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.
PollNodePOLLProvides a question with several options, where the options' cumulative total may be shown.
TableNodeTABLEData in rows and columns.
VideoNodeVIDEOEmbeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video.

FileNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `file` plugin to be enabled.

File that is uploaded and accessed in a page. Files can be different types of content, such as text documents, images, and videos.

FieldTypeDescription
type
Required
"FILE"Node type.
Must be FILE.
fileData
Required
FileDataFile details.
idstring
format NODE_ID
Node ID.
FileData

Used in: FileNode

FieldTypeDescription
containerDataPluginContainerDataFile container styling.
srcFileSourceFile data source.
namestring
File name.
typestring
File type.
size
Deprecated
uint32
Deprecated. Replaced by sizeInKb
sizeInKbstring
File size in KB.
pdfSettingsFileData_PDFSettingsSettings for PDF files.
mimeTypestring
File MIME type.
pathstring
File path.
FileData_PDFSettings

Used in: FileData

FieldTypeDescription
viewModeenum: "NONE", "FULL", "MINI"PDF view mode. Supported values:
- NONE: PDF isn't displayed.
- FULL: Full PDF page view is displayed.
- MINI: Mini view of the PDF is displayed.
disableDownloadboolean
Whether the PDF download button is disabled.
Default: false
disablePrintboolean
Whether the PDF print button is disabled.
Default: false

ButtonNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `actionButton`, `linkButton` plugins to be enabled.

Button to trigger an action.

FieldTypeDescription
type
Required
"BUTTON"Node type.
Must be BUTTON
buttonData
Required
ButtonDataButton details.
idstring
format NODE_ID
Node ID.
ButtonData

Used in: ButtonNode

FieldTypeDescription
type
Required
enum: "LINK", "ACTION"Button type. Supported values:
- LINK: Redirects to a webpage.
- ACTION: Performs an action.
text
Required
string
Button text.
containerDataPluginContainerDataButton container styling.
stylesButtonData_StylesButton styling.
linkLinkButton link details.
ButtonData_Styles

Used in: ButtonData

FieldTypeDescription
borderButtonData_Styles_BorderBorder properties.
colorsButtonData_Styles_ColorsColor properties.
ButtonData_Styles_Colors

Used in: ButtonData_Styles

FieldTypeDescription
textstring
Text color as a hexadecimal value.
borderstring
Border color as a hexadecimal value.
backgroundstring
Background color as a hexadecimal value.
ButtonData_Styles_Border

Used in: ButtonData_Styles

FieldTypeDescription
widthint32
Border width in pixels.
radiusint32
Border radius in pixels.

PollNode

Used in: RootNode, CollapsibleItemBodyChildNode

Note: This type requires the `poll` plugin to be enabled.

Provides a question with several options, where the options' cumulative total may be shown.

Example: Poll
FieldTypeDescription
type
Required
"POLL"Node type.
Must be POLL.
pollData
Required
PollDataPoll details.
idstring
format NODE_ID
Node ID.
PollData

Used in: PollNode

FieldTypeDescription
containerDataPluginContainerDataPoll container styling.
pollPollData_PollPoll data.
layoutPollData_LayoutPoll layout settings.
designPollData_DesignPoll design.
PollData_Poll

Used in: PollData

FieldTypeDescription
idstring
format NODE_ID
Node ID.
titlestring
Poll title.
creatorIdstring
Poll creator ID.
imageMediaMain poll image.
optionsArray <PollData_Poll_Option>Poll details.
settingsPollData_Poll_SettingsPoll display settings.
PollData_Poll_Option

Used in: PollData_Poll

FieldTypeDescription
idstring
Poll option ID.
titlestring
Poll option title
imageMediaImage displayed with the option.
PollData_Poll_Settings

Used in: PollData_Poll

FieldTypeDescription
permissionsPollData_Poll_Settings_PermissionsVoting permission settings.
showVotersboolean
Whether to display the voters in the vote results.
Default: true.
showVotesCountboolean
Whether to display the vote count.
Default: true.
PollData_Poll_Settings_Permissions

Used in: PollData_Poll_Settings

FieldTypeDescription
viewenum: "CREATOR", "VOTERS", "EVERYONE"Who can view the poll results.
voteenum: "SITE_MEMBERS", "ALL"Who can vote.
allowMultipleVotesboolean
Whether a user can vote multiple times.
Default: false
PollData_Layout

Used in: PollData

FieldTypeDescription
pollPollData_Layout_PollLayoutPoll layout settings.
optionsPollData_Layout_OptionLayoutPoll options layout settings.
PollData_Layout_PollLayout

Used in: PollData_Layout

FieldTypeDescription
typeenum: "LIST", "GRID"Voting options layout.
directionenum: "LTR", "RTL"Direction of the text in the poll. Supported values:
- LTR: Left to right.
- RTL: Right to left.
enableImageboolean
Whether to display the main poll image.
Default: false
PollData_Layout_OptionLayout

Used in: PollData_Layout

FieldTypeDescription
enableImageboolean
Whether to display option images.
Defaults: false.
PollData_Design

Used in: PollData

FieldTypeDescription
pollPollData_Design_PollDesignPoll styling.
optionsPollData_Design_OptionDesignVoting options styling.
PollData_Design_PollDesign

Used in: PollData_Design

FieldTypeDescription
backgroundPollData_Design_PollDesign_BackgroundPoll background styling.
borderRadiusint32
Border radius in pixels.
PollData_Design_PollDesign_Background

Used in: PollData_Design_PollDesign

This type is a Tagged Union.

VariantTag valueDescription
PollData_Background_ColorVariantCOLOR
PollData_Background_GradientVariantGRADIENT
PollData_Background_ImageVariantIMAGE
PollData_Background_ColorVariant

Used in: PollData_Design_PollDesign_Background

FieldTypeDescription
type
Required
"COLOR"
colorstring
format COLOR_HEX
Background color as a hexademical value.
PollData_Background_ImageVariant

Used in: PollData_Design_PollDesign_Background

FieldTypeDescription
type
Required
"IMAGE"
imageMediaImage to use for the background.
PollData_Background_GradientVariant

Used in: PollData_Design_PollDesign_Background

FieldTypeDescription
type
Required
"GRADIENT"
gradientPollData_Design_PollDesign_Background_GradientGradient background details.
PollData_Design_PollDesign_Background_Gradient

Used in: PollData_Background_GradientVariant

FieldTypeDescription
angleint32
Gradient angle in degrees.
startColorstring
format COLOR_HEX
Start color as a hexadecimal value.
lastColorstring
format COLOR_HEX
End color as a hexadecimal value.
PollData_Design_OptionDesign

Used in: PollData_Design

FieldTypeDescription
borderRadiusint32
Border radius in pixels.

HtmlNode

Used in: RootNode, TableCellChildNode, CollapsibleItemBodyChildNode

Note: This type requires the `html` plugin to be enabled.

HTML block that incorporates external content, such as interactive maps or entire web pages.

FieldTypeDescription
type
Required
"HTML"Node type.
Mst be HTML.
htmlData
Required
HTMLDataHTML details.
idstring
format NODE_ID
Node ID.
HTMLData

Used in: HtmlNode

You must provide at least one of the following fields: url, html.
FieldTypeDescription
containerDataPluginContainerDataHTML node container styling.
sourceenum: "HTML", "ADSENSE"HTML code type. Possible values:
- HTML: HTML code.
- ADSENSE: Service provided by Google for rendering advertisements on web pages.
url
At least one of
string
HTML code URL.
html
At least one of
string
HTML code.

Decorations

Decorations are styles applied to text in nodes. A node can accept multiple styles at once.

Important:

Applying the same style more than once to the same node may cause an error.

Decoration

Used in: TextNodeStyle, TextData

This type is a Tagged Union.

VariantTag valueDescription
AnchorDecorationANCHORMakes clickable text a different color. The link navigates to another section of the same page.
BoldDecorationBOLDBolds text, which makes it appear thicker and more prominent than normal text.
ColorDecorationCOLORStyles text using background and text colors.
Note: This decoration requires the colorDecoration plugin to be enabled.
FontSizeDecorationFONT_SIZEText font size.
ItalicDecorationITALICItalicizes text, which makes it appear slanted or italicized. Italics are typically used for emphasis, citations, or to distinguish certain types of content.
LinkDecorationLINKMakes clickable text a different color. The link navigates to another webpage or resource.
Note: This decoration requires the link plugin to be enabled.
MentionDecorationMENTIONText that mentions a specific user, often in social media platforms, forums, or content management systems.
Note: This decoration requires the mention plugin to be enabled.
SpoilerDecorationSPOILERBlurs text.
Note: This decoration requires the spoiler plugin to be enabled.
UnderlineDecorationUNDERLINEUnderlines text.

BoldDecoration

Used in: Decoration

Bolds text, which makes it appear thicker and more prominent than normal text.

Example: Bold decoration
FieldTypeDescription
type
Required
"BOLD"Decoration type.
Must be BOLD.
fontWeightValuefloat32
Font weight.

ItalicDecoration

Used in: Decoration

Italicizes text, which makes it appear slanted or italicized. Italics are typically used for emphasis, citations, or to distinguish certain types of content.

FieldTypeDescription
type
Required
"ITALIC"Decoration type.
Must be ITALIC.
italicDataboolean
Whether to enable the italic text.

UnderlineDecoration

Used in: Decoration

Underlines text.

FieldTypeDescription
type
Required
"UNDERLINE"Decoration type.
Must be UNDERLINE.
underlineDataboolean
Whether to underline the text.

SpoilerDecoration

Used in: Decoration

Note: This type requires the `spoiler` plugin to be enabled.

Blurs text.
Note: This decoration requires the spoiler plugin to be enabled.

FieldTypeDescription
type
Required
"SPOILER"Decoration type.
Must be SPOILER.
spoilerDataSpoilerDataSpoiler details.
SpoilerData

Used in: SpoilerDecoration

FieldTypeDescription
idstring
format NODE_ID
Node ID.

AnchorDecoration

Used in: Decoration

Makes clickable text a different color. The link navigates to another section of the same page.

FieldTypeDescription
type
Required
"ANCHOR"Decoration type.
Must be ANCHOR.
anchorDataAnchorDataAnchor details.
AnchorData

Used in: AnchorDecoration

FieldTypeDescription
anchorstring
Target Node ID to redirect to.

MentionDecoration

Used in: Decoration

Note: This type requires the `mention` plugin to be enabled.

Text that mentions a specific user, often in social media platforms, forums, or content management systems.
Note: This decoration requires the mention plugin to be enabled.

FieldTypeDescription
type
Required
"MENTION"Decoration type.
Must be MENTION.
mentionDataMentionDataAnchor details.
MentionData

Used in: MentionDecoration

FieldTypeDescription
namestring
Display name of the mentioned user.
slugstring
Username of the mentioned user. This is th text that appears after the "@".
idstring
ID of the mentioned user.

LinkDecoration

Used in: Decoration

Note: This type requires the `link` plugin to be enabled.

Makes clickable text a different color. The link navigates to another webpage or resource.
Note: This decoration requires the link plugin to be enabled.

Example: Link decoration
FieldTypeDescription
type
Required
"LINK"Decoration type.
Must be LINK.
linkDataLinkDataLink details.
LinkData

Used in: LinkDecoration

FieldTypeDescription
linkLinkLink object.

ColorDecoration

Used in: Decoration

Note: This type requires the `textColor`, `textHighlight` plugins to be enabled.

Styles text using background and text colors.
Note: This decoration requires the colorDecoration plugin to be enabled.

Example: Color decoration
FieldTypeDescription
type
Required
"COLOR"Decoration type.
Value: COLOR
colorDataColorDataColor details.
ColorData

Used in: ColorDecoration

FieldTypeDescription
backgroundstring
Background color as a hexadecimal value.
foregroundstring
Text color as a hexadecimal value.

FontSizeDecoration

Used in: Decoration

Text font size.

FieldTypeDescription
type
Required
"FONT_SIZE"Decoration type.
Must be FONT_SIZE.
fontSizeDataFontSizeDataFont size details.
FontSizeData

Used in: FontSizeDecoration

FieldTypeDescription
unitenum: "PX", "EM"Font size units.
valuefloat32
Font size value.

Common Types

Nodes and decorations that are commonly used in other types.

PluginContainerData

Used in: VideoData, DividerData, FileData, GalleryData, GIFData, HTMLData, ImageData, LinkPreviewData, PollData, ButtonData, CollapsibleListData, TableData, EmbedData, AudioData

FieldTypeDescription
widthPluginContainerData_WidthNode display width.
alignmentenum: "CENTER", "LEFT", "RIGHT"Node alignment in its container.
spoilerPluginContainerData_SpoilerSpoiler cover settings.
heightPluginContainerData_HeightNode display height.
textWrapboolean
Whether the text should wrap around the node when it's displayed. If textWrap is false, the node fills the width of its container.
Default: true for all node types except DIVIDER.
PluginContainerData_Spoiler

Used in: PluginContainerData

FieldTypeDescription
enabledboolean
Whether the spoiler cover is enabled.
Default: false
descriptionstring
Text displayed on the spoiler cover.
buttonTextstring
Text that appears on the button that removes the spoiler cover.
PluginContainerData_Width

Used in: PluginContainerData

Node display width.

You must provide at least one of the following fields: size, custom.
FieldTypeDescription
size
At least one of
enum: "CONTENT", "SMALL", "ORIGINAL", "FULL_WIDTH"Width of a node in a container. Supported values:
- CONTENT: Width of the container matches the content width.
- SMALL: Small width.
- ORIGINAL: Width of the container matches the original image width. Note: This value is only applicable for imageData containers.
FULL_WIDTH: Image container takes up the full width of the screen. Note: This value is only applicable for imageData containers.
custom
At least one of
string
A custom width value in pixels.
PluginContainerData_Height

Used in: PluginContainerData

FieldTypeDescription
customstring
Node display height in pixels.

NodeStyle

Used in: TextNodeStyle, ParagraphNode, HeadingNode, BlockquoteNode, CodeBlockNode, CaptionNode

Note: This type requires the `lineSpacing` plugin to be enabled.

FieldTypeDescription
paddingTopstring
The top padding value in pixels.
paddingBottomstring
The bottom padding value in pixels.
backgroundColor
Deprecated
string

TextStyle

Used in: ParagraphData, HeadingData, CodeBlockData, CaptionData

FieldTypeDescription
textAlignmentenum: "AUTO", "LEFT", "RIGHT", "CENTER", "JUSTIFY"Text alignment. Supported values:
- AUTO: Text aligns itself automatically.
- LEFT: Text is aligned to the left.
- RIGHT: Text is aligned to the right.
- CENTER: Text is centered.
- JUSTIFY: Text is justified to both margins.
Default: AUTO.
lineHeightstring
Vertical spacing between lines of text in an element.

Used in: ImageData, LinkPreviewData, ButtonData, LinkData, GalleryData_Item_Image

Link object.

You must provide exactly one of the following fields: url, anchor.
FieldTypeDescription
url
Exactly one of
string
Absolute URL to link to.
anchor
Exactly one of
string
Target Node ID to link to.
targetenum: "SELF", "BLANK", "PARENT", "TOP"The HTML target attribute value for the link. This property defines where the link opens.
Supported values:
SELF - Opens the link in the same frame.
BLANK - Opens the link in a new browser tab or window.
PARENT - Opens the link in the parent frame.
TOP - Opens the link in the full body of the link's browser tab or window.
Default: SELF
relLink_RelRelationship between the current document and the linked document.

Used in: Link

FieldTypeDescription
nofollowboolean
Indicates to search engine crawlers not to follow the link.
Default: false
sponsoredboolean
Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement.
Default: false
ugcboolean
Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page author.
Default: false
noreferrerboolean
Indicates that this link protects referral information from being passed to the target website.

FileSource

Used in: FileData, Media

File source object.

You must provide exactly one of the following fields: url, id.
FieldTypeDescription
url
Exactly one of
string
File source URL.
id
Exactly one of
string
ID that's resolved to a URL by a resolver function.
privateboolean
Whether the file's source is private. Learn more about private files in Wix (SDK

Media

Used in: VideoData, ImageData, AudioData, PollData_Poll, AppEmbedDataProduct, AppEmbedDataEvent, AppEmbedDataBooking, GalleryData_Item_Image, GalleryData_Item_Video, PollData_Poll_Option, PollData_Background_ImageVariant

FieldTypeDescription
src
Required
FileSourceFile source.
widthint32
Media width in pixels.
heightint32
Media height in pixels.
durationfloat64
Media duration in seconds. Only relevant for audio and video files.

Metadata

Metadata contains information about the Ricos document itself, such as its version.

Metadata

Used in: RicosDocument

FieldTypeDescription
versionint32
Ricos document version.
id
Deprecated
any
createdTimestamp
Deprecated
any
updatedTimestamp
Deprecated
any

Document Styles

Decorations included in DocumentStyle are applied throughout the Ricos document for the specified node types.

DocumentStyle

Used in: RicosDocument

Sets a default styling for specific node types throughout the entire Ricos Document. For example, you can set the text color for all Heading 1 nodes. You can override the styling of specific Text nodes separately using decorations.

FieldTypeDescription
headerOneTextNodeStyleStyle for the H1 nodes.
headerTwoTextNodeStyleStyle for the H2 nodes.
headerThreeTextNodeStyleStyle for the H3 nodes.
headerFourTextNodeStyleStyle for the H4 nodes.
headerFiveTextNodeStyleStyle for the H5 nodes.
headerSixTextNodeStyleStyle for the H6 nodes.
paragraphTextNodeStyleStyle for the paragraph nodes.
blockquoteTextNodeStyleStyle for the block quote nodes.
codeBlockTextNodeStyleStyle for the codeblock nodes.
TextNodeStyle

Used in: DocumentStyle

FieldTypeDescription
decorationsArray <Decoration>Text node decorations.
nodeStyleNodeStyleNode style, such as padding.
Note: This node requires the lineSpacing plugin to be enabled.
lineHeightstring
Text line height.
Did this help?