{
"metadata": {
"formats": {
"WEB_URL": {
"description": "A URL that starts with `http://` or `https://`.",
"validation": {
"type": "web_url"
}
},
"COLOR_HEX": {
"description": "A color in hexadecimal RGB or RGBA format, such as `#FF0000` or `#FF000050`. Accepts shorthands like #F00 and #F005",
"validation": {
"type": "regex",
"regex": "^#(?:[0-9A-Fa-f]{3,4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$"
}
},
"NODE_ID": {
"description": "A unique identifier for a node. It must start with a letter and can contain only letters, numbers, hyphens, and underscores.",
"validation": {
"type": "regex",
"regex": "^[-_\\w]*$"
}
}
}
},
"properties": {
"nodes": {
"metadata": {
"description": "An array of nodes representing content elements, such as `ParagraphNode`, `HeadingNode`, and so on."
},
"elements": {
"ref": "RootNode"
}
}
},
"optionalProperties": {
"metadata": {
"ref": "Metadata",
"metadata": {
"description": "Data about the Ricos document, such as version. This property is applicable only when using the ricos content editor and is auto-generated."
}
},
"documentStyle": {
"ref": "DocumentStyle",
"metadata": {
"description": "Defines styles for nodes. For example, you can define general styling for `headerOne`, and then override some of the properties separately for a specific header."
}
}
},
"definitions": {
"NodeStyle": {
"metadata": {
"features": [
"LINE_SPACING"
]
},
"optionalProperties": {
"paddingTop": {
"metadata": {
"description": "The top padding value in pixels."
},
"type": "string"
},
"paddingBottom": {
"metadata": {
"description": "The bottom padding value in pixels."
},
"type": "string"
},
"backgroundColor": {
"metadata": {
"deprecated": true
},
"type": "string"
}
}
},
"DocumentStyle": {
"metadata": {
"description": "This object sets a default styling for a type of node throughout the entire Ricos Document. For example, we can set the text color for all Heading 1 nodes.\nYou can override the styling of Text nodes separately using [Decorations](#decorations).",
"examples": [
"document-style"
],
"section": "Document Styles"
},
"optionalProperties": {
"headerOne": {
"metadata": {
"description": "Style for the H1 nodes."
},
"ref": "TextNodeStyle"
},
"headerTwo": {
"metadata": {
"description": "Style for the H2 nodes."
},
"ref": "TextNodeStyle"
},
"headerThree": {
"metadata": {
"description": "Style for the H3 nodes."
},
"ref": "TextNodeStyle"
},
"headerFour": {
"metadata": {
"description": "Style for the H4 nodes."
},
"ref": "TextNodeStyle"
},
"headerFive": {
"metadata": {
"description": "Style for the H5 nodes."
},
"ref": "TextNodeStyle"
},
"headerSix": {
"metadata": {
"description": "Style for the H6 nodes."
},
"ref": "TextNodeStyle"
},
"paragraph": {
"metadata": {
"description": "Style for the paragraph nodes."
},
"ref": "TextNodeStyle"
},
"blockquote": {
"metadata": {
"description": "Style for the block quote nodes."
},
"ref": "TextNodeStyle"
},
"codeBlock": {
"metadata": {
"description": "Style for the codeblock nodes."
},
"ref": "TextNodeStyle"
}
}
},
"TextNodeStyle": {
"metadata": {
"section": "Document Styles"
},
"optionalProperties": {
"decorations": {
"elements": {
"ref": "Decoration"
},
"metadata": {
"description": "Decorations for text nodes."
}
},
"nodeStyle": {
"ref": "NodeStyle",
"metadata": {
"description": "Node style, such as padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin."
}
},
"lineHeight": {
"type": "string",
"metadata": {
"description": "Text line height."
}
}
}
},
"Metadata": {
"metadata": {
"section": "Metadata"
},
"optionalProperties": {
"version": {
"type": "uint32",
"metadata": {
"description": "Ricos document version."
}
},
"id": {
"metadata": {
"deprecated": true
}
},
"createdTimestamp": {
"metadata": {
"deprecated": true
}
},
"updatedTimestamp": {
"metadata": {
"deprecated": true
}
}
}
},
"TextStyle": {
"optionalProperties": {
"textAlignment": {
"metadata": {
"emitEnum": "TextStyle_TextAlignment",
"description": "Text alignment. Possible 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`."
},
"enum": [
"AUTO",
"LEFT",
"RIGHT",
"CENTER",
"JUSTIFY"
]
},
"lineHeight": {
"metadata": {
"description": "Vertical spacing between lines of text in an element."
},
"type": "string"
}
},
"metadata": {
"section": "Common objects"
}
},
"Link": {
"metadata": {
"section": "Common objects",
"description": "Link object.",
"oneOf": {
"strict": true,
"properties": [
"url",
"anchor"
]
}
},
"optionalProperties": {
"url": {
"metadata": {
"description": "Absolute URL for the linked document."
},
"type": "string"
},
"anchor": {
"metadata": {
"description": "Target Node ID, where the user is redirected after clicking the anchor."
},
"type": "string"
},
"target": {
"metadata": {
"emitEnum": "Link_Target",
"description": "The HTML `target` attribute value for the link. This property defines where the linked document opens. Possible values:
`SELF` - Default. Opens the linked document in the same frame as the link.
`BLANK` - Opens the linked document in a new browser tab or window.
`PARENT` - Opens the linked document in the link's parent frame.
`TOP` - Opens the linked document in the full body of the link's browser tab or window."
},
"enum": [
"SELF",
"BLANK",
"PARENT",
"TOP"
]
},
"rel": {
"metadata": {
"description": "This object specifies the relationship between the current document and the linked document."
},
"ref": "Link_Rel"
},
"customData": {
"type": "string",
"metadata": {
"deprecated": true,
"internal": true,
"description": "A serialized object used for a custom or external link panel."
}
}
}
},
"Link_Rel": {
"optionalProperties": {
"nofollow": {
"metadata": {
"description": "Indicates to search engine crawlers not to follow the link. \n Default: `false`"
},
"type": "boolean"
},
"sponsored": {
"metadata": {
"description": "Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. \n Default: `false`"
},
"type": "boolean"
},
"ugc": {
"metadata": {
"description": "Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page author. \n Default: `false`"
},
"type": "boolean"
},
"noreferrer": {
"metadata": {
"description": "Indicates that this link protects referral information from being passed to the target website."
},
"type": "boolean"
}
},
"metadata": {
"section": "Common objects"
}
},
"FileSource": {
"metadata": {
"section": "Common objects",
"description": "File source object.",
"oneOf": {
"strict": true,
"properties": [
"url",
"id"
]
}
},
"optionalProperties": {
"url": {
"metadata": {
"description": "Absolute URL for the file's source."
},
"type": "string"
},
"id": {
"metadata": {
"description": "ID that's resolved to a URL by a resolver function."
},
"type": "string"
},
"private": {
"metadata": {
"description": "Indicates whether the file's source is private. \n Default: `false`"
},
"type": "boolean"
}
}
},
"Media": {
"properties": {
"src": {
"metadata": {
"description": "Media data source."
},
"ref": "FileSource"
}
},
"optionalProperties": {
"width": {
"metadata": {
"description": "Media width in pixels."
},
"type": "int32"
},
"height": {
"metadata": {
"description": "Media height in pixels."
},
"type": "int32"
},
"duration": {
"metadata": {
"description": "Media duration in seconds. Only relevant for audio and video files."
},
"type": "float64"
}
},
"metadata": {
"section": "Common objects"
}
},
"Never": {
"metadata": {
"section": "Common objects",
"internal": true
},
"properties": {
"_neverCreatedElement": {}
}
},
"PluginContainerData": {
"optionalProperties": {
"width": {
"metadata": {
"description": "Node width in a container when it's displayed. "
},
"ref": "PluginContainerData_Width"
},
"alignment": {
"metadata": {
"emitEnum": "PluginContainerData_Alignment",
"description": "Node alignment in its container. Possible values: \n - `CENTER` \n - `LEFT` \n - `RIGHT`"
},
"enum": [
"CENTER",
"LEFT",
"RIGHT"
]
},
"spoiler": {
"metadata": {
"description": "Spoiler cover settings.",
"features": [
"SPOILER"
]
},
"ref": "PluginContainerData_Spoiler"
},
"height": {
"metadata": {
"description": "Node height in a container when it's displayed."
},
"ref": "PluginContainerData_Height"
},
"textWrap": {
"metadata": {
"description": "Whether the text should wrap around the node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. \n Default: `true` for all node types except `DIVIDER`."
},
"type": "boolean"
}
},
"metadata": {
"section": "containerdata"
}
},
"PluginContainerData_Spoiler": {
"optionalProperties": {
"enabled": {
"metadata": {
"description": "Whether the spoiler cover is enabled. \n Default: `false`"
},
"type": "boolean"
},
"description": {
"metadata": {
"description": "Description displayed on top of the spoiler cover."
},
"type": "string"
},
"buttonText": {
"metadata": {
"description": "Text of a button that removes the spoiler cover."
},
"type": "string"
}
},
"metadata": {
"section": "containerdata"
}
},
"PluginContainerData_Width": {
"metadata": {
"section": "containerdata",
"description": "The width of the node when it's displayed.",
"oneOf": {
"properties": [
"size",
"custom"
]
}
},
"optionalProperties": {
"size": {
"metadata": {
"emitEnum": "PluginContainerData_Width_Type",
"description": "Width size of a node in a container. Possible values: \n - `CONTENT`: The width of the container matches the content width. \n - `SMALL`: A small width. \n - `ORIGINAL`: The width of the container matches the original image width. **Note:** This value is applicable for `imageData` containers only. \n `FULL_WIDTH`: The image container takes up the full width of the screen. **Note:** This value is applicable for `imageData` containers only."
},
"enum": [
"CONTENT",
"SMALL",
"ORIGINAL",
"FULL_WIDTH"
]
},
"custom": {
"metadata": {
"description": "A custom width value in pixels."
},
"type": "string"
}
}
},
"PluginContainerData_Height": {
"optionalProperties": {
"custom": {
"metadata": {
"description": "A custom height value in pixels."
},
"type": "string"
}
},
"metadata": {
"section": "containerdata"
}
},
"Decoration": {
"discriminator": "type",
"metadata": {
"section": "Decorations",
"refUnion": {
"BOLD": "BoldDecoration",
"ITALIC": "ItalicDecoration",
"UNDERLINE": "UnderlineDecoration",
"SPOILER": "SpoilerDecoration",
"ANCHOR": "AnchorDecoration",
"MENTION": "MentionDecoration",
"LINK": "LinkDecoration",
"COLOR": "ColorDecoration",
"FONT_SIZE": "FontSizeDecoration"
},
"emitEnum": "Decoration_Type"
},
"mapping": {
"BOLD": {
"metadata": {
"section": "Bold",
"examples": [
"bold"
],
"description": "Text that is styled to appear thicker and more prominent than normal text."
},
"properties": {},
"optionalProperties": {
"fontWeightValue": {
"type": "float32",
"metadata": {
"description": "Font weight. Values are from `100` to `900`."
}
}
}
},
"ITALIC": {
"metadata": {
"section": "Italic",
"examples": [
"italic"
],
"description": "Text that is styled to appear slanted or italicized, which is typically used for emphasis, citations, or to distinguish certain types of content."
},
"properties": {},
"optionalProperties": {
"italicData": {
"type": "boolean",
"metadata": {
"description": "Whether to enable the italic text."
}
}
}
},
"UNDERLINE": {
"metadata": {
"section": "Underline",
"examples": [
"underline"
],
"description": "Text that is styled with a line underneath it."
},
"properties": {},
"optionalProperties": {
"underlineData": {
"type": "boolean",
"metadata": {
"description": "Whether to enable the underlined text."
}
}
}
},
"SPOILER": {
"metadata": {
"section": "Spoiler",
"examples": [
"spoiler"
],
"features": [
"SPOILER"
],
"description": "Text that is styled to appear blurred.
**Note:** This decoration requires the [spoiler](#plugins) plugin."
},
"properties": {},
"optionalProperties": {
"spoilerData": {
"ref": "SpoilerData",
"metadata": {
"description": "Spoiler details."
}
}
}
},
"ANCHOR": {
"metadata": {
"section": "Anchor",
"examples": [
"anchor"
],
"description": "Clickable text in a hyperlink. Rendered in a different color, indicating that it is a link that users can click to navigate to section in the same page."
},
"properties": {},
"optionalProperties": {
"anchorData": {
"ref": "AnchorData",
"metadata": {
"description": "Anchor details."
}
}
}
},
"MENTION": {
"metadata": {
"section": "Mention",
"examples": [
"mention"
],
"features": [
"MENTION"
],
"description": "A piece of text that mentions a specific user, often in social media platforms, forums, or content management systems.
**Note:** This decoration requires the [mention](#plugins) plugin."
},
"properties": {},
"optionalProperties": {
"mentionData": {
"ref": "MentionData",
"metadata": {
"description": "Anchor details."
}
}
}
},
"LINK": {
"metadata": {
"section": "Link Decoration",
"examples": [
"link"
],
"features": [
"LINK"
],
"description": "Clickable text in a hyperlink. This text is what users see and click on to navigate to another web page or another resource.
**Note:** This decoration requires the [link](#plugins) plugin."
},
"properties": {},
"optionalProperties": {
"linkData": {
"ref": "LinkData",
"metadata": {
"description": "Link details."
}
}
}
},
"COLOR": {
"metadata": {
"section": "Color",
"examples": [
"color"
],
"features": [
"COLOR_DECORATION"
],
"description": "Text that is styled using background and text colors.
**Note:** This decoration requires the [colorDecoration](#plugins) plugin."
},
"properties": {},
"optionalProperties": {
"colorData": {
"ref": "ColorData",
"metadata": {
"description": "Color details."
}
}
}
},
"FONT_SIZE": {
"metadata": {
"section": "FontSize",
"examples": [
"font-size"
],
"description": "Text font size."
},
"properties": {},
"optionalProperties": {
"fontSizeData": {
"ref": "FontSizeData",
"metadata": {
"description": "Font size details."
}
}
}
}
}
},
"BoldDecoration": {
"metadata": {
"section": "Bold",
"examples": [
"bold"
],
"description": "Text that is styled to appear thicker and more prominent than normal text."
},
"properties": {
"type": {
"enum": [
"BOLD"
],
"metadata": {
"description": "Decoration type. \n Value: `BOLD`"
}
}
},
"optionalProperties": {
"fontWeightValue": {
"type": "float32",
"metadata": {
"description": "Font weight. Values are from `100` to `900`."
}
}
}
},
"ItalicDecoration": {
"metadata": {
"section": "Italic",
"examples": [
"italic"
],
"description": "Text that is styled to appear slanted or italicized, which is typically used for emphasis, citations, or to distinguish certain types of content."
},
"properties": {
"type": {
"enum": [
"ITALIC"
],
"metadata": {
"description": "Decoration type. \n Value: `ITALIC`"
}
}
},
"optionalProperties": {
"italicData": {
"type": "boolean",
"metadata": {
"description": "Whether to enable the italic text."
}
}
}
},
"UnderlineDecoration": {
"metadata": {
"section": "Underline",
"examples": [
"underline"
],
"description": "Text that is styled with a line underneath it."
},
"properties": {
"type": {
"enum": [
"UNDERLINE"
],
"metadata": {
"description": "Decoration type. \n Value: `UNDERLINE`"
}
}
},
"optionalProperties": {
"underlineData": {
"type": "boolean",
"metadata": {
"description": "Whether to enable the underlined text."
}
}
}
},
"SpoilerDecoration": {
"metadata": {
"section": "Spoiler",
"examples": [
"spoiler"
],
"features": [
"SPOILER"
],
"description": "Text that is styled to appear blurred.
**Note:** This decoration requires the [spoiler](#plugins) plugin."
},
"properties": {
"type": {
"enum": [
"SPOILER"
],
"metadata": {
"description": "Decoration type. \n Value: `SPOILER`"
}
}
},
"optionalProperties": {
"spoilerData": {
"ref": "SpoilerData",
"metadata": {
"description": "Spoiler details."
}
}
}
},
"AnchorDecoration": {
"metadata": {
"section": "Anchor",
"examples": [
"anchor"
],
"description": "Clickable text in a hyperlink. Rendered in a different color, indicating that it is a link that users can click to navigate to section in the same page."
},
"properties": {
"type": {
"enum": [
"ANCHOR"
],
"metadata": {
"description": "Decoration type. \n Value: `ANCHOR`"
}
}
},
"optionalProperties": {
"anchorData": {
"ref": "AnchorData",
"metadata": {
"description": "Anchor details."
}
}
}
},
"MentionDecoration": {
"metadata": {
"section": "Mention",
"examples": [
"mention"
],
"features": [
"MENTION"
],
"description": "A piece of text that mentions a specific user, often in social media platforms, forums, or content management systems.
**Note:** This decoration requires the [mention](#plugins) plugin."
},
"properties": {
"type": {
"enum": [
"MENTION"
],
"metadata": {
"description": "Decoration type. \n Value: `MENTION`"
}
}
},
"optionalProperties": {
"mentionData": {
"ref": "MentionData",
"metadata": {
"description": "Anchor details."
}
}
}
},
"LinkDecoration": {
"metadata": {
"section": "Link Decoration",
"examples": [
"link"
],
"features": [
"LINK"
],
"description": "Clickable text in a hyperlink. This text is what users see and click on to navigate to another web page or another resource.
**Note:** This decoration requires the [link](#plugins) plugin."
},
"properties": {
"type": {
"enum": [
"LINK"
],
"metadata": {
"description": "Decoration type. \n Value: `LINK`"
}
}
},
"optionalProperties": {
"linkData": {
"ref": "LinkData",
"metadata": {
"description": "Link details."
}
}
}
},
"ColorDecoration": {
"metadata": {
"section": "Color",
"examples": [
"color"
],
"features": [
"COLOR_DECORATION"
],
"description": "Text that is styled using background and text colors.
**Note:** This decoration requires the [colorDecoration](#plugins) plugin."
},
"properties": {
"type": {
"enum": [
"COLOR"
],
"metadata": {
"description": "Decoration type. \n Value: `COLOR`"
}
}
},
"optionalProperties": {
"colorData": {
"ref": "ColorData",
"metadata": {
"description": "Color details."
}
}
}
},
"FontSizeDecoration": {
"metadata": {
"section": "FontSize",
"examples": [
"font-size"
],
"description": "Text font size."
},
"properties": {
"type": {
"enum": [
"FONT_SIZE"
],
"metadata": {
"description": "Decoration type. \n Value: `FONT_SIZE`"
}
}
},
"optionalProperties": {
"fontSizeData": {
"ref": "FontSizeData",
"metadata": {
"description": "Font size details."
}
}
}
},
"AnchorData": {
"metadata": {
"section": "Anchor"
},
"optionalProperties": {
"anchor": {
"metadata": {
"description": "Target Node ID, where the user is redirected after clicking the anchor."
},
"type": "string"
}
}
},
"ColorData": {
"metadata": {
"section": "Color"
},
"optionalProperties": {
"background": {
"metadata": {
"description": "Background color in a hexadecimal value."
},
"type": "string"
},
"foreground": {
"metadata": {
"description": "Text color in a hexadecimal value."
},
"type": "string"
}
}
},
"LinkData": {
"metadata": {
"section": "Link Decoration"
},
"optionalProperties": {
"link": {
"ref": "Link",
"metadata": {
"description": "Link object."
}
}
}
},
"MentionData": {
"metadata": {
"section": "Mention"
},
"optionalProperties": {
"name": {
"type": "string",
"metadata": {
"description": "The display name of the mentioned user."
}
},
"slug": {
"type": "string",
"metadata": {
"description": "The username of the mentioned user, appearing after the \"@\" character."
}
},
"id": {
"type": "string",
"metadata": {
"description": "ID of the mentioned user."
}
}
}
},
"FontSizeData": {
"metadata": {
"section": "FontSize"
},
"optionalProperties": {
"unit": {
"metadata": {
"description": "Font size units. Possible values: \n - `PX`: Size in pixels. \n - `EM`: Relative to the font size of the element (2em means 2 times the size of the current font) ",
"emitEnum": "FontSizeData_fontType"
},
"enum": [
"PX",
"EM"
]
},
"value": {
"type": "float32",
"metadata": {
"description": "Font size value."
}
}
}
},
"SpoilerData": {
"metadata": {
"section": "Spoiler"
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
}
},
"BlockquoteNode": {
"metadata": {
"section": "Block quote",
"examples": [
"blockquote"
],
"description": "Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it is displayed as the quoted text with indentation or other styling to visually separate it from the surrounding content."
},
"properties": {
"type": {
"enum": [
"BLOCKQUOTE"
],
"metadata": {
"description": "Node type. \n Value: `BLOCKQUOTE`"
}
},
"nodes": {
"elements": {
"ref": "ParagraphNode"
},
"metadata": {
"description": "Child nodes to define a blockquote paragraph.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"blockquoteData": {
"ref": "BlockquoteData",
"metadata": {
"description": "Blockquote details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"BlockquoteData": {
"optionalProperties": {
"indentation": {
"type": "int32",
"metadata": {
"description": "Blockquote margin from the left side. Possible values are from `1` to `4`. \n The indentation is measured in relative to the font size *em* units, by the following formula: **indentation * 1.5**. For example, if indentation is `2`, then margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
}
}
},
"metadata": {
"section": "Block quote"
}
},
"CodeBlockNode": {
"metadata": {
"section": "Codeblock",
"features": [
"CODE_BLOCK"
],
"examples": [
"code-block-multi-line",
"code-block-syntax-highlighting"
],
"description": "Used to present programming 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."
},
"properties": {
"type": {
"enum": [
"CODE_BLOCK"
],
"metadata": {
"description": "Node type. \n Value: `CODE_BLOCK`"
}
}
},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define a code block text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"codeBlockData": {
"ref": "CodeBlockData",
"metadata": {
"description": "Code block details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"CodeBlockData": {
"optionalProperties": {
"textStyle": {
"ref": "TextStyle",
"metadata": {
"description": "Defines the text style, such as alignment and line height."
}
}
},
"metadata": {
"section": "Codeblock"
}
},
"HeadingNode": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {
"type": {
"enum": [
"HEADING"
],
"metadata": {
"description": "Node type. \n Value: `HEADING`"
}
}
},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"HeadingData": {
"optionalProperties": {
"level": {
"type": "int32",
"metadata": {
"description": "Heading size from `1` to `6`, where `1` is the highest level and `6` is the lowest."
}
},
"textStyle": {
"ref": "TextStyle",
"metadata": {
"description": "Defines the heading text style, such as text alignment and line height."
}
},
"indentation": {
"type": "int32",
"metadata": {
"description": "Heading margin from the left side. Possible values are from `1` to `4`. \n The indentation is measured in relative to the font size *em* units, by the following formula: **indentation * 1.5**. For example, if indentation is `2`, then margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
}
}
},
"metadata": {
"section": "Heading"
}
},
"OrderedListNode": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"type": {
"enum": [
"ORDERED_LIST"
],
"metadata": {
"description": "Node type. \n Value: `ORDERED_LIST`"
}
},
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"OrderedListData": {
"optionalProperties": {
"indentation": {
"type": "int32",
"metadata": {
"deprecated": true,
"description": "List margin from the left side. Possible values are from `1` to `4`. \n The indentation is measured in relative to the font size *em* units, by the following formula: **indentation * 1.5**. For example, if indentation is `2`, then margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
}
},
"offset": {
"type": "int32",
"metadata": {
"description": "An integer (ranging from 0 to 4) used to control the additional indentation level of an ordered or bulleted list node, beyond its original HTML-defined nesting. When offset is 0, the list node appears at its default nesting level; as the value increases from 1 to 4, the node is indented further, creating the visual impression of deeper nesting without altering the actual HTML structure."
}
},
"start": {
"type": "int32",
"metadata": {
"description": "An integer to start counting from for the list items, overriding the default start of 1."
}
}
},
"metadata": {
"section": "List"
}
},
"BulletedListNode": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"type": {
"enum": [
"BULLETED_LIST"
],
"metadata": {
"description": "Node type. \n Value: `BULLETED_LIST`"
}
},
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"BulletedListData": {
"optionalProperties": {
"indentation": {
"type": "int32",
"metadata": {
"deprecated": true
}
},
"offset": {
"type": "int32",
"metadata": {
"description": "An integer (ranging from 0 to 4) used to control the additional indentation level of an ordered or bulleted list node, beyond its original HTML-defined nesting. When `offset` is `0`, the list node appears at its default nesting level; as the value increases from 1 to 4, the node is indented further, creating the visual impression of deeper nesting without altering the actual HTML structure."
}
}
},
"metadata": {
"section": "List"
}
},
"ListItemNode": {
"properties": {
"type": {
"enum": [
"LIST_ITEM"
],
"metadata": {
"description": "Node type. \n Value: `LIST_ITEM`"
}
},
"nodes": {
"elements": {
"ref": "ListItemChildNode"
},
"metadata": {
"description": "Child nodes that the list item contains.",
"pattern": {
"description": "A list item must start with a paragraph or heading, followed by any number of paragraphs, bulleted lists, or ordered lists.",
"value": "(PARAGRAPH|HEADING|IMAGE|VIDEO|GIF|GALLERY) (PARAGRAPH|BULLETED_LIST|ORDERED_LIST|HEADING|IMAGE|VIDEO|GIF|GALLERY)*"
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
},
"metadata": {
"section": "List"
}
},
"ListItemChildNode": {
"discriminator": "type",
"metadata": {
"section": "List",
"refUnion": {
"PARAGRAPH": "ParagraphNode",
"HEADING": "HeadingNode",
"ORDERED_LIST": "OrderedListNode",
"BULLETED_LIST": "BulletedListNode",
"IMAGE": "ImageNode",
"VIDEO": "VideoNode",
"GIF": "GifNode",
"GALLERY": "GalleryNode"
}
},
"mapping": {
"PARAGRAPH": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"HEADING": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"ORDERED_LIST": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"BULLETED_LIST": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"IMAGE": {
"metadata": {
"section": "Image",
"examples": [
"image-id",
"image-url"
],
"features": [
"IMAGE"
],
"description": "Displays standalone pictures in a page."
},
"properties": {
"imageData": {
"ref": "ImageData",
"metadata": {
"description": "Image options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"VIDEO": {
"metadata": {
"section": "Video",
"examples": [
"video-url",
"video-wix"
],
"features": [
"VIDEO"
],
"description": "A multimedia node that is used to embed and play 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."
},
"properties": {
"videoData": {
"ref": "VideoData",
"metadata": {
"description": "Video details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GIF": {
"metadata": {
"section": "Gif",
"examples": [
"gif-basic"
],
"features": [
"GIF"
],
"description": "GIF images are made up of a series of frames, allowing them to display animations or short video clips without the need for additional plugins or technologies."
},
"properties": {
"gifData": {
"ref": "GIFData",
"metadata": {
"description": "GIF details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GALLERY": {
"metadata": {
"section": "Gallery",
"examples": [
"gallery"
],
"features": [
"GALLERY"
],
"description": "A collection of images displayed together in a visually appealing and organized manner."
},
"properties": {
"galleryData": {
"ref": "GalleryData",
"metadata": {
"description": "Gallery node details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
}
}
},
"ParagraphNode": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {
"type": {
"enum": [
"PARAGRAPH"
],
"metadata": {
"description": "Node type. \n Value: `PARAGRAPH`"
}
}
},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"ParagraphData": {
"optionalProperties": {
"textStyle": {
"ref": "TextStyle",
"metadata": {
"description": "Styling for the paragraph text."
}
},
"indentation": {
"type": "int32",
"metadata": {
"description": "Paragraph margin from the left side. Possible values are from `1` to `4`.
Actual indentation is equal to **indentation * 40px**."
}
},
"level": {
"type": "int32",
"metadata": {
"internal": true,
"description": "Paragraph level for future different paragraphs"
}
}
},
"metadata": {
"section": "Paragraph"
}
},
"TextNode": {
"metadata": {
"section": "TextNode",
"examples": [
"text"
],
"description": "Text nodes hold the text itself (think `span` tag in HTML). The difference between `TextNode` and HTML `span` is that text nodes can't be nested and must contain non-empty string. Their appearance and behavior can be modified using [decorations](#decorations)."
},
"properties": {
"type": {
"enum": [
"TEXT"
],
"metadata": {
"description": "Node type. \n Value: `TEXT`"
}
},
"textData": {
"ref": "TextData",
"metadata": {
"description": "Text options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"TextData": {
"properties": {
"text": {
"type": "string",
"metadata": {
"description": "A piece of text, possibly enhanced with additional decorations. Must not be empty.",
"validation": {
"minLength": 1
}
}
}
},
"optionalProperties": {
"decorations": {
"elements": {
"ref": "Decoration"
},
"metadata": {
"description": "Text decoration options, such as font and text color. Each type of decoration must appear at most once in this array.",
"validation": {
"uniqueTags": true
}
}
}
},
"metadata": {
"section": "TextNode"
}
},
"AppEmbedNode": {
"metadata": {
"section": "App Embed",
"examples": [
"app-embed-event",
"app-embed-booking"
],
"features": [
"APP_EMBED"
],
"description": "Similar to `LinkPreviewNode`, this node is used to embed external content preview, but from Wix business solutions. You can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
},
"properties": {
"type": {
"enum": [
"APP_EMBED"
],
"metadata": {
"description": "Node type. \n Value: `APP_EMBED`"
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"appEmbedData": {
"ref": "AppEmbedData",
"metadata": {
"description": "Embedded Wix app details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"AppEmbedData": {
"discriminator": "type",
"metadata": {
"section": "App Embed",
"refUnion": {
"PRODUCT": "AppEmbedDataProduct",
"EVENT": "AppEmbedDataEvent",
"BOOKING": "AppEmbedDataBooking"
},
"emitEnum": "AppEmbedData_AppType"
},
"mapping": {
"PRODUCT": {
"metadata": {
"section": "App Embed",
"description": "Wix Stores app. Embeds a particular product."
},
"properties": {
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
},
"EVENT": {
"metadata": {
"section": "App Embed",
"description": "Wix Events app. Embeds a particular event."
},
"properties": {
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
},
"eventData": {
"ref": "AppEmbedData_EventData",
"metadata": {
"description": "Embedded Wix Events app content."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
},
"BOOKING": {
"metadata": {
"section": "App Embed",
"description": "Wix Bookings app. Embeds a particular booking."
},
"properties": {
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"bookingData": {
"ref": "AppEmbedData_BookingData",
"metadata": {
"description": "Embedded Wix Bookings app content."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
}
}
},
"AppEmbedDataProduct": {
"metadata": {
"section": "App Embed",
"description": "Wix Stores app. Embeds a particular product."
},
"properties": {
"type": {
"enum": [
"PRODUCT"
],
"metadata": {
"description": "Which Wix App to embed. Possible values: \n - `PRODUCT`: Wix Stores app. Embeds a particular product. \n - `EVENT`: Wix Events app. Embeds a particular event. \n - `BOOKINGS`: Wix Bookings app. Embeds a particular booking."
}
},
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
},
"AppEmbedDataEvent": {
"metadata": {
"section": "App Embed",
"description": "Wix Events app. Embeds a particular event."
},
"properties": {
"type": {
"enum": [
"EVENT"
]
},
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
},
"eventData": {
"ref": "AppEmbedData_EventData",
"metadata": {
"description": "Embedded Wix Events app content."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
},
"AppEmbedDataBooking": {
"metadata": {
"section": "App Embed",
"description": "Wix Bookings app. Embeds a particular booking."
},
"properties": {
"type": {
"enum": [
"BOOKING"
]
},
"name": {
"type": "string",
"metadata": {
"description": "Embedded content name."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Embedded content thumbnail."
}
}
},
"optionalProperties": {
"itemId": {
"type": "string",
"metadata": {
"description": "Embedded content ID."
}
},
"url": {
"type": "string",
"metadata": {
"description": "Embedded content URL."
}
},
"bookingData": {
"ref": "AppEmbedData_BookingData",
"metadata": {
"description": "Embedded Wix Bookings app content."
}
},
"imageSrc": {
"type": "string",
"metadata": {
"description": "Deprecated: Use `image` instead.",
"deprecated": true
}
}
}
},
"AppEmbedData_BookingData": {
"optionalProperties": {
"durations": {
"type": "string",
"metadata": {
"description": "Booking duration in minutes."
}
}
},
"metadata": {
"section": "App Embed"
}
},
"AppEmbedData_EventData": {
"optionalProperties": {
"scheduling": {
"type": "string",
"metadata": {
"description": "Event schedule."
}
},
"location": {
"type": "string",
"metadata": {
"description": "Event location."
}
}
},
"metadata": {
"section": "App Embed"
}
},
"AudioNode": {
"metadata": {
"section": "Audio",
"examples": [
"audio-soundcloud"
],
"features": [
"AUDIO"
],
"description": "A multimedia node used to embed and play audio content directly in a webpage. When rendered, it is displayed as the audio player with the specified audio file (can be a platform such as Spotify or Soundloud, and Wix Media). Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
},
"properties": {
"type": {
"enum": [
"AUDIO"
],
"metadata": {
"description": "Node type. \n Value: `AUDIO`"
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"audioData": {
"ref": "AudioData",
"metadata": {
"description": "Audio details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"AudioData": {
"optionalProperties": {
"containerData": {
"metadata": {
"description": "Audio node container styling."
},
"ref": "PluginContainerData"
},
"audio": {
"metadata": {
"description": "Audio file details."
},
"ref": "Media"
},
"disableDownload": {
"metadata": {
"description": "Sets whether the audio download button is disabled. \n Default: `false`"
},
"type": "boolean"
},
"coverImage": {
"metadata": {
"description": "Cover image."
},
"ref": "Media"
},
"name": {
"metadata": {
"description": "Track name."
},
"type": "string"
},
"authorName": {
"metadata": {
"description": "Author name."
},
"type": "string"
},
"html": {
"metadata": {
"description": "An HTML version of the audio node."
},
"type": "string"
}
},
"metadata": {
"section": "Audio"
}
},
"ButtonNode": {
"metadata": {
"section": "Button",
"examples": [
"button-link",
"button-action",
"button-styled"
],
"features": [
"BUTTON"
],
"description": "A node that is used to trigger an action when clicked or activated."
},
"properties": {
"type": {
"enum": [
"BUTTON"
],
"metadata": {
"description": "Node type. \n Value: `BUTTON`"
}
},
"buttonData": {
"ref": "ButtonData",
"metadata": {
"description": "Button details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"ButtonData": {
"properties": {
"type": {
"enum": [
"LINK",
"ACTION"
],
"metadata": {
"emitEnum": "ButtonData_Type",
"description": "Button type. Possible values:
- `LINK`: When clicked, a user is redirected.
- `ACTION`: When clicked, performs an action."
}
},
"text": {
"type": "string",
"metadata": {
"description": "Button text."
}
}
},
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": " Button container styling."
}
},
"styles": {
"ref": "ButtonData_Styles",
"metadata": {
"description": "Button styling."
}
},
"link": {
"ref": "Link",
"metadata": {
"description": "Button link details."
}
}
},
"metadata": {
"section": "Button"
}
},
"ButtonData_Styles": {
"optionalProperties": {
"border": {
"ref": "ButtonData_Styles_Border",
"metadata": {
"description": "Border properties."
}
},
"colors": {
"ref": "ButtonData_Styles_Colors",
"metadata": {
"description": "Color properties."
}
}
},
"metadata": {
"section": "Button"
}
},
"ButtonData_Styles_Colors": {
"optionalProperties": {
"text": {
"type": "string",
"metadata": {
"description": "The text color in a hexadecimal value."
}
},
"border": {
"type": "string",
"metadata": {
"description": "The border color in a hexadecimal value."
}
},
"background": {
"type": "string",
"metadata": {
"description": "The background color in a hexadecimal value."
}
}
},
"metadata": {
"section": "Button"
}
},
"ButtonData_Styles_Border": {
"optionalProperties": {
"width": {
"type": "int32",
"metadata": {
"description": "Border width in pixels."
}
},
"radius": {
"type": "int32",
"metadata": {
"description": "Border radius in pixels."
}
}
},
"metadata": {
"section": "Button"
}
},
"CollapsibleListNode": {
"metadata": {
"section": "Collapsible List",
"examples": [
"collapsible-list"
],
"features": [
"COLLAPSIBLE_LIST"
],
"description": "A list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it."
},
"properties": {
"type": {
"enum": [
"COLLAPSIBLE_LIST"
],
"metadata": {
"description": "Node type. \n Value: `COLLAPSIBLE_LIST`"
}
},
"nodes": {
"elements": {
"ref": "CollapsibleItemNode"
},
"metadata": {
"description": "Collapsible list child nodes.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"collapsibleListData": {
"ref": "CollapsibleListData",
"metadata": {
"description": "Collapsible list details."
}
}
}
},
"CollapsibleListData": {
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Collapsible list container styling."
}
},
"expandOnlyOne": {
"type": "boolean",
"metadata": {
"description": "Whether only one item can be expanded at a time. \n Default: `false` "
}
},
"initialExpandedItems": {
"enum": [
"FIRST",
"ALL",
"NONE"
],
"metadata": {
"metadata": {
"emitEnum": "CollapsibleListData_InitialExpandedItems"
},
"description": "Sets which items are automatically expanded after the page loads. Possible values: \n - `FIRST` \n - `ALL` \n - `NONE`"
}
},
"direction": {
"enum": [
"LTR",
"RTL"
],
"metadata": {
"emitEnum": "CollapsibleListData_Direction",
"description": "Direction of the text in the list. Possible values: \n - `LTR`: Left to right. \n - `RTL`: Right to left."
}
},
"isQapageData": {
"type": "boolean",
"metadata": {
"description": "Whether the collapsible item will appear in search results as a FAQ."
}
}
},
"metadata": {
"section": "Collapsible List"
}
},
"CollapsibleItemNode": {
"properties": {
"type": {
"enum": [
"COLLAPSIBLE_ITEM"
],
"metadata": {
"description": "Node type. \n Value: `COLLAPSIBLE_ITEM`"
}
},
"nodes": {
"elements": {
"ref": "CollapsibleItemChildNode"
},
"metadata": {
"description": "Collapsible list item.",
"pattern": {
"value": "COLLAPSIBLE_ITEM_TITLE COLLAPSIBLE_ITEM_BODY",
"description": "Must contain title as the first item and body as the second."
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
},
"metadata": {
"section": "Collapsible List"
}
},
"CollapsibleItemChildNode": {
"discriminator": "type",
"metadata": {
"section": "Collapsible List",
"refUnion": {
"COLLAPSIBLE_ITEM_TITLE": "CollapsibleItemTitleNode",
"COLLAPSIBLE_ITEM_BODY": "CollapsibleItemBodyNode"
}
},
"mapping": {
"COLLAPSIBLE_ITEM_TITLE": {
"metadata": {
"section": "Collapsible List",
"description": "Collapsible list item title node."
},
"properties": {
"nodes": {
"elements": {
"ref": "CollapsibleTitleChildNode"
},
"metadata": {
"description": "Collapsible list item title child nodes.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
}
},
"COLLAPSIBLE_ITEM_BODY": {
"metadata": {
"section": "Collapsible List",
"description": "Collapsible list item body node."
},
"properties": {
"nodes": {
"elements": {
"ref": "CollapsibleItemBodyChildNode"
},
"metadata": {
"description": "Collapsible list item body child nodes.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
}
}
}
},
"CollapsibleItemTitleNode": {
"metadata": {
"section": "Collapsible List",
"description": "Collapsible list item title node."
},
"properties": {
"type": {
"enum": [
"COLLAPSIBLE_ITEM_TITLE"
],
"metadata": {
"description": "Node type. \n Value: `COLLAPSIBLE_ITEM_TITLE`"
}
},
"nodes": {
"elements": {
"ref": "CollapsibleTitleChildNode"
},
"metadata": {
"description": "Collapsible list item title child nodes.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
}
},
"CollapsibleTitleChildNode": {
"discriminator": "type",
"metadata": {
"section": "Collapsible List",
"refUnion": {
"PARAGRAPH": "ParagraphNode",
"HEADING": "HeadingNode",
"BULLETED_LIST": "BulletedListNode",
"ORDERED_LIST": "OrderedListNode",
"BLOCKQUOTE": "BlockquoteNode",
"CODE_BLOCK": "CodeBlockNode"
}
},
"mapping": {
"PARAGRAPH": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"HEADING": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"BULLETED_LIST": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"ORDERED_LIST": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"BLOCKQUOTE": {
"metadata": {
"section": "Block quote",
"examples": [
"blockquote"
],
"description": "Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it is displayed as the quoted text with indentation or other styling to visually separate it from the surrounding content."
},
"properties": {
"nodes": {
"elements": {
"ref": "ParagraphNode"
},
"metadata": {
"description": "Child nodes to define a blockquote paragraph.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"blockquoteData": {
"ref": "BlockquoteData",
"metadata": {
"description": "Blockquote details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"CODE_BLOCK": {
"metadata": {
"section": "Codeblock",
"features": [
"CODE_BLOCK"
],
"examples": [
"code-block-multi-line",
"code-block-syntax-highlighting"
],
"description": "Used to present programming 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."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define a code block text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"codeBlockData": {
"ref": "CodeBlockData",
"metadata": {
"description": "Code block details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
}
}
},
"CollapsibleItemBodyNode": {
"metadata": {
"section": "Collapsible List",
"description": "Collapsible list item body node."
},
"properties": {
"type": {
"enum": [
"COLLAPSIBLE_ITEM_BODY"
],
"metadata": {
"description": "Node type. \n Value: `COLLAPSIBLE_ITEM_BODY`"
}
},
"nodes": {
"elements": {
"ref": "CollapsibleItemBodyChildNode"
},
"metadata": {
"description": "Collapsible list item body child nodes.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
}
},
"CollapsibleItemBodyChildNode": {
"discriminator": "type",
"metadata": {
"section": "Collapsible List",
"refUnion": {
"PARAGRAPH": "ParagraphNode",
"HEADING": "HeadingNode",
"BULLETED_LIST": "BulletedListNode",
"ORDERED_LIST": "OrderedListNode",
"BLOCKQUOTE": "BlockquoteNode",
"AUDIO": "AudioNode",
"FILE": "FileNode",
"IMAGE": "ImageNode",
"VIDEO": "VideoNode",
"GIF": "GifNode",
"DIVIDER": "DividerNode",
"CODE_BLOCK": "CodeBlockNode",
"APP_EMBED": "AppEmbedNode",
"LINK_PREVIEW": "LinkPreviewNode",
"GALLERY": "GalleryNode",
"BUTTON": "ButtonNode",
"COLLAPSIBLE_LIST": "CollapsibleListNode",
"TABLE": "TableNode",
"EMBED": "EmbedNode",
"POLL": "PollNode",
"HTML": "HtmlNode"
},
"description": "Collapsible list item body node."
},
"mapping": {
"PARAGRAPH": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"HEADING": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"BULLETED_LIST": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"ORDERED_LIST": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"BLOCKQUOTE": {
"metadata": {
"section": "Block quote",
"examples": [
"blockquote"
],
"description": "Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it is displayed as the quoted text with indentation or other styling to visually separate it from the surrounding content."
},
"properties": {
"nodes": {
"elements": {
"ref": "ParagraphNode"
},
"metadata": {
"description": "Child nodes to define a blockquote paragraph.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"blockquoteData": {
"ref": "BlockquoteData",
"metadata": {
"description": "Blockquote details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"AUDIO": {
"metadata": {
"section": "Audio",
"examples": [
"audio-soundcloud"
],
"features": [
"AUDIO"
],
"description": "A multimedia node used to embed and play audio content directly in a webpage. When rendered, it is displayed as the audio player with the specified audio file (can be a platform such as Spotify or Soundloud, and Wix Media). Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"audioData": {
"ref": "AudioData",
"metadata": {
"description": "Audio details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"FILE": {
"metadata": {
"section": "File",
"examples": [
"file"
],
"features": [
"FILE"
],
"description": "A digital file stored on a computer that is uploaded and accessed in a page. Files can include various types of content, such as text documents, images, videos, and so on."
},
"properties": {
"fileData": {
"ref": "FileData",
"metadata": {
"description": "File details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"IMAGE": {
"metadata": {
"section": "Image",
"examples": [
"image-id",
"image-url"
],
"features": [
"IMAGE"
],
"description": "Displays standalone pictures in a page."
},
"properties": {
"imageData": {
"ref": "ImageData",
"metadata": {
"description": "Image options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"VIDEO": {
"metadata": {
"section": "Video",
"examples": [
"video-url",
"video-wix"
],
"features": [
"VIDEO"
],
"description": "A multimedia node that is used to embed and play 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."
},
"properties": {
"videoData": {
"ref": "VideoData",
"metadata": {
"description": "Video details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GIF": {
"metadata": {
"section": "Gif",
"examples": [
"gif-basic"
],
"features": [
"GIF"
],
"description": "GIF images are made up of a series of frames, allowing them to display animations or short video clips without the need for additional plugins or technologies."
},
"properties": {
"gifData": {
"ref": "GIFData",
"metadata": {
"description": "GIF details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"DIVIDER": {
"metadata": {
"section": "Divider",
"examples": [
"divider"
],
"features": [
"DIVIDER"
],
"description": "A visual node that is used to separate content sections in a page. When rendered, it is displayed as a horizontal line between the paragraphs, acting as a divider between them."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"dividerData": {
"ref": "DividerData",
"metadata": {
"description": "Divider details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"CODE_BLOCK": {
"metadata": {
"section": "Codeblock",
"features": [
"CODE_BLOCK"
],
"examples": [
"code-block-multi-line",
"code-block-syntax-highlighting"
],
"description": "Used to present programming 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."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define a code block text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"codeBlockData": {
"ref": "CodeBlockData",
"metadata": {
"description": "Code block details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"APP_EMBED": {
"metadata": {
"section": "App Embed",
"examples": [
"app-embed-event",
"app-embed-booking"
],
"features": [
"APP_EMBED"
],
"description": "Similar to `LinkPreviewNode`, this node is used to embed external content preview, but from Wix business solutions. You can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"appEmbedData": {
"ref": "AppEmbedData",
"metadata": {
"description": "Embedded Wix app details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"LINK_PREVIEW": {
"metadata": {
"section": "Link Preview",
"examples": [
"link-preview"
],
"features": [
"LINK_PREVIEW"
],
"description": "A 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 possibly a thumbnail image or other relevant information."
},
"properties": {
"linkPreviewData": {
"ref": "LinkPreviewData",
"metadata": {
"description": "Link preview details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GALLERY": {
"metadata": {
"section": "Gallery",
"examples": [
"gallery"
],
"features": [
"GALLERY"
],
"description": "A collection of images displayed together in a visually appealing and organized manner."
},
"properties": {
"galleryData": {
"ref": "GalleryData",
"metadata": {
"description": "Gallery node details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"BUTTON": {
"metadata": {
"section": "Button",
"examples": [
"button-link",
"button-action",
"button-styled"
],
"features": [
"BUTTON"
],
"description": "A node that is used to trigger an action when clicked or activated."
},
"properties": {
"buttonData": {
"ref": "ButtonData",
"metadata": {
"description": "Button details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"COLLAPSIBLE_LIST": {
"metadata": {
"section": "Collapsible List",
"examples": [
"collapsible-list"
],
"features": [
"COLLAPSIBLE_LIST"
],
"description": "A list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it."
},
"properties": {
"nodes": {
"elements": {
"ref": "CollapsibleItemNode"
},
"metadata": {
"description": "Collapsible list child nodes.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"collapsibleListData": {
"ref": "CollapsibleListData",
"metadata": {
"description": "Collapsible list details."
}
}
}
},
"TABLE": {
"metadata": {
"section": "Table",
"examples": [
"table"
],
"features": [
"TABLE"
],
"description": "A structural node used to display data in rows and columns."
},
"properties": {
"nodes": {
"elements": {
"ref": "TableRowNode"
},
"metadata": {
"description": "Child nodes to define table rows.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"tableData": {
"ref": "TableData",
"metadata": {
"description": "Table details."
}
}
}
},
"EMBED": {
"metadata": {
"section": "Embed",
"examples": [
"embed"
],
"features": [
"EMBED"
],
"description": "Similar to `HtmlNode`, this node is used to display embedded content when you post a link to that resource, without having to parse the resource directly. It provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers without needing to handle the complex embedding code themselves. For more information, read [oembed](https://oembed.com/)."
},
"properties": {
"embedData": {
"ref": "EmbedData",
"metadata": {
"description": "oEmbed details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"POLL": {
"metadata": {
"section": "Poll",
"examples": [
"poll"
],
"features": [
"POLL"
],
"description": "A node that allows users to vote or express their opinions on a particular question, topic, or issue."
},
"properties": {
"pollData": {
"ref": "PollData",
"metadata": {
"description": "Poll details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"HTML": {
"metadata": {
"section": "Html",
"examples": [
"html-code",
"html-url"
],
"features": [
"HTML"
],
"description": "Incorporates external content, such as interactive maps, or entire web pages."
},
"properties": {
"htmlData": {
"ref": "HTMLData",
"metadata": {
"description": "HTML details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
}
}
},
"DividerNode": {
"metadata": {
"section": "Divider",
"examples": [
"divider"
],
"features": [
"DIVIDER"
],
"description": "A visual node that is used to separate content sections in a page. When rendered, it is displayed as a horizontal line between the paragraphs, acting as a divider between them."
},
"properties": {
"type": {
"enum": [
"DIVIDER"
],
"metadata": {
"description": "Node type. \n Value: `DIVIDER`"
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"dividerData": {
"ref": "DividerData",
"metadata": {
"description": "Divider details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"DividerData": {
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Divider container styling."
}
},
"lineStyle": {
"enum": [
"SINGLE",
"DOUBLE",
"DASHED",
"DOTTED"
],
"metadata": {
"emitEnum": "DividerData_LineStyle",
"description": "Divider line style. Possible values:
- `SINGLE`
- `DOUBLE`
- `DASHED`
- `DOTTED`"
}
},
"width": {
"enum": [
"LARGE",
"MEDIUM",
"SMALL"
],
"metadata": {
"emitEnum": "DividerData_Width",
"description": "Divider width. Possible values:
- `LARGE`
- `MEDIUM`
- `SMALL`"
}
},
"alignment": {
"enum": [
"CENTER",
"LEFT",
"RIGHT"
],
"metadata": {
"emitEnum": "DividerData_Alignment",
"description": "Divider alignment. Possible values:
- `CENTER`
- `LEFT`
- `RIGHT`"
}
}
},
"metadata": {
"section": "Divider"
}
},
"EmbedNode": {
"metadata": {
"section": "Embed",
"examples": [
"embed"
],
"features": [
"EMBED"
],
"description": "Similar to `HtmlNode`, this node is used to display embedded content when you post a link to that resource, without having to parse the resource directly. It provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers without needing to handle the complex embedding code themselves. For more information, read [oembed](https://oembed.com/)."
},
"properties": {
"type": {
"enum": [
"EMBED"
],
"metadata": {
"description": "Node type. \n Value: `EMBED`"
}
},
"embedData": {
"ref": "EmbedData",
"metadata": {
"description": "oEmbed details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"EmbedData": {
"optionalProperties": {
"containerData": {
"metadata": {
"description": "oEmbed node container styling."
},
"ref": "PluginContainerData"
},
"oembed": {
"metadata": {
"description": "[oEmbed](https://www.oembed.com) details."
},
"ref": "Oembed"
},
"src": {
"metadata": {
"description": "Original asset source."
},
"type": "string"
}
},
"metadata": {
"section": "Embed"
}
},
"Oembed": {
"optionalProperties": {
"type": {
"metadata": {
"description": "Resource type. For more information read the [oEmbed](https://www.oembed.com) official website."
},
"type": "string"
},
"width": {
"metadata": {
"description": "Width of the resource specified in the `url` field in pixels."
},
"type": "int32"
},
"height": {
"metadata": {
"description": "Height of the resource specified in the `url` field in pixels."
},
"type": "int32"
},
"title": {
"metadata": {
"description": "A text title, describing the resource."
},
"type": "string"
},
"url": {
"metadata": {
"description": "The source URL for the resource."
},
"type": "string"
},
"html": {
"metadata": {
"description": "HTML required to embed a video player. The HTML should have no padding or margins."
},
"type": "string"
},
"authorName": {
"metadata": {
"description": "Name of the author or owner of the resource."
},
"type": "string"
},
"authorUrl": {
"metadata": {
"description": "URL for the author or owner of the resource."
},
"type": "string"
},
"providerName": {
"metadata": {
"description": "Name of the resource provider."
},
"type": "string"
},
"providerUrl": {
"metadata": {
"description": "URL for the resource provider."
},
"type": "string"
},
"thumbnailUrl": {
"metadata": {
"description": "URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined."
},
"type": "string"
},
"thumbnailWidth": {
"metadata": {
"description": "Width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined."
},
"type": "string"
},
"thumbnailHeight": {
"metadata": {
"description": "Height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined."
},
"type": "string"
},
"videoUrl": {
"metadata": {
"description": "URL for an embedded video."
},
"type": "string"
},
"version": {
"metadata": {
"description": "The oEmbed version number. This value must be `1.0`."
},
"type": "string"
}
},
"metadata": {
"section": "Embed"
}
},
"FileNode": {
"metadata": {
"section": "File",
"examples": [
"file"
],
"features": [
"FILE"
],
"description": "A digital file stored on a computer that is uploaded and accessed in a page. Files can include various types of content, such as text documents, images, videos, and so on."
},
"properties": {
"type": {
"enum": [
"FILE"
],
"metadata": {
"description": "Node type. \n Value: `FILE`"
}
},
"fileData": {
"ref": "FileData",
"metadata": {
"description": "File details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"FileData": {
"optionalProperties": {
"containerData": {
"metadata": {
"description": "File container styling."
},
"ref": "PluginContainerData"
},
"src": {
"metadata": {
"description": "File data source."
},
"ref": "FileSource"
},
"name": {
"metadata": {
"description": "File name."
},
"type": "string"
},
"type": {
"metadata": {
"description": "File type."
},
"type": "string"
},
"size": {
"metadata": {
"description": "Deprecated. Replaced by sizeInKb",
"deprecated": true
},
"type": "uint32"
},
"sizeInKb": {
"metadata": {
"description": "File size in KB."
},
"type": "string"
},
"pdfSettings": {
"metadata": {
"description": "Settings for PDF files."
},
"ref": "FileData_PDFSettings"
},
"mimeType": {
"metadata": {
"description": "File MIME type."
},
"type": "string"
},
"path": {
"metadata": {
"description": "File path."
},
"type": "string"
}
},
"metadata": {
"section": "File"
}
},
"FileData_PDFSettings": {
"optionalProperties": {
"viewMode": {
"metadata": {
"emitEnum": "FileData_PDFSettings_ViewMode",
"description": "PDF view mode. Possible values: \n - `NONE`: The PDF isn't displayed. \n - `FULL`: A full PDF page view is displayed. \n - `MINI`: A mini view of the PDF is displayed."
},
"enum": [
"NONE",
"FULL",
"MINI"
]
},
"disableDownload": {
"metadata": {
"description": "Whether the PDF download button is disabled. \n Default: `false`"
},
"type": "boolean"
},
"disablePrint": {
"metadata": {
"description": "Whether the PDF print button is disabled. \n Default: `false`"
},
"type": "boolean"
}
},
"metadata": {
"section": "File"
}
},
"GalleryNode": {
"metadata": {
"section": "Gallery",
"examples": [
"gallery"
],
"features": [
"GALLERY"
],
"description": "A collection of images displayed together in a visually appealing and organized manner."
},
"properties": {
"type": {
"enum": [
"GALLERY"
],
"metadata": {
"description": "Node type. \n Value: `GALLERY`"
}
},
"galleryData": {
"ref": "GalleryData",
"metadata": {
"description": "Gallery node details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GalleryData": {
"properties": {
"items": {
"elements": {
"ref": "GalleryData_Item"
},
"metadata": {
"description": "Gallery items details.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Gallery container styling."
}
},
"options": {
"ref": "GalleryOptions",
"metadata": {
"description": "Gallery appearance options."
}
},
"disableExpand": {
"type": "boolean",
"metadata": {
"description": "Whether the expand button is disabled. Default: `false`"
}
},
"disableDownload": {
"type": "boolean",
"metadata": {
"description": "Whether the download button is disabled. Default: `false`"
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryOptions": {
"optionalProperties": {
"layout": {
"ref": "GalleryOptions_Layout",
"metadata": {
"description": "Gallery layout."
}
},
"item": {
"ref": "GalleryOptions_ItemStyle",
"metadata": {
"description": "Styling for gallery items."
}
},
"thumbnails": {
"ref": "GalleryOptions_Thumbnails",
"metadata": {
"description": "Styling for gallery thumbnail images."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryOptions_Layout": {
"optionalProperties": {
"type": {
"metadata": {
"emitEnum": "GalleryOptions_Layout_Type",
"description": "Gallery layout type. Possible values:
- `COLLAGE`: Presents images in various sizes and positions, creating an artistic or dynamic layout.
- `MASONRY`: A 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 clean, uniform, and visually appealing arrangement of images.
- `THUMBNAIL`: A smaller, scaled-down version of an image that serves as a preview.
- `SLIDER`: A 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, taking up the entire viewport or a significant portion of the screen.."
},
"enum": [
"COLLAGE",
"MASONRY",
"GRID",
"THUMBNAIL",
"SLIDER",
"SLIDESHOW",
"PANORAMA",
"COLUMN",
"MAGIC",
"FULLSIZE"
]
},
"horizontalScroll": {
"type": "boolean",
"metadata": {
"description": "Whether the horizontal scroll is enabled. Default: `true`, unless the `type` field is set to `GRID` or `COLLAGE`."
}
},
"orientation": {
"metadata": {
"description": "Gallery orientation. Possible values:
- `ROWS`: Gallery items are arranged horizontally in rows.
- `COLUMNS`: Gallery items are arranged vertically in columns.",
"emitEnum": "GalleryOptions_Layout_Orientation"
},
"enum": [
"ROWS",
"COLUMNS"
]
},
"numberOfColumns": {
"type": "int32",
"metadata": {
"description": "The number of columns to display on computer screens."
}
},
"mobileNumberOfColumns": {
"type": "int32",
"metadata": {
"description": "The number of columns to display on mobile phone screens."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryOptions_ItemStyle": {
"optionalProperties": {
"targetSize": {
"type": "int32",
"metadata": {
"description": "Dimension for each gallery item in pixels (behavaior changes according to a gallery type)."
}
},
"ratio": {
"type": "float64",
"metadata": {
"description": "Item ratio"
}
},
"crop": {
"metadata": {
"description": "Sets how gallery item images are cropped. Possible values:
- `FILL`: Each item in the gallery is cropped and resized to completely fill its container, ensuring that no empty space is left while maintaining the aspect ratio of the original image.
- `FIT`: Each item in the gallery is resized to fit entirely in its container without any cropping.",
"emitEnum": "GalleryOptions_ItemStyle_Crop"
},
"enum": [
"FILL",
"FIT"
]
},
"spacing": {
"type": "int32",
"metadata": {
"description": "The spacing between gallery items in pixels."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryOptions_Thumbnails": {
"optionalProperties": {
"placement": {
"metadata": {
"emitEnum": "GalleryOptions_Thumbnails_Alignment",
"description": "Thumbnail alignment. Possible values:
- `TOP`
- `RIGHT`
- `BOTTOM`
- `LEFT`
- `NONE`"
},
"enum": [
"TOP",
"RIGHT",
"BOTTOM",
"LEFT",
"NONE"
]
},
"spacing": {
"type": "int32",
"metadata": {
"description": "Spacing between thumbnails in pixels."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryData_Item": {
"metadata": {
"section": "Gallery",
"oneOf": {
"strict": true,
"properties": [
"image",
"video"
]
}
},
"optionalProperties": {
"title": {
"type": "string",
"metadata": {
"description": "Item title."
}
},
"altText": {
"type": "string",
"metadata": {
"description": "Item's alternative text."
}
},
"image": {
"ref": "GalleryData_Item_Image",
"metadata": {
"description": "Image item."
}
},
"video": {
"ref": "GalleryData_Item_Video",
"metadata": {
"description": "Video item."
}
}
}
},
"GalleryData_Item_Video": {
"properties": {
"media": {
"ref": "Media",
"metadata": {
"description": "Video file details."
}
}
},
"optionalProperties": {
"thumbnail": {
"ref": "Media",
"metadata": {
"description": "Video thumbnail file details."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GalleryData_Item_Image": {
"properties": {
"media": {
"ref": "Media",
"metadata": {
"description": "Image file details."
}
}
},
"optionalProperties": {
"link": {
"ref": "Link",
"metadata": {
"description": "Link details for images that are links."
}
}
},
"metadata": {
"section": "Gallery"
}
},
"GifNode": {
"metadata": {
"section": "Gif",
"examples": [
"gif-basic"
],
"features": [
"GIF"
],
"description": "GIF images are made up of a series of frames, allowing them to display animations or short video clips without the need for additional plugins or technologies."
},
"properties": {
"type": {
"enum": [
"GIF"
],
"metadata": {
"description": "Node type. \n Value: `GIF`"
}
},
"gifData": {
"ref": "GIFData",
"metadata": {
"description": "GIF details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GIFData": {
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Styling for the GIF container, such as dimensions and alignment."
}
},
"original": {
"metadata": {
"description": "Source for the full size GIF."
},
"ref": "GIF"
},
"downsized": {
"metadata": {
"description": "Source for the downsized GIF."
},
"ref": "GIF"
},
"height": {
"type": "int32",
"metadata": {
"description": "Height in pixels."
}
},
"width": {
"type": "int32",
"metadata": {
"description": "Width in pixels."
}
}
},
"metadata": {
"section": "Gif"
}
},
"GIF": {
"optionalProperties": {
"gif": {
"type": "string",
"metadata": {
"format": "WEB_URL",
"description": "URL for a file in GIF format."
}
},
"mp4": {
"type": "string",
"metadata": {
"format": "WEB_URL",
"description": "URL for a file in MP4 format."
}
},
"still": {
"type": "string",
"metadata": {
"format": "WEB_URL",
"description": "GIF thumbnail URL."
}
}
},
"metadata": {
"section": "Gif"
}
},
"HtmlNode": {
"metadata": {
"section": "Html",
"examples": [
"html-code",
"html-url"
],
"features": [
"HTML"
],
"description": "Incorporates external content, such as interactive maps, or entire web pages."
},
"properties": {
"type": {
"enum": [
"HTML"
],
"metadata": {
"description": "Node type. \n Value: `HTML`"
}
},
"htmlData": {
"ref": "HTMLData",
"metadata": {
"description": "HTML details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"HTMLData": {
"metadata": {
"section": "Html",
"oneOf": {
"properties": [
"url",
"html"
]
}
},
"optionalProperties": {
"containerData": {
"metadata": {
"description": "HTML node container styling."
},
"ref": "PluginContainerData"
},
"source": {
"metadata": {
"description": "HTML code type. Possible values: \n - `HTML`: HTML code. \n - [`ADSENSE`](https://adsense.google.com/start/): A service provided by Google for serving advertisements on web pages.",
"emitEnum": "HTMLData_Source"
},
"enum": [
"HTML",
"ADSENSE"
]
},
"url": {
"metadata": {
"description": "HTML code URL."
},
"type": "string"
},
"html": {
"metadata": {
"description": "HTML code."
},
"type": "string"
}
}
},
"ImageNode": {
"metadata": {
"section": "Image",
"examples": [
"image-id",
"image-url"
],
"features": [
"IMAGE"
],
"description": "Displays standalone pictures in a page."
},
"properties": {
"type": {
"enum": [
"IMAGE"
],
"metadata": {
"description": "Node type. \n Value: `IMAGE`"
}
},
"imageData": {
"ref": "ImageData",
"metadata": {
"description": "Image options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"ImageData": {
"properties": {
"image": {
"ref": "Media",
"metadata": {
"description": "Image file details, such as source and dimensions."
}
}
},
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Styling for the image container, such as dimensions and alignment."
}
},
"link": {
"ref": "Link",
"metadata": {
"description": "Link details, such as URL, or anchor, if image is also used as a link."
}
},
"disableExpand": {
"type": "boolean",
"metadata": {
"description": "Whether the image expands to the full screen when clicked. \n Default: `false`"
}
},
"altText": {
"type": "string",
"metadata": {
"description": "An alternate text for an image. Used for improved accessibility and shown when the image can't be displayed."
}
},
"caption": {
"type": "string",
"metadata": {
"description": "Image title."
}
},
"disableDownload": {
"type": "boolean",
"metadata": {
"description": "Whether the download image button is disabled. \n Default: `false`"
}
}
},
"metadata": {
"section": "Image"
}
},
"LinkPreviewNode": {
"metadata": {
"section": "Link Preview",
"examples": [
"link-preview"
],
"features": [
"LINK_PREVIEW"
],
"description": "A 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 possibly a thumbnail image or other relevant information."
},
"properties": {
"type": {
"enum": [
"LINK_PREVIEW"
],
"metadata": {
"description": "Node type. \n Value: `LINK_PREVIEW`"
}
},
"linkPreviewData": {
"ref": "LinkPreviewData",
"metadata": {
"description": "Link preview details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"LinkPreviewData": {
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Link preview container styling."
}
},
"link": {
"ref": "Link",
"metadata": {
"description": "Link details."
}
},
"title": {
"type": "string",
"metadata": {
"description": "Preview title."
}
},
"thumbnailUrl": {
"type": "string",
"metadata": {
"description": "Preview thumbnail URL."
}
},
"description": {
"type": "string",
"metadata": {
"description": "Preview description."
}
},
"html": {
"type": "string",
"metadata": {
"description": "Preview content as HTML."
}
}
},
"metadata": {
"section": "Link Preview"
}
},
"PollNode": {
"metadata": {
"section": "Poll",
"examples": [
"poll"
],
"features": [
"POLL"
],
"description": "A node that allows users to vote or express their opinions on a particular question, topic, or issue."
},
"properties": {
"type": {
"enum": [
"POLL"
],
"metadata": {
"description": "Node type. \n Value: `POLL`"
}
},
"pollData": {
"ref": "PollData",
"metadata": {
"description": "Poll details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"PollData": {
"optionalProperties": {
"containerData": {
"ref": "PluginContainerData",
"metadata": {
"description": "Poll container styling."
}
},
"poll": {
"ref": "PollData_Poll",
"metadata": {
"description": "Poll data."
}
},
"layout": {
"ref": "PollData_Layout",
"metadata": {
"description": "Poll layout settings."
}
},
"design": {
"ref": "PollData_Design",
"metadata": {
"description": "Poll design."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Poll": {
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"title": {
"type": "string",
"metadata": {
"description": "Poll title."
}
},
"creatorId": {
"type": "string",
"metadata": {
"description": "Poll creator ID."
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Main poll image."
}
},
"options": {
"elements": {
"ref": "PollData_Poll_Option"
},
"metadata": {
"description": " Poll details."
}
},
"settings": {
"ref": "PollData_Poll_Settings",
"metadata": {
"description": "Poll display settings."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Poll_Option": {
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"description": "Poll option ID."
}
},
"title": {
"type": "string",
"metadata": {
"description": "Poll option title"
}
},
"image": {
"ref": "Media",
"metadata": {
"description": "Image displayed with the option."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Poll_Settings": {
"optionalProperties": {
"permissions": {
"ref": "PollData_Poll_Settings_Permissions",
"metadata": {
"description": "Permission settings for voting."
}
},
"showVoters": {
"type": "boolean",
"metadata": {
"description": "Whether to display the voters in the vote results. \n Default: `true`."
}
},
"showVotesCount": {
"type": "boolean",
"metadata": {
"description": "Whether to display the vote count. \n Default: `true`."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Poll_Settings_Permissions": {
"optionalProperties": {
"view": {
"metadata": {
"emitEnum": "PollData_Poll_Settings_Permissions_ViewRole",
"description": "Who can view the poll results. Possible values: \n - `CREATOR`: Only poll creator can see the results. \n - `VOTERS`: Only voters can see the results. \n - `EVERYONE`: Anyone who visits the site can see the results."
},
"enum": [
"CREATOR",
"VOTERS",
"EVERYONE"
]
},
"vote": {
"metadata": {
"description": "Who can vote. Possble values: \n - `SITE_MEMBERS`: Only site members can vote. \n - `ALL`: All site visitors can vote.",
"emitEnum": "PollData_Poll_Settings_Permissions_VoteRole"
},
"enum": [
"SITE_MEMBERS",
"ALL"
]
},
"allowMultipleVotes": {
"type": "boolean",
"metadata": {
"description": "Whether one site visitor can vote multiple times. \n Default: `false`"
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Layout": {
"optionalProperties": {
"poll": {
"ref": "PollData_Layout_PollLayout",
"metadata": {
"description": "Poll layout settings."
}
},
"options": {
"ref": "PollData_Layout_OptionLayout",
"metadata": {
"description": "Poll options layout settings."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Layout_PollLayout": {
"optionalProperties": {
"type": {
"enum": [
"LIST",
"GRID"
],
"metadata": {
"emitEnum": "PollData_Layout_PollLayout_Type",
"description": "Voting options layout. Possible values:
- `LIST`: Options are displayed as a list.
- `GRID`: Options are displayed in a grid.."
}
},
"direction": {
"enum": [
"LTR",
"RTL"
],
"metadata": {
"emitEnum": "PollData_Layout_PollLayout_Direction",
"description": "Direction of the text in the poll. Possible values:
- `LTR`: Left to right.
- `RTL`: Right to left."
}
},
"enableImage": {
"type": "boolean",
"metadata": {
"description": "Whether to display the main poll image. \n Default: `false`"
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Layout_OptionLayout": {
"optionalProperties": {
"enableImage": {
"type": "boolean",
"metadata": {
"description": "Whether to display option images. \n Defaults: `false`."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Design": {
"optionalProperties": {
"poll": {
"ref": "PollData_Design_PollDesign",
"metadata": {
"description": "Poll styling."
}
},
"options": {
"ref": "PollData_Design_OptionDesign",
"metadata": {
"description": "Voting options styling."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Design_PollDesign": {
"optionalProperties": {
"background": {
"ref": "PollData_Design_PollDesign_Background",
"metadata": {
"description": "Poll background styling."
}
},
"borderRadius": {
"type": "int32",
"metadata": {
"description": "Border radius in pixels."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Design_PollDesign_Background": {
"discriminator": "type",
"metadata": {
"section": "Poll",
"refUnion": {
"COLOR": "PollData_Background_ColorVariant",
"IMAGE": "PollData_Background_ImageVariant",
"GRADIENT": "PollData_Background_GradientVariant"
},
"emitEnum": "PollData_Design_PollDesign_Background_Type"
},
"mapping": {
"COLOR": {
"properties": {},
"optionalProperties": {
"color": {
"type": "string",
"metadata": {
"format": "COLOR_HEX",
"description": "The background color in a hexademical value."
}
}
},
"metadata": {
"section": "Poll"
}
},
"IMAGE": {
"properties": {},
"optionalProperties": {
"image": {
"ref": "Media",
"metadata": {
"description": "Image to use for the background."
}
}
},
"metadata": {
"section": "Poll"
}
},
"GRADIENT": {
"properties": {},
"optionalProperties": {
"gradient": {
"ref": "PollData_Design_PollDesign_Background_Gradient",
"metadata": {
"description": "Gradient background details."
}
}
},
"metadata": {
"section": "Poll"
}
}
}
},
"PollData_Background_ColorVariant": {
"properties": {
"type": {
"enum": [
"COLOR"
]
}
},
"optionalProperties": {
"color": {
"type": "string",
"metadata": {
"format": "COLOR_HEX",
"description": "The background color in a hexademical value."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Background_ImageVariant": {
"properties": {
"type": {
"enum": [
"IMAGE"
]
}
},
"optionalProperties": {
"image": {
"ref": "Media",
"metadata": {
"description": "Image to use for the background."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Background_GradientVariant": {
"properties": {
"type": {
"enum": [
"GRADIENT"
]
}
},
"optionalProperties": {
"gradient": {
"ref": "PollData_Design_PollDesign_Background_Gradient",
"metadata": {
"description": "Gradient background details."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Design_PollDesign_Background_Gradient": {
"optionalProperties": {
"angle": {
"type": "int32",
"metadata": {
"description": "Gradient angle in degrees."
}
},
"startColor": {
"type": "string",
"metadata": {
"format": "COLOR_HEX",
"description": "Start color as a hexadecimal value."
}
},
"lastColor": {
"type": "string",
"metadata": {
"format": "COLOR_HEX",
"description": "end color as a hexadecimal value."
}
}
},
"metadata": {
"section": "Poll"
}
},
"PollData_Design_OptionDesign": {
"optionalProperties": {
"borderRadius": {
"type": "int32",
"metadata": {
"description": "Border radius in pixels."
}
}
},
"metadata": {
"section": "Poll"
}
},
"TableNode": {
"metadata": {
"section": "Table",
"examples": [
"table"
],
"features": [
"TABLE"
],
"description": "A structural node used to display data in rows and columns."
},
"properties": {
"type": {
"enum": [
"TABLE"
],
"metadata": {
"description": "Node type. \n Value: `TABLE`"
}
},
"nodes": {
"elements": {
"ref": "TableRowNode"
},
"metadata": {
"description": "Child nodes to define table rows.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"tableData": {
"ref": "TableData",
"metadata": {
"description": "Table details."
}
}
}
},
"TableRowNode": {
"properties": {
"type": {
"enum": [
"TABLE_ROW"
],
"metadata": {
"description": "Node type. \n Value: `TABLE_ROW`"
}
},
"nodes": {
"elements": {
"ref": "TableCellNode"
},
"metadata": {
"description": "Child nodes to define table cells.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
}
},
"metadata": {
"section": "Table"
}
},
"TableData": {
"optionalProperties": {
"containerData": {
"metadata": {
"description": "Styling for the table container, such as dimensions and alignment."
},
"ref": "PluginContainerData"
},
"dimensions": {
"metadata": {
"description": "Table dimensions."
},
"ref": "TableData_Dimensions"
},
"rowHeader": {
"metadata": {
"description": "Whether the table's first row is a heading.
Default: `false`"
},
"type": "boolean"
},
"columnHeader": {
"metadata": {
"description": "Whether the table's first column is a heading.
Default: `false`"
},
"type": "boolean"
}
},
"metadata": {
"section": "Table"
}
},
"TableData_Dimensions": {
"optionalProperties": {
"colsWidthRatio": {
"elements": {
"type": "float64"
},
"metadata": {
"description": "Each column width as related to the width of table."
}
},
"rowsHeight": {
"elements": {
"type": "uint32"
},
"metadata": {
"description": "Height of each row."
}
},
"colsMinWidth": {
"elements": {
"type": "uint32"
},
"metadata": {
"description": "Minimum width of each column."
}
}
},
"metadata": {
"section": "Table"
}
},
"TableCellNode": {
"properties": {
"type": {
"enum": [
"TABLE_CELL"
],
"metadata": {
"description": "Node type. \n Value: `TABLE_CELL`"
}
},
"nodes": {
"elements": {
"ref": "TableCellChildNode"
},
"metadata": {
"description": "Child nodes to define cell content.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"tableCellData": {
"ref": "TableCellData",
"metadata": {
"description": "Table cell details."
}
}
},
"metadata": {
"section": "Table"
}
},
"TableCellChildNode": {
"discriminator": "type",
"metadata": {
"section": "Table",
"refUnion": {
"PARAGRAPH": "ParagraphNode",
"HEADING": "HeadingNode",
"BULLETED_LIST": "BulletedListNode",
"ORDERED_LIST": "OrderedListNode",
"BLOCKQUOTE": "BlockquoteNode",
"AUDIO": "AudioNode",
"FILE": "FileNode",
"IMAGE": "ImageNode",
"VIDEO": "VideoNode",
"GIF": "GifNode",
"DIVIDER": "DividerNode",
"CODE_BLOCK": "CodeBlockNode",
"HTML": "HtmlNode",
"LINK_PREVIEW": "LinkPreviewNode",
"APP_EMBED": "AppEmbedNode",
"BUTTON": "ButtonNode",
"EMBED": "EmbedNode"
},
"description": "Table cell content node."
},
"mapping": {
"PARAGRAPH": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"HEADING": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"BULLETED_LIST": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"ORDERED_LIST": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"BLOCKQUOTE": {
"metadata": {
"section": "Block quote",
"examples": [
"blockquote"
],
"description": "Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it is displayed as the quoted text with indentation or other styling to visually separate it from the surrounding content."
},
"properties": {
"nodes": {
"elements": {
"ref": "ParagraphNode"
},
"metadata": {
"description": "Child nodes to define a blockquote paragraph.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"blockquoteData": {
"ref": "BlockquoteData",
"metadata": {
"description": "Blockquote details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"AUDIO": {
"metadata": {
"section": "Audio",
"examples": [
"audio-soundcloud"
],
"features": [
"AUDIO"
],
"description": "A multimedia node used to embed and play audio content directly in a webpage. When rendered, it is displayed as the audio player with the specified audio file (can be a platform such as Spotify or Soundloud, and Wix Media). Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"audioData": {
"ref": "AudioData",
"metadata": {
"description": "Audio details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"FILE": {
"metadata": {
"section": "File",
"examples": [
"file"
],
"features": [
"FILE"
],
"description": "A digital file stored on a computer that is uploaded and accessed in a page. Files can include various types of content, such as text documents, images, videos, and so on."
},
"properties": {
"fileData": {
"ref": "FileData",
"metadata": {
"description": "File details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"IMAGE": {
"metadata": {
"section": "Image",
"examples": [
"image-id",
"image-url"
],
"features": [
"IMAGE"
],
"description": "Displays standalone pictures in a page."
},
"properties": {
"imageData": {
"ref": "ImageData",
"metadata": {
"description": "Image options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"VIDEO": {
"metadata": {
"section": "Video",
"examples": [
"video-url",
"video-wix"
],
"features": [
"VIDEO"
],
"description": "A multimedia node that is used to embed and play 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."
},
"properties": {
"videoData": {
"ref": "VideoData",
"metadata": {
"description": "Video details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GIF": {
"metadata": {
"section": "Gif",
"examples": [
"gif-basic"
],
"features": [
"GIF"
],
"description": "GIF images are made up of a series of frames, allowing them to display animations or short video clips without the need for additional plugins or technologies."
},
"properties": {
"gifData": {
"ref": "GIFData",
"metadata": {
"description": "GIF details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"DIVIDER": {
"metadata": {
"section": "Divider",
"examples": [
"divider"
],
"features": [
"DIVIDER"
],
"description": "A visual node that is used to separate content sections in a page. When rendered, it is displayed as a horizontal line between the paragraphs, acting as a divider between them."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"dividerData": {
"ref": "DividerData",
"metadata": {
"description": "Divider details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"CODE_BLOCK": {
"metadata": {
"section": "Codeblock",
"features": [
"CODE_BLOCK"
],
"examples": [
"code-block-multi-line",
"code-block-syntax-highlighting"
],
"description": "Used to present programming 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."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define a code block text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"codeBlockData": {
"ref": "CodeBlockData",
"metadata": {
"description": "Code block details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"HTML": {
"metadata": {
"section": "Html",
"examples": [
"html-code",
"html-url"
],
"features": [
"HTML"
],
"description": "Incorporates external content, such as interactive maps, or entire web pages."
},
"properties": {
"htmlData": {
"ref": "HTMLData",
"metadata": {
"description": "HTML details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"LINK_PREVIEW": {
"metadata": {
"section": "Link Preview",
"examples": [
"link-preview"
],
"features": [
"LINK_PREVIEW"
],
"description": "A 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 possibly a thumbnail image or other relevant information."
},
"properties": {
"linkPreviewData": {
"ref": "LinkPreviewData",
"metadata": {
"description": "Link preview details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"APP_EMBED": {
"metadata": {
"section": "App Embed",
"examples": [
"app-embed-event",
"app-embed-booking"
],
"features": [
"APP_EMBED"
],
"description": "Similar to `LinkPreviewNode`, this node is used to embed external content preview, but from Wix business solutions. You can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"appEmbedData": {
"ref": "AppEmbedData",
"metadata": {
"description": "Embedded Wix app details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"BUTTON": {
"metadata": {
"section": "Button",
"examples": [
"button-link",
"button-action",
"button-styled"
],
"features": [
"BUTTON"
],
"description": "A node that is used to trigger an action when clicked or activated."
},
"properties": {
"buttonData": {
"ref": "ButtonData",
"metadata": {
"description": "Button details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"EMBED": {
"metadata": {
"section": "Embed",
"examples": [
"embed"
],
"features": [
"EMBED"
],
"description": "Similar to `HtmlNode`, this node is used to display embedded content when you post a link to that resource, without having to parse the resource directly. It provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers without needing to handle the complex embedding code themselves. For more information, read [oembed](https://oembed.com/)."
},
"properties": {
"embedData": {
"ref": "EmbedData",
"metadata": {
"description": "oEmbed details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
}
}
},
"TableCellData": {
"optionalProperties": {
"cellStyle": {
"metadata": {
"description": "Styling for the cell, such as background color and text alignment."
},
"ref": "TableCellData_CellStyle"
},
"borderColors": {
"metadata": {
"description": "Cell border colors."
},
"ref": "TableCellData_BorderColors"
}
},
"metadata": {
"section": "Table"
}
},
"TableCellData_CellStyle": {
"optionalProperties": {
"verticalAlignment": {
"metadata": {
"description": "Vertical alignment for the cell's text. Possible values: \n - `TOP`: Aligns the top padding edge of the cell with the top of the row. \n - `MIDDLE`: Centers the padding box of the cell in the row. \n - `BOTTOM`: Aligns the bottom padding edge of the cell with the bottom of the row.",
"emitEnum": "TableCellData_VerticalAlignment"
},
"enum": [
"TOP",
"MIDDLE",
"BOTTOM"
]
},
"backgroundColor": {
"metadata": {
"description": "Cell background color in a hexadecimal value, for example `#4287f5`.",
"format": "COLOR_HEX"
},
"type": "string"
}
},
"metadata": {
"section": "Table"
}
},
"TableCellData_BorderColors": {
"optionalProperties": {
"left": {
"metadata": {
"format": "COLOR_HEX",
"description": "Left border color in a hexadecimal value."
},
"type": "string"
},
"right": {
"metadata": {
"format": "COLOR_HEX",
"description": "Right border color in a hexadecimal value."
},
"type": "string"
},
"top": {
"metadata": {
"format": "COLOR_HEX",
"description": "Top border color in a hexadecimal value."
},
"type": "string"
},
"bottom": {
"metadata": {
"format": "COLOR_HEX",
"description": "Bottom border color in a hexadecimal value."
},
"type": "string"
}
},
"metadata": {
"section": "Table"
}
},
"VideoNode": {
"metadata": {
"section": "Video",
"examples": [
"video-url",
"video-wix"
],
"features": [
"VIDEO"
],
"description": "A multimedia node that is used to embed and play 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."
},
"properties": {
"type": {
"enum": [
"VIDEO"
],
"metadata": {
"description": "Node type. \n Value: `VIDEO`"
}
},
"videoData": {
"ref": "VideoData",
"metadata": {
"description": "Video details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"VideoData": {
"properties": {
"video": {
"metadata": {
"description": "Video file details, such as source and dimensions."
},
"ref": "Media"
}
},
"optionalProperties": {
"containerData": {
"metadata": {
"description": "Styling for the video container, such as dimensions and alignment."
},
"ref": "PluginContainerData"
},
"thumbnail": {
"metadata": {
"description": "Video thumbnail details, such as dimensions."
},
"ref": "Media"
},
"disableDownload": {
"metadata": {
"description": "Whether the video download button is disabled. \n Default: `false`"
},
"type": "boolean"
},
"title": {
"metadata": {
"description": "Video title."
},
"type": "string"
},
"options": {
"ref": "PlaybackOptions",
"metadata": {
"description": "Playback details."
}
}
},
"metadata": {
"section": "Video"
}
},
"PlaybackOptions": {
"optionalProperties": {
"autoPlay": {
"metadata": {
"description": "Whether the media automatically starts playing after opening a page."
},
"type": "boolean"
},
"playInLoop": {
"type": "boolean",
"metadata": {
"description": "Whether the media is looped."
}
},
"showControls": {
"type": "boolean",
"metadata": {
"description": "Whether to show the media controls."
}
}
},
"metadata": {
"section": "Video"
}
},
"RootNode": {
"discriminator": "type",
"metadata": {
"section": "RootNode",
"description": "Represents nodes that can be added to the root level of `nodes` array.",
"refUnion": {
"PARAGRAPH": "ParagraphNode",
"HEADING": "HeadingNode",
"BULLETED_LIST": "BulletedListNode",
"ORDERED_LIST": "OrderedListNode",
"BLOCKQUOTE": "BlockquoteNode",
"CODE_BLOCK": "CodeBlockNode",
"VIDEO": "VideoNode",
"DIVIDER": "DividerNode",
"FILE": "FileNode",
"GALLERY": "GalleryNode",
"GIF": "GifNode",
"HTML": "HtmlNode",
"IMAGE": "ImageNode",
"LINK_PREVIEW": "LinkPreviewNode",
"POLL": "PollNode",
"APP_EMBED": "AppEmbedNode",
"BUTTON": "ButtonNode",
"COLLAPSIBLE_LIST": "CollapsibleListNode",
"TABLE": "TableNode",
"EMBED": "EmbedNode",
"AUDIO": "AudioNode"
}
},
"mapping": {
"PARAGRAPH": {
"metadata": {
"section": "Paragraph",
"description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
"examples": [
"paragraph"
]
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Paragraph children."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"paragraphData": {
"ref": "ParagraphData",
"metadata": {
"description": "Paragraph node attributes."
}
}
}
},
"HEADING": {
"metadata": {
"section": "Heading",
"examples": [
"headings-all-sizes"
],
"description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define the heading text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
},
"headingData": {
"ref": "HeadingData",
"metadata": {
"description": "Heading options."
}
}
}
},
"BULLETED_LIST": {
"metadata": {
"section": "List",
"examples": [
"bulletedList"
],
"description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"bulletedListData": {
"ref": "BulletedListData",
"metadata": {
"description": "Bulleted list details."
}
}
}
},
"ORDERED_LIST": {
"metadata": {
"section": "List",
"examples": [
"orderedList"
],
"description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
},
"properties": {
"nodes": {
"elements": {
"ref": "ListItemNode",
"metadata": {
"validation": {
"minSize": 1
}
}
},
"metadata": {
"description": "List items.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"orderedListData": {
"ref": "OrderedListData",
"metadata": {
"description": "Ordered list details."
}
}
}
},
"BLOCKQUOTE": {
"metadata": {
"section": "Block quote",
"examples": [
"blockquote"
],
"description": "Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it is displayed as the quoted text with indentation or other styling to visually separate it from the surrounding content."
},
"properties": {
"nodes": {
"elements": {
"ref": "ParagraphNode"
},
"metadata": {
"description": "Child nodes to define a blockquote paragraph.",
"validation": {
"minSize": 1,
"maxSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"blockquoteData": {
"ref": "BlockquoteData",
"metadata": {
"description": "Blockquote details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"CODE_BLOCK": {
"metadata": {
"section": "Codeblock",
"features": [
"CODE_BLOCK"
],
"examples": [
"code-block-multi-line",
"code-block-syntax-highlighting"
],
"description": "Used to present programming 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."
},
"properties": {},
"optionalProperties": {
"nodes": {
"elements": {
"ref": "TextNode"
},
"metadata": {
"description": "Child nodes to define a code block text."
}
},
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"codeBlockData": {
"ref": "CodeBlockData",
"metadata": {
"description": "Code block details."
}
},
"style": {
"ref": "NodeStyle",
"metadata": {
"description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
}
}
}
},
"VIDEO": {
"metadata": {
"section": "Video",
"examples": [
"video-url",
"video-wix"
],
"features": [
"VIDEO"
],
"description": "A multimedia node that is used to embed and play 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."
},
"properties": {
"videoData": {
"ref": "VideoData",
"metadata": {
"description": "Video details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"DIVIDER": {
"metadata": {
"section": "Divider",
"examples": [
"divider"
],
"features": [
"DIVIDER"
],
"description": "A visual node that is used to separate content sections in a page. When rendered, it is displayed as a horizontal line between the paragraphs, acting as a divider between them."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"dividerData": {
"ref": "DividerData",
"metadata": {
"description": "Divider details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"FILE": {
"metadata": {
"section": "File",
"examples": [
"file"
],
"features": [
"FILE"
],
"description": "A digital file stored on a computer that is uploaded and accessed in a page. Files can include various types of content, such as text documents, images, videos, and so on."
},
"properties": {
"fileData": {
"ref": "FileData",
"metadata": {
"description": "File details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GALLERY": {
"metadata": {
"section": "Gallery",
"examples": [
"gallery"
],
"features": [
"GALLERY"
],
"description": "A collection of images displayed together in a visually appealing and organized manner."
},
"properties": {
"galleryData": {
"ref": "GalleryData",
"metadata": {
"description": "Gallery node details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"GIF": {
"metadata": {
"section": "Gif",
"examples": [
"gif-basic"
],
"features": [
"GIF"
],
"description": "GIF images are made up of a series of frames, allowing them to display animations or short video clips without the need for additional plugins or technologies."
},
"properties": {
"gifData": {
"ref": "GIFData",
"metadata": {
"description": "GIF details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"HTML": {
"metadata": {
"section": "Html",
"examples": [
"html-code",
"html-url"
],
"features": [
"HTML"
],
"description": "Incorporates external content, such as interactive maps, or entire web pages."
},
"properties": {
"htmlData": {
"ref": "HTMLData",
"metadata": {
"description": "HTML details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"IMAGE": {
"metadata": {
"section": "Image",
"examples": [
"image-id",
"image-url"
],
"features": [
"IMAGE"
],
"description": "Displays standalone pictures in a page."
},
"properties": {
"imageData": {
"ref": "ImageData",
"metadata": {
"description": "Image options."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"LINK_PREVIEW": {
"metadata": {
"section": "Link Preview",
"examples": [
"link-preview"
],
"features": [
"LINK_PREVIEW"
],
"description": "A 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 possibly a thumbnail image or other relevant information."
},
"properties": {
"linkPreviewData": {
"ref": "LinkPreviewData",
"metadata": {
"description": "Link preview details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"POLL": {
"metadata": {
"section": "Poll",
"examples": [
"poll"
],
"features": [
"POLL"
],
"description": "A node that allows users to vote or express their opinions on a particular question, topic, or issue."
},
"properties": {
"pollData": {
"ref": "PollData",
"metadata": {
"description": "Poll details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"APP_EMBED": {
"metadata": {
"section": "App Embed",
"examples": [
"app-embed-event",
"app-embed-booking"
],
"features": [
"APP_EMBED"
],
"description": "Similar to `LinkPreviewNode`, this node is used to embed external content preview, but from Wix business solutions. You can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"appEmbedData": {
"ref": "AppEmbedData",
"metadata": {
"description": "Embedded Wix app details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"BUTTON": {
"metadata": {
"section": "Button",
"examples": [
"button-link",
"button-action",
"button-styled"
],
"features": [
"BUTTON"
],
"description": "A node that is used to trigger an action when clicked or activated."
},
"properties": {
"buttonData": {
"ref": "ButtonData",
"metadata": {
"description": "Button details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"COLLAPSIBLE_LIST": {
"metadata": {
"section": "Collapsible List",
"examples": [
"collapsible-list"
],
"features": [
"COLLAPSIBLE_LIST"
],
"description": "A list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it."
},
"properties": {
"nodes": {
"elements": {
"ref": "CollapsibleItemNode"
},
"metadata": {
"description": "Collapsible list child nodes.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"collapsibleListData": {
"ref": "CollapsibleListData",
"metadata": {
"description": "Collapsible list details."
}
}
}
},
"TABLE": {
"metadata": {
"section": "Table",
"examples": [
"table"
],
"features": [
"TABLE"
],
"description": "A structural node used to display data in rows and columns."
},
"properties": {
"nodes": {
"elements": {
"ref": "TableRowNode"
},
"metadata": {
"description": "Child nodes to define table rows.",
"validation": {
"minSize": 1
}
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"tableData": {
"ref": "TableData",
"metadata": {
"description": "Table details."
}
}
}
},
"EMBED": {
"metadata": {
"section": "Embed",
"examples": [
"embed"
],
"features": [
"EMBED"
],
"description": "Similar to `HtmlNode`, this node is used to display embedded content when you post a link to that resource, without having to parse the resource directly. It provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers without needing to handle the complex embedding code themselves. For more information, read [oembed](https://oembed.com/)."
},
"properties": {
"embedData": {
"ref": "EmbedData",
"metadata": {
"description": "oEmbed details."
}
}
},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
},
"AUDIO": {
"metadata": {
"section": "Audio",
"examples": [
"audio-soundcloud"
],
"features": [
"AUDIO"
],
"description": "A multimedia node used to embed and play audio content directly in a webpage. When rendered, it is displayed as the audio player with the specified audio file (can be a platform such as Spotify or Soundloud, and Wix Media). Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
},
"properties": {},
"optionalProperties": {
"id": {
"type": "string",
"metadata": {
"format": "NODE_ID",
"description": "[Node ID](#node-ids)."
}
},
"audioData": {
"ref": "AudioData",
"metadata": {
"description": "Audio details."
}
},
"nodes": {
"metadata": {
"internal": true
},
"elements": {
"ref": "Never"
}
}
}
}
}
}
}
}