Skip to main content

Rich Text Editor

The Rich Text Editor is used to capture Rich Text input from a user. The input is captured in HTML format.

How to use Rich Text Editor Widget

Properties

Properties allow you to edit the widget, connect it with other widgets and customize the user actions.

Widget Properties

These properties allow you to edit the Rich text Editor widget. All these properties are present in the property pane of the widget. The following table lists all the widget properties.

PropertyDescription
Input TypeSets the input type of the default text property in the widget.
Default TextThis property sets the default text of the Rich Text Editor.
RequiredMakes input to the widget mandatory.
VisibleControls widget's visibility on the page. When turned off, the widget will not be visible when the app is published
DisableDisables input to the widget. The widget will remain visible to the user but a user input will not be allowed.
Animate LoadingControls the loading of the widget.
Hide toolbarControls the visibility of the toolbar
HeightIt configures how a widget’s height reacts to content changes. It has three possible configurations:
Fixed: The height of the widget remains as set using drag and resize.
Auto Height: The height of the widget reacts to content changes.
Auto Height with limits: Same as Auto height, with a configurable option to set the minimum and maximum number of rows that can be occupied by the widget.

Let's understand the widget properties in detail:

Input Type

As the name suggests, input type allows you to set the type of text you want in the input box, HTML, or Markdown format. It sets the input type of the default text property in the widget.

The input box will show an error if the entered data does not match the input type. For example, If you select the input type as HTML, you won't be able to display Markdown text.

Default text

This property lets you set a default value for the widget before the user has made any changes.

Once you have selected an input type, you can add markdown/HTML text in the default text section. For example, if you want to use the markdown input type. You can either use the default text property or use an input widget to display the text. The video below demonstrates how to use the markdown input type.

Default text
Markdown: 

### Markdown
##### only works in Markdown RTE

---
HTML:

<h3> HTML
<ul>
<li>HTML works in both RTEs</li>
</ul>

<ul>
<li>Item 1
<ul>
<li>Sub-item 1</li>
<li>Sub-item 2</li>
</ul>
</li>

Binding Properties

These properties help you share values between widgets and also allow you to easily access the widget property within Queries or JS functions.

PropertyDescriptionCode Snippet
isDisabledThis property indicates whether the widget is disabled or not.{{RichTextEditor1.isDisabled}}
isVisibleThis property indicates whether the widget is visible or not.{{RichTextEditor1.isVisible}}
textIt fetches the value that the user has entered.{{RichTextEditor1.text}}

Events

They are a set of actions that you can perform on the widget.

EventsDescription
onTextChangeSets the action to be run when the user inputs text. See a list of supported actions

Label

The property hosts a group of configurations that you can use to associate a display name and define a placement for the widget. These properties are usually useful when you want to design forms that follow a defined alignment for your form fields and give a professional look to your forms. Below are the properties that you can use:

LabelDescription
TextSets the label text of the widget.
PositionSets the label position of the widget.
AlignmentSets the label alignment of the widget.
WidthSets the label width of the widget as the number of columns.
Label Text ColorAllows you to set text color for the label.
Label Text SizeAllows you to set the size of the label.
Label Font StyleAllows you to choose a font style, i.e., bold or italic.

Text

It allows you to set the display name for the Rich Text Editor. For example, if you want the user to write a cover letter, you can enter the text as "Cover Letter."

tip

You can leave the text empty if you don't want any display name for your Rich Text Editor widget.

Position

It allows you to specify the placement of the label. You can select one of the available options:

  • Top - It allows you to align the text at the top of the Rich Text Editor.
  • Left - It aligns the text to the left of the Rich Text Editor. When you select Left alignment, you get additional settings that you can use to control the alignment and define the text's width.
    • Alignment - With the help of alignment, you can define the placement of the text in accordance with the position of the Rich Text Editor. You can choose:
      • Left - It aligns the text to the widget's left boundary that is away from the Rich Text Editor.
      • Right - It aligns the text closer to the Rich Text Editor.
    • Width - With the help of width, you can define the number of columns in the grid that surrounds the widget. You can specify how close or far the text can be placed to the Rich Text Editor.
  • Auto - It automatically adjusts the position of the text based on the Rich Text Editor's height.
info

Columns are the dashed lines (-----) that surround a widget when you try to drag and drop it on the canvas.

How to set the label properties? {% endembed %}

How to set the label properties?

Styles

Style properties allow you to change the look and feel of the widget.

StyleDescription
Border RadiusAllows you to define curved corners.
Box ShadowAllows you to choose from the available shadow styles.