# RichText Editor

## Look\&Feel Settings

**Label** (not mandatory) to be used to show the component's label.

**Default value** (not mandatory) default text to be populated when the component is created.

**Placeholder** (not mandatory) to be used to show the component's placeholder.

**Name** (mandatory) - name of the component.

**Tooltip** (not mandatory) - tooltip of the component.

**Step** (not mandatory) - selection step value.

**Required** (mandatory) - marks if the selection required or not. Is set to false by default.

**Disabled** (mandatory) - makes the component disabled if turned on. Is turned off by default.

**Visible** (mandatory) - makes the component visible if turned on. Enabled by default.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FEYCjSVzXVYsywNXd4qx7%2FLook_n_feel.jpg?alt=media\&token=4528aeb3-6dca-4e56-8208-afca218c0157)

## Workflow triggers

* **onChange** - fires when the dropdown option is changed.
* **onFocus** - fires when the component is being focused on.
* **onBlur** - fires when the component is blurred.
* **onCreate -** fires when the component is created.
* **onShow** - fires when the component is shown.
* **onHide** - fires when the component is hidden.
* **onDestroy** - fires when the component is destroyed.

## Component Actions

### Richtext Get Properties

Gets the component's properties.

**Input** parameters:

* **Component Id** \[*string*] *-* component's identifier;

**Output** parameters:

* **Label** \[*string*] - component's label;
* **Placeholder** \[*string*] - component's placeholder;
* **Disabled** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - defines if the component is visible or not;
* **Tooltip** \[*string*] - tooltip string;
* **Required Mark** \[*boolean*] - shows required mark if *true*;
* **Debounce** **(ms)** \[*integer*] - delay to validate the value;
* **Value** \[*html formatted page*] - html formatted page based on the input data from Richtext editor;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 
* **Validate Message** \[*string*] - message to be shown on validate the value;

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FBit1vYlbRX242jQ0HmYz%2Frichtext_get_properties.jpg?alt=media\&token=8a879045-eafd-4406-b2e1-171ffe3d6b0c)

### Richtext Set Properties

Sets the component's properties.

**Input** parameters:

* **Component Id** \[*string*] *-* component's identifier;
* **Label** \[*string*] - component's label;
* **Placeholder** \[*string*] - component's placeholder;
* **Disabled** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - defines if the component is visible or not;
* **Tooltip** \[*string*] - tooltip string;
* **Required Mark** \[*boolean*] - shows required mark if *true*;
* **Debounce** **(ms)** \[*integer*] - delay to validate the value;
* **Value** \[*html formatted page*] - html formatted page based on the input data from Richtext editor;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FeUw5dehZWhAG7yzXJ1uN%2Frichtext_set_properties.jpg?alt=media\&token=d43aca18-a96e-4f0f-951a-486a57fe5446)

### Richtext Update Properties

Updates component's properties.

**Input** parameters:

* **Component Id** \[*string*] *-* component's identifier;
* **Label** \[*string*] - component's label;
* **Placeholder** \[*string*] - component's placeholder;
* **Disabled** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - defines if the component is visible or not;
* **Tooltip** \[*string*] - tooltip string;
* **Required Mark** \[*boolean*] - shows required mark if *true*;
* **Debounce** **(ms)** \[*integer*] - delay to validate the value;
* **Value** \[*html formatted page*] - html formatted page based on the input data from Richtext editor;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FTyfkAmxIOKKXINRXSlag%2Frichtext_update_properties.jpg?alt=media\&token=9bedcc30-fb10-4b82-9089-d62693a2a81d)

## Usage example

To update the text value in the Richtext editor - html formatted text has to be provided as one of the component's input properties. **To HTML** block has to be used for this purpose.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2F2emtbFJpZVvbHeXTG6Ch%2Fexample_1.jpg?alt=media\&token=ffe748d9-7ca1-4d5c-85ab-d22580b5e5c2)

Input value can be set on the Richtext editor component when it is specified and converted into HTML.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FcZvtEvABy6VNRmc9rfc2%2Fexample_2.jpg?alt=media\&token=fc01af70-fc64-47d8-8536-4cee1ca4ae6f)