Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
English
Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature

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

Table of Contents

Introduction

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

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

...

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 and open the  App Center.

  2. Log in as admin and click on the pencil icon on the  Expenses Claim to open the  Design App Composer. (see Figure 1)
    Image Removed
    Image Added
    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
    Image Removed
    Image Added
    Figure 2

  4. Drag and drop a Rich Text Editor element on on to the canvas.
    Hover the mouse over the Rich Text Editor  element on the canvas and click on Edit to open up the Edit Rich Text Editor properties.

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

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

  7. Click on Preview.

Rich Text Editor Properties

...

Configure Rich Text Editor

Image RemovedImage Added

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

Image Added

Retrieving value inside TinyMCE editor using JavaScript.

  • Quill

Image Added

Mode

Toolbar features:

  • Simple

Image Added

  • Full

Image Added

  • Inline Edit (Available for Quill Editor Only)

Image Added

Enable Switch Between Inline Edit

Available for Quill Editor Only

Display as a checkbox if the Mode is Full and Simple

Image Added

Display as Multi Select Box if the Mode is Inline Edit

Image Added

Example:

Image Added

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 valueLabel Element Label to be displayed to the end-user.


Advanced Options

Data

Image RemovedImage Added

NameDescription
Value Default Value
Validator

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

Info
titleWhen 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

Image RemovedImage Added

NameDescription
Readonly

Determines if the element is editable.

Full Features Toolbar?Show full features toolbar when checked

.


Image Removed

Height (px)Defines the height of the rich text editor.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

Image RemovedImage Added

Newly introduced in Joget DX

  • Logged In Users
  • Public
  • Custom
NameDescription
Permission

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

Info
titleNew Feature


Related Tutorials

Sample App

View file
nameAPP_kb_dx8_richTextEditor.jwa
height250