New Feature

This feature is enhanced in Joget DX to manage permission who can access any uploaded files

Introduction

Rich Text Editor offers the interface for editing the rich text  within web browsers, which presents the user with a "what-you-see-is-what-you-get" (WYSIWYG) editing area.

The Rich Text Editor is only available on Professional and Enterprise  Edition.

Get Started

The easiest way to see how the Rich Text Editor works are to use the existing built-in App Expenses Claims. Here are the steps:

  1. Start the Joget Server and open the App Center.

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the App Composer. (see Figure 1)


    Figure 1

  3. Click on the  Create New Form  button and fill up the Form Details as follows (see Figure 2):
    1. Form ID: richTextEditor
    2. Form Name:  Rich Text Editor
    3. Table Name: j_expense_claim


    Figure 2

  4. Drag and drop a Rich Text Editor element on to the canvas.

  5. Fill up the Configure Rich Text Editor  properties as follows and click on Next :
      1. Label: Message
      2. ID: message

  6. Click on Advanced Options, tick on Full Features Toolbar? and click the Apply Change button. (see Figure 3)


    Figure 3

  7. Click on Preview.

Rich Text Editor Properties

Configure Rich Text Editor

NameDescription
LabelElement Label to be displayed to the end-user.
ID

Element ID (By declaring as "message", a corresponding database table column "c_message" will be created)

Please see Form Element for more information about defining the ID and list of reserved IDs.

Editor

Type of the editor:

  • TinyMCE

Retrieving value inside TinyMCE editor using JavaScript.

  • Quill

Mode

Toolbar features:

  • Simple

  • Full

  • Inline Edit (Available for Quill Editor Only)

Enable Switch Between Inline Edit

Available for Quill Editor Only

Display as a checkbox if the Mode is Full and Simple

Display as Multi Select Box if the Mode is Inline Edit

Example:

PlaceholderThe placeholder attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the input field before the user enters a value.


Advanced Options

Data

NameDescription
Value Default Value
Validator

Attach a Validator plugin to validate the input value. Please see Form Validator.

When will validation takes place?

Validation will take place whenever a form is submitted except when it is submitted as "Save as Draft".

Available options:

  • Basic
  • BeanShell
  • Date and Time Duplicate Validator
  • Directory
  • Duplicate Value
  • Equal Value
  • Multi Form Validator
  • Password
  • Plugin Template - Validator

UI

NameDescription
Readonly

Determines if the element is editable.

Height (px)Defines the height of the Rich Text Editor.
Custom Settings (JSON)

Refer to https://www.tiny.cloud/docs/configure/editor-appearance/#style_formats for more TinyMCE Editor customization

Refer to https://quilljs.com/docs/modules/toolbar for more Quill Editor customization

Image Upload

NameDescription
Permission

 Manage on who is able to access the file uploaded. Read more at Permission Control.

  • Logged In Users
  • Public
  • Custom


Related Tutorials


  • No labels