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. 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 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..
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 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
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 |
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 |
Select this tab to manage your component's display settings. |
Data |
Select this tab to manage your component's data settings. |
Validation |
Select this tab to manage your component's validation settings. |
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. settings of the component. |
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 Panel components. 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 |
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
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
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 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. 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. 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. 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. |
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:
Resources