Rich Text Editor Component

Estimated Reading Time:  9 minutes

Overview

The Rich Text Editor component is an interactive component for rich text Rich text is text that supports various types of formatting, like images and colors. content. You can use the component in the following ways:

The Rich Text Editor component lets you:

  • Format and style text.
  • Spell-check content.
  • Paste content from external sources, including Microsoft Word.
  • Add images.
  • Maximize the Editor window for full-screen viewing.

The Rich Text Editor also has a Read Only Content View setting. When set to (ON), you can use the Rich Text Editor component to display formatted text instead of writing out HTML using a Content or HTML Element component. If you're not familiar with HTML, you can use the Rich Text Editor component as a display component.

Supported Fonts

If the Rich Text Editor component supports a specific font, it retains it when you copy and paste from an external source into the component in Express View. After pasting text into the component, you can confirm the font by clicking the Rich Text Editor Source Icon Source button in Express View:

The Rich Text Editor supports the following fonts:

Arial

Courier New

Georgia

Tahoma

Trebuchet MS

Calibri

EB Garamond

Lucida Sans Unicode

Times New Roman

Verdana

You'll find the Rich Text Editor component in the Display & Layout group to the left of the Module Builder.

What You'll Learn

After completing this article, you’ll know when to use a Rich Text Editor component, how to configure its settings, and how to use it in an Unqork application.

About the Configuration Window

General

A static image displaying the Rich Text Editor component's configuration window.

Setting Description

Property ID

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls.

Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation.

Notes Note-Icon

Select this tab to display the component's Notes area. You can use notes to keep your teammates informed.

The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.

Display Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Validation Icon Validation

Select this tab to manage your component's validation settings.

Permissions Icon Permissions

Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component.

Field Tag Icon Field Tags

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Shortcuts Icon Shortcuts

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

  • Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

  • Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

  • Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

  • Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

  • Enter (Return): When tabbing to a Tooltip Icon (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

  • Drop-down menus: When you Tab to a settings drop-down, use the keyboard's Up-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation Icon Documentation

Select this tab to access the component documentation in Unqork's In-Product Help.

Cancel

Click this button to undo any unsaved configuration changes and return to the canvas.

Save & Close

Click this button to save all settings as configured and return to the canvas.

Display Panel

A static image displaying the Rich Text Editor component's Display settings.
(click to expand image)

Field Text

Setting Description

Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Default State Options

Setting

Description

Disable User Input

When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.

By default, the Disable User Input toggle is set to (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to (ON) hides the component in Express View. Setting the toggle to (OFF) shows the component. The component is always visible in the Module Builder.

By default, the Hide Field toggle is set to (OFF).

Formatting

Setting

Description

Hide Toolbar in Express

When set to (ON), the Editor's toolbar is hidden from the end-user in Express View. This setting is useful when you want to display read-only content to the end-user.

By default, this toggle is set to (OFF).

Read Only Content View

When set to (ON), the Default Content field displays in the component's configuration window. Content entered in this field displays as read-only to the end-user. When set to (ON), the Reference Content feature available.

By default, this toggle is set to (OFF).

Default Content

This field offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your content.

Entering content into the editor and setting the component as read-only makes the content user-facing. If you don't set the component as read-only, the end-user has a blank content field to edit in Express View.

This setting is available when you set the Read Only Content View toggle to (ON).

Reference Content

This field lets you reference content from other components. To reference content, choose the Property ID of the referenced component and give it an alias. Then, reference that alias in the Editor. To work, you must surround your alias in curly braces. For example, {{Name}}.

Where you entered the alias, the end-user will see the referenced content.

This setting is available when you set the Read Only Content View toggle to (ON).

Data Panel

A static image displaying the Rich Text Editor component's Data settings.
(click to expand image)

Data Storage

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

  • Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.

  • Triggering a module save event using a Button component with an Action Type of Save.

  • Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

NOTE  By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to (OFF) when you don’t want to store the values from this field in the database.

NOTE  When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help.

TIP  Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

By default, the Store Data in Database toggle is set to (ON).

Validation Panel

A static image displaying the Rich Text Editor component's Validation settings.
(click to expand image)

Input Required

Setting

Description

Required

When set to (ON), the end user must enter a value in the component's visible fields. Set the toggle to (OFF) when an entry is optional.

By default, the Required toggle is set to (OFF).

Error Message

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Adding a Rich Text Editor Component

In this example, leave the content field blank for your end-user to edit. You want the end-user to enter their cover letter as part of an application process. These instructions assume that you have an open module saved with a title.

1. In the Module Builder, drag and drop a Rich Text Editor component onto your canvas.
2. In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module., enter rteCoverLetter.
3. In the Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the . field, enter Cover Letter.
4. Click Save & Close.
5. Save your module.

Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View. and you'll see the following functionality:

A static image of the configured Rich Text Editor component in Express View.

Resources