Copy page

@wocart/theme v4.1.0

---

@wocart/theme / index / RichTextFieldDefinition

Interface: RichTextFieldDefinition

richtext: formatted text, stored as a RichTextDocument (or one per language) — never as HTML. formats narrows what the merchant may use; a stored document using anything else is invalid. Render it with richTextToHtml.

Extends

• FieldDefinitionBase

Properties

default?

optional default?: RichTextValue

---

description?

optional description?: LocalizedText

Editor-facing help text.

Inherited from

FieldDefinitionBase.description

---

formats?

optional formats?: readonly RichTextFormat[]

---

inline?

optional inline?: boolean

true: one line of text — a single paragraph with marks and links, no headings or lists — rendered without a block element (richTextToHtml(doc, { inline: true })), for a title with one bold word.

---

key

key: string

The exact prop name the component expects.

Inherited from

FieldDefinitionBase.key

---

kind

kind: "richtext"

---

label

label: LocalizedText

Editor-facing name, the same in every language or translated.

Inherited from

FieldDefinitionBase.label

---

required?

optional required?: boolean

Inherited from

FieldDefinitionBase.required

---

visibleIf?

optional visibleIf?: FieldCondition

When an editor shows the field; absent: always. The renderer ignores it.

Inherited from

FieldDefinitionBase.visibleIf