export declare const ricosDocumentReferenceMd = "# Ricos Document\n\n:not(a)]:text-slate-950 flex flex-col gap-1 bg-[#FFF8EA] border-yellow-300\"\n>\n

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

\n\n\n\nWix Ricos defines its own data structure, the Ricos document. Its a central\npiece of Ricos technology as the rich content editor and viewer are built\naround it.\n\nFundamentally, the object structure is a **tree of nodes** representing content\nblocks. It includes basic text container nodes (like paragraphs, headings,\nlists, and so on), as well as more complex nodes that require Ricos plugins to\nwork. These complex nodes allow for the creation of advanced content blocks\n(like videos, tables, galleries, and so on).\n\nThe Ricos document resembles HTML, with various node types acting like HTML\ntags and their fields functioning as attributes. The `nodes` field represents the\nchildren of HTML tags. The primary difference, and the reason Ricos does not use\nHTML as its structure, is that the Ricos document imposes more constraints. This\nallows it to be more easily manipulated and displayed across different\nenvironments.\n\n:not(a)]:text-slate-950 flex flex-col gap-1 bg-[#FFF8EA] border-yellow-300\"\n>\n

\n Caution: This document describes the full reference of Ricos document schema. However, when creating rich content with Wix APIs that access a Ricos Document, beware of the plugins that each product supports. A list of supported plugins is described in each API where the Ricos Document is used.\n

\n\n\n## Quicklinks\n- For **text** use [Paragraph](#paragraphnode), [Heading](#headingnode), [Blockquote](#blockquotenode), [CodeBlock](#codeblocknode), [Text](#textnode) nodes.\n- For **lists** use [BulletedList](#bulletedlistnode), [OrderedList](#orderedlistnode), [CollapsibleList](#collapsiblelistnode), [Table](#tablenode) nodes.\n- For **media** use [Image](#imagenode), [Video](#videonode), [Gallery](#gallerynode), [Gif](#gifnode), [Audio](#audionode), [File](#filenode) nodes.\n- For **embeds** use [AppEmbed](#appembednode), [Embed](#embednode), [LinkPreview](#linkpreviewnode), [Html](#htmlnode) nodes.\n- Other nodes: [Divider](#dividernode), [Button](#buttonnode).\n- **Decorations**: [Bold](#bolddecoration), [Italic](#italicdecoration), [Underline](#underlinedecoration), [Spoiler](#spoilerdecoration), [Anchor](#anchordecoration), [Mention](#mentiondecoration), [Link](#linkdecoration), [Color](#colordecoration), [FontSize](#fontsizedecoration)\n\n## Playground\n\nYou can experiment with with rich content directly using the\nembedded playground we provide. You can experiment in the following way:\n- By editing the Ricos document in the `Document` section of the\nplayground.\n- By editing content in the `Editor` section. You will see how the\nRicos document is updated to reflect any changes made in the `Editor` section.\n\nFor a more comfortable experience you can try viewing examples in the [Full\nplayground](https://ricos.dev).\n\n\n\n\n

\n Example: Playground with an example
\n

\n\n\n\n\n## Reference\n\n##### RicosDocument\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| nodes
Required | Array <RootNode> | An array of nodes representing content elements, such as `ParagraphNode`, `HeadingNode`, and so on. |\n| metadata | Metadata | Data about the Ricos document, such as version. This property is applicable only when using the ricos content editor and is auto-generated. |\n| documentStyle | DocumentStyle | 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. |\n\n## Nodes\nThis section describes all possible nodes in the Ricos Document.\nSome are [unions](#tagged-unions), such as [RootNode](#rootnode).\n\nHere is the list of specific nodes, presented in alphabetical order for quick access:\n[AppEmbedNode](#appembednode),\n[AudioNode](#audionode),\n[BlockquoteNode](#blockquotenode),\n[BulletedListNode](#bulletedlistnode),\n[ButtonNode](#buttonnode),\n[CodeBlockNode](#codeblocknode),\n[CollapsibleItemNode](#collapsibleitemnode),\n[CollapsibleItemBodyNode](#collapsibleitembodynode),\n[CollapsibleItemTitleNode](#collapsibleitemtitlenode),\n[CollapsibleListNode](#collapsiblelistnode),\n[DividerNode](#dividernode),\n[EmbedNode](#embednode),\n[FileNode](#filenode),\n[GalleryNode](#gallerynode),\n[GifNode](#gifnode),\n[HeadingNode](#headingnode),\n[HtmlNode](#htmlnode),\n[ImageNode](#imagenode),\n[LinkPreviewNode](#linkpreviewnode),\n[ListItemNode](#listitemnode),\n[OrderedListNode](#orderedlistnode),\n[ParagraphNode](#paragraphnode),\n[PollNode](#pollnode),\n[TableCellNode](#tablecellnode),\n[TableNode](#tablenode),\n[TableRowNode](#tablerownode),\n[TextNode](#textnode),\n[VideoNode](#videonode).\n\n##### RootNode\n\n**Used in:** RicosDocument\n\nRepresents nodes that can be added to the root level of `nodes` array.\n\n _This type is [Tagged Union](#tagged-unions)\nwith `type` field being the discriminating tag._ \n\n| Variant | Tag value | Description |\n| :------ | :------ | :------ |\n| AppEmbedNode | `APP_EMBED` | 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. |\n| AudioNode | `AUDIO` | 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. |\n| BlockquoteNode | `BLOCKQUOTE` | 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. |\n| BulletedListNode | `BULLETED_LIST` | 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. |\n| ButtonNode | `BUTTON` | A node that is used to trigger an action when clicked or activated. |\n| CodeBlockNode | `CODE_BLOCK` | 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. |\n| CollapsibleListNode | `COLLAPSIBLE_LIST` | A list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it. |\n| DividerNode | `DIVIDER` | 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. |\n| EmbedNode | `EMBED` | 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/). |\n| FileNode | `FILE` | 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. |\n| GalleryNode | `GALLERY` | A collection of images displayed together in a visually appealing and organized manner. |\n| GifNode | `GIF` | 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. |\n| HeadingNode | `HEADING` | 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. |\n| HtmlNode | `HTML` | Incorporates external content, such as interactive maps, or entire web pages. |\n| ImageNode | `IMAGE` | Displays standalone pictures in a page. |\n| LinkPreviewNode | `LINK_PREVIEW` | 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. |\n| OrderedListNode | `ORDERED_LIST` | 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. |\n| ParagraphNode | `PARAGRAPH` | 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. |\n| PollNode | `POLL` | A node that allows users to vote or express their opinions on a particular question, topic, or issue. |\n| TableNode | `TABLE` | A structural node used to display data in rows and columns. |\n| VideoNode | `VIDEO` | 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. |\n\n#### ParagraphNode\n\n**Used in:** RootNode, BlockquoteNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode\n\nUsed 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.\n\n\n\n\n

\n Example: Paragraph
\n

\n Example: Text
\n

\n Example: Heading sizes
\n

Note: This type requires the image plugin.

\n\nDisplays standalone pictures in a page.\n\n\n\n\n

\n Example: Image imported from Wix Media
\nExample: Image that is embedded using URL
\n

\n Example: Ordered list
\n

\n\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| type
Required | `\"ORDERED_LIST\"` | Node type.
Value: `ORDERED_LIST` |\n| nodes
Required | Array <ListItemNode>
minItems: 1 | List items. |\n| id | string
format NODE_ID | [Node ID](#node-ids). |\n| orderedListData | OrderedListData | Ordered list details. |\n\n##### OrderedListData\n\n**Used in:** OrderedListNode\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| indentation
Deprecated | int32
| List margin from the left side. Possible values are from `1` to `4`.
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. |\n| offset | int32
| 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. |\n| start | int32
| An integer to start counting from for the list items, overriding the default start of 1. |\n\n#### BulletedListNode\n\n**Used in:** RootNode, ListItemChildNode, TableCellChildNode, CollapsibleTitleChildNode, CollapsibleItemBodyChildNode\n\nPresents 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.\n\n\n\n\n

\n Example: Bulleted list
\n

\n\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| type
Required | `\"BULLETED_LIST\"` | Node type.
Value: `BULLETED_LIST` |\n| nodes
Required | Array <ListItemNode>
minItems: 1 | List items. |\n| id | string
format NODE_ID | [Node ID](#node-ids). |\n| bulletedListData | BulletedListData | Bulleted list details. |\n\n##### BulletedListData\n\n**Used in:** BulletedListNode\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| indentation
Deprecated | int32
| |\n| offset | int32
| 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. |\n\n##### ListItemNode\n\n**Used in:** BulletedListNode, OrderedListNode\n\n\n\n

\n Items in field nodes must conform to the following pattern: \n\n`(PARAGRAPH|HEADING|IMAGE|VIDEO|GIF|GALLERY) (PARAGRAPH|BULLETED_LIST|ORDERED_LIST|HEADING|IMAGE|VIDEO|GIF|GALLERY)*`\n\nA list item must start with a paragraph or heading, followed by any number of paragraphs, bulleted lists, or ordered lists.\n\nMore about [patterns](#patterns)\n

\n Example: Blockquote
\n

Note: This type requires the giphy plugin.

\n\nGIF 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.\n\n\n\n\n

\n Example: GIF
\n

\n\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| type
Required | `\"GIF\"` | Node type.
Value: `GIF` |\n| gifData
Required | GIFData | GIF details. |\n| id | string
format NODE_ID | [Node ID](#node-ids). |\n\n##### GIFData\n\n**Used in:** GifNode\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| containerData | PluginContainerData | Styling for the GIF container, such as dimensions and alignment. |\n| original | GIF | Source for the full size GIF. |\n| downsized | GIF | Source for the downsized GIF. |\n| height | int32
| Height in pixels. |\n| width | int32
| Width in pixels. |\n\n##### GIF\n\n**Used in:** GIFData\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| gif | string
format WEB_URL | URL for a file in GIF format. |\n| mp4 | string
format WEB_URL | URL for a file in MP4 format. |\n| still | string
format WEB_URL | GIF thumbnail URL. |\n\n#### VideoNode\n\n**Used in:** RootNode, ListItemChildNode, TableCellChildNode, CollapsibleItemBodyChildNode\n\n

Note: This type requires the video plugin.

\n\nA 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.\n\n\n\n\n

\n Example: Video from Youtube
\nExample: Video imported from Wix Media
\n

Note: This type requires the table plugin.

\n\nA structural node used to display data in rows and columns.\n\n\n\n\n

\n Example: Basic table
\n

Note: This type requires the appEmbed plugin.

\n\nSimilar 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.\n\n\n\n\n

\n Example: Embedded Wix Events app
\nExample: Embedded Wix Bookings app
\n

Note: This type requires the linkPreview plugin.

\n\nSimilar 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/).\n\n\n\n\n

\n Example: oEmbed
\n

Note: This type requires the divider plugin.

\n\nA 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.\n\n\n\n\n

\n Example: Divider
\n

Note: This type requires the codeBlock plugin.

\n\nUsed 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.\n\n\n\n\n

\n Example: Code block
\nExample: Code block with syntax highlighting
\n

Note: This type requires the linkPreview plugin.

\n\nA 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.\n\n\n\n\n

\n Example: Link preview
\n

Note: This type requires the audio plugin.

\n\nA 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.\n\n\n\n\n

\n Example: SoundCloud audio
\n

Note: This type requires the gallery plugin.

\n\nA collection of images displayed together in a visually appealing and organized manner.\n\n\n\n\n

\n Example: Gallery
\n

\n Fields image, video are in Required One Of group.\n\nRead more about One Of groups [here](#one-of).\n

Note: This type requires the collapsibleList plugin.

\n\nA list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it.\n\n\n\n\n

\n Example: Collapsible List
\n

\n Items in field nodes must conform to the following pattern: \n\n`COLLAPSIBLE_ITEM_TITLE COLLAPSIBLE_ITEM_BODY`\n\nMust contain title as the first item and body as the second.\n\nMore about [patterns](#patterns)\n

Note: This type requires the file plugin.

\n\nA 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.\n\n\n\n\n

\n Example: File upload from Wix Media
\n

Note: This type requires the actionButton, linkButton plugin.

\n\nA node that is used to trigger an action when clicked or activated.\n\n\n\n\n

\n Example: Button that redirects to the given link
\nExample: Action Button
\nExample: Button with custom styles
\n

Note: This type requires the poll plugin.

\n\nA node that allows users to vote or express their opinions on a particular question, topic, or issue.\n\n\n\n\n

\n Example: Poll
\n

Note: This type requires the html plugin.

\n\nIncorporates external content, such as interactive maps, or entire web pages.\n\n\n\n\n

\n Example: Embedded inline HTML
\nExample: Embedded HTML using URL
\n

\n Fields url, html are in One Of group.\n\nRead more about One Of groups [here](#one-of).\n

\n Example: Various decorations
\n

\n Example: Bold decoration
\n

\n Example: Italic decoration
\n

\n Example: Underline decoration
\n

Note: This type requires the spoiler plugin.

\n\nText that is styled to appear blurred.
**Note:** This decoration requires the [spoiler](#plugins) plugin.\n\n\n\n\n

\n Example: Spoiler decoration
\n

\n\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| type
Required | `\"SPOILER\"` | Decoration type.
Value: `SPOILER` |\n| spoilerData | SpoilerData | Spoiler details. |\n\n##### SpoilerData\n\n**Used in:** SpoilerDecoration\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| id | string
format NODE_ID | [Node ID](#node-ids). |\n\n#### AnchorDecoration\n\n**Used in:** Decoration\n\nClickable 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.\n\n\n\n\n

\n Example: Anchor decoration
\n

Note: This type requires the mention plugin.

\n\nA 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.\n\n\n\n\n

\n Example: Mention decoration
\n

Note: This type requires the link plugin.

\n\nClickable 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.\n\n\n\n\n

\n Example: Link decoration
\n

Note: This type requires the textColor, textHighlight plugin.

\n\nText that is styled using background and text colors.
**Note:** This decoration requires the [colorDecoration](#plugins) plugin.\n\n\n\n\n

\n Example: Color decoration
\n

\n Example: Font size decoration
\n

\n\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| type
Required | `\"FONT_SIZE\"` | Decoration type.
Value: `FONT_SIZE` |\n| fontSizeData | FontSizeData | Font size details. |\n\n##### FontSizeData\n\n**Used in:** FontSizeDecoration\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| unit | `enum`: `\"PX\"`, `\"EM\"` | Font size units. Possible values:
- `PX`: Size in pixels.
- `EM`: Relative to the font size of the element (2em means 2 times the size of the current font) |\n| value | float32
| Font size value. |\n\n## Metadata\n\nMetadata is used to tell the information about the Ricos document itself, like\na version. Can be skipped.\n\n##### Metadata\n\n**Used in:** RicosDocument\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| version | uint32
| Ricos document version. |\n| id
Deprecated | any | |\n| createdTimestamp
Deprecated | any | |\n| updatedTimestamp
Deprecated | any | |\n\n## Document Styles\n\n#### DocumentStyle\n\n**Used in:** RicosDocument\n\nThis 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).\n\n\n\n\n

\n Example: The same style for all H2 headings
\n

\n Fields size, custom are in One Of group.\n\nRead more about One Of groups [here](#one-of).\n

Note: This type requires the lineSpacing plugin.

\n Fields url, anchor are in Required One Of group.\n\nRead more about One Of groups [here](#one-of).\n

\n Fields url, id are in Required One Of group.\n\nRead more about One Of groups [here](#one-of).\n

\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| url
Required One Of | string
| Absolute URL for the file's source. |\n| id
Required One Of | string
| ID that's resolved to a URL by a resolver function. |\n| private | boolean
| Indicates whether the file's source is private.
Default: `false` |\n\n#### Media\n\n**Used in:** VideoData, ImageData, AudioData, PollData_Poll, AppEmbedDataProduct, AppEmbedDataEvent, AppEmbedDataBooking, GalleryData_Item_Image, GalleryData_Item_Video, PollData_Poll_Option, PollData_Background_ImageVariant\n\n\n\n| Field | Type | Description |\n| :------ | :------ | :------ |\n| src
Required | FileSource | Media data source. |\n| width | int32
| Media width in pixels. |\n| height | int32
| Media height in pixels. |\n| duration | float64
| Media duration in seconds. Only relevant for audio and video files. |\n\n\n\n## Explanations\n\n### Node Ids\nEach node ID should be a unique string in the document. These IDs are\nused primarily to identify nodes for anchor behavior, and sometimes as HTML\nIDs to execute rendering.\n\nThe node ID is mainly used for anchor behavior, as illustrated in the\n[AnchorDecoration](#anchordecoration) example. The editor automatically\ngenerates the ID. If you are creating the Ricos Document via an API, you must\nmanually add this ID if necessary.\n\n### Plugins\n\nThis article describes the full reference of Ricos Document schema.\nHowever, some parts of the Ricos document are operational only\nwhen the corresponding plugins in the API are enabled. For example\n[ImageNode](#imagenode) can be used only when the `image` plugin is\nenabled. A complete list of supported plugins is available in the field\ndescriptions of each API that supports the Ricos Document type.\n\nFull list of plugins which have effect on Ricos Document:\n[actionButton](#plugin-actionButton),\n[audio](#plugin-audio),\n[codeBlock](#plugin-codeBlock),\n[collapsibleList](#plugin-collapsibleList),\n[divider](#plugin-divider),\n[file](#plugin-file),\n[gallery](#plugin-gallery),\n[giphy](#plugin-giphy),\n[html](#plugin-html),\n[image](#plugin-image),\n[lineSpacing](#plugin-lineSpacing),\n[linkButton](#plugin-linkButton),\n[linkPreview](#plugin-linkPreview),\n[link](#plugin-link),\n[mention](#plugin-mention),\n[poll](#plugin-poll),\n[spoiler](#plugin-spoiler),\n[table](#plugin-table),\n[textColor](#plugin-textColor),\n[textHighlight](#plugin-textHighlight),\n[appEmbed](#plugin-appEmbed),\n[video](#plugin-video),\n\n\n### Tagged unions\n\nTagged unions are fundamental to the Ricos Document. They\naccommodate various nodes with different shapes that can occupy the\nsame space. At the root level, there can be more than 10 different\nnodes. How do we unambiguously determine which node is which? Tagged\nunions facilitate this by incorporating a common field present in\nevery node\u2019s object. In the Ricos Document, this field is named type\nbut may also be referred to as \u2018tag.\u2019 Each node (or decoration)\ncontains this same field, yet each possesses a distinct string value\nin it. This differentiation allows for easy identification of\neach node, despite them occupying the \u201Csame space.\u201D\n\nLearn more about them on [Wikipedia](https://en.wikipedia.org/wiki/Tagged_union)\n\n### Formats\n\n| Format | Description |\n| :------ | :------ |\n| WEB_URL | A URL that starts with `http://` or `https://`. |\n| COLOR_HEX | A color in hexadecimal RGB or RGBA format, such as `#FF0000` or `#FF000050`. Accepts shorthands like #F00 and #F005 |\n| NODE_ID | A unique identifier for a node. It must start with a letter and can contain only letters, numbers, hyphens, and underscores. |\n\n### Validations\n\n| Validation | Description |\n| :------ | :------ |\n| `minItems` | Minimum number of items in array |\n| `maxItems` | Maximum number of items in array |\n| `minLength` | Minimum length of string |\n| `maxLength` | Maximum length of string |\n| `uniqueTags` | The items in array must have unique union tags on them |\n\n### Patterns\n\nMost node children are arrays, which can contain zero or more of the\nspecified nodes in any order. However, there are exceptions like\n[ListItemNode](#listitemnode) and\n[CollapsibleItem](#collapsibleitemnode), which have specific\nrestrictions on how these arrays can be structured. For example, a\n[CollapsibleItem](#collapsibleitemnode) must contain one [CollapsibleItemTitleNode](#collapsibleitemtitlenode) and\none [CollapsibleItemBodyNode](#collapsibleitembodynode). A (ListItemNode)[#listitemnode) must have a\n(ParagraphNode)[#paragraphnode] or (HeadingNode)[#headingnode) as the first child, followed by any\nnumber of paragraphs, headings, or lists. The strict pattern\ndescription uses syntax similar to regular expressions:\n\n - `*` indicates any number of items\n - `+` indicates one or more items\n - `()` parentheses are used for groups and enclose item tags that can be used interchangeably.\n\nFor specific pattern descriptions, refer to the properties table containing the patterned field above.\n\n### One Of\n\nFields in the **One Of** groups have a constraint\nthat only one of them can be set at the same\ntime.\n\nThe variation **Required One Of** adds\nanother constraint: one (and still at most one)\nof the fields must be set.\n"; //# sourceMappingURL=ricos-document-reference.d.ts.map