Rich Text Component

The rich text component is typically used for writing marketing descriptions, including formatting and links.

When adding this component to a shape or piece, you can specify the following:

• Name (required) - A name for the component.
• Identifier - String that will be generated based on the component name when shape/piece is created or updated. You’ll use the identifier to reference the component programmatically.
• Description - An optional description of what the component should contain. This will be visible to anyone who adds content to the component later.
• Localized Content - If Yes, then you can store different text for each language set up within your tenant. If No, then the same text will be shared across all languages.
• Min/Max Characters - Optionally set minimum and/or maximum limits on the number of characters that may be added to this component.

The rich text editor gives you access to the following features:

• Undo/Redo buttons (you can also use CTRL+Z / Shift+CTRL+Z on your keyboard)
• Headings (H1 through H4)
• Bold, italic and underline text
• Code blocks or literal text
• Hyperlinks
• Strikethrough, _subscript, and ^superscript formatting
• Bulleted and numbered lists
• Block quotes
• Horizontal ruling lines
• Tables

You can also use the action menu (...) in the top-right corner of the component to copy the JSON representation of the component to your clipboard, or to clear the component of content.

Once created, rich text components and their content are accessible via the Catalogue API. Refer to our sample query for retrieving rich text component content, and to the API docs at https://api.crystallize.com/your-tenant-identifier/catalogue for more information.