Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Rich Text Editor Component

Prev Next

The Rich Text Editor component provides a WYSIWYG editor that lets end-users compose and format text with headings, bold, italics, lists, links, and other rich formatting. It can also display pre-configured HTML content or dynamic content from other module fields.

How to read settings tables

The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

General Settings

Setting

Field

Type

Default

Description

Property ID

key

Text input

rte

The unique identifier for this component instance.

Display Settings

Field Text

Setting

Field

Type

Default

Description

Label Text

label

Text input

—

Identifies the component on the canvas and informs end-users what information is requested.

Default State Options

Setting

Field

Type

Default

Description

Hide Field

hidden

Toggle

OFF

Hides the component from end-users but always displays in the Module Builder.

Formatting

Setting

Field

Type

Default

Description

Hide Toolbar in Express

noToolbar

Toggle

OFF

Hides the formatting toolbar and renders the text inline.

Input Behavior

Setting

Field

Type

Default

Description

Behavior

—

Drop-down

Enable User Input

Sets how end-users can interact with the field.

  • Enable User Input (default): End-users can type directly into the rich text editor.

  • Disable User Input (disabled): Prevents end-users from editing the content. The editor displays with an altered appearance to indicate it is not editable.

  • Read Only - Legacy (readOnlyView): Displays pre-configured static or dynamic content instead of an editable editor.

Content Display

Visible when Input Behavior is set to Read Only - Legacy.

Setting

Field

Type

Description

Default Content

texteditorData.content

WYSIWYG editor

The HTML content to display. Use the editor to format static content.

Reference Content

Maps module field values into the content using aliases. Use the alias in the WYSIWYG editor with the {{alias}} syntax.

Column

Field

Type

Description

Property ID

id

Property ID

The module field whose value to inject into the content.

Alias

inputLabel

Text input

The alias to use in the editor to reference this field's value.

Data Settings

Data Storage

Setting

Field

Type

Default

Description

Store Data in Database

persistent

Toggle

ON

When set to ON, this setting this setting stores field values to the database when the module saves, end-users navigate between Panel components, or end-users navigate between workflow screens. Set to OFF to exclude this field from server-side submissions.

Fields with Store Data in Database set to OFF are excluded from Plug-In component's API responses and Unqork's built-in tracker. When using a Plug-In component to remote-execute a module, any component whose value must be included in the API response requires Store Data in Database set to ON.

Validation Settings

User Input

Setting

Field

Type

Default

Description

Required

validate.required

Toggle

OFF

Requires content to be entered before the module can be submitted.

Required Error Message

errors.required

Text input

is required

Displays when the required field is empty.


Changelog

Date

Change

—

Initial publication.