Rich Text Editor Component
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. This component lets your end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. input and format rich text content like modern word processor tools.
Additionally, the Rich Text Editor component lets you do the following:
-
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.
Supported Fonts
The Rich Text Editor component retains some font types when you copy and paste from an external source into the component in Express View Express View is how your end-user views your 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.. After pasting text into the component, confirm the font by clicking the 
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.
To learn more about the Rich Text Editor's settings, click on the links below:
Display Settings
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, Disable User Input is set to (OFF). |
|
Hide Field |
Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field 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 setting is set to (OFF). |
|
Display Content as Text |
When set to (ON), the Default Content field displays in the component's configuration window. Content entered in this field displays to the end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.. When set to (ON), the Reference Content feature available. By default, this setting 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. Text in this field does not display in the Module Builder canvas. Instead, Preview the module to see the text. This setting is available when you set the Display Content as Text 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 Display Content as Text toggle to (ON). |
Data Settings
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:
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. 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. 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 Settings
Input Required
|
Setting |
Description |
|---|---|
|
Required |
When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required 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
For this example, leave the content field blank for your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. 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. |
| 4. | Click Save Component. |
| 5. | Save your module. |
Preview your module in Express View Express View is how your end-user views your 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 to view the following functionality:
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:
-
To give your end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. a familiar tool to input and format rich text content.
-
To easily create and format rich text content in the Module Builder. Then, display that content as read-only content in Express View Express View is how your end-user views your 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..
The Rich Text Editor component lets you do the following:
-
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 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.
To learn more about the Rich Text Editor's settings, click on the links below:
Display Panel
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
|
Formatting
|
Data Panel
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:
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. 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. 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
Input Required
|
Setting |
Description |
|---|---|
|
Required |
When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required 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
For this example, leave the content field blank for your end-user to edit. You want the end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. 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. |
| 4. | Click Save & Close. |
| 5. | Save your module. |
Preview your module in Express View Express View is how your end-user views your 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. to view the following functionality:
Resources
