About Ricos

Ricos is a rich content creation toolset that is used to define rich content through a Ricos document, which is a strictly defined JSON object structure. Fundamentally, a Ricos document's object structure is a tree of nodes representing content blocks. Learn more about using rich content in Wix APIs (SDK | REST).

Note: We are actively working to make the Ricos React libraries (editor and viewer) publicly available, which will allow Ricos rich content to be created and rendered anywhere.

Create a Ricos document

You can create a Ricos document object from scratch using the Ricos Document reference. However, in most cases you can build your rich content using the Ricos playground. You can build your content in the Editor tab, view it in the Viewer tab, and copy and paste it from the Document tab. Here's a mini version of the playground:

Plugins

Plugins allow rich content viewers to display specific nodes or decorations. Applications that render rich content may not support every type of content. For example, one rich content viewer might be able to display text, but not images.

Some Ricos types are universally supported, but the ones that aren't require an application to enable a specific plugin in order to render them. For example, to render imageNode apps must enable the image plugin. The Ricos Document reference specifies which plugins each type requires, if any.

Wix APIs that consume rich content specify which plugins are enabled in their rich content field description. For example, see the draftPost.richContent parameter in Create Draft Post. In the Ricos playground, you can enable and disable plugins to match the plugins enabled by the API that's consuming your rich content.

See the full list of Ricos plugins.

Did this help?