Rich Text Editor Component

IMPORTANT: Select component plug-ins are experiencing issues due to a recent browser update. If you encounter any problems with previously functional component plug-ins, please create a support case. If you notice other component plug-ins that are not functioning correctly, please create additional support cases for each instance.

Overview

Starting in 24.2, the Styled Text Editor Component is available directly in the product. Consider using this in place of the plug-in moving forward. For more information, review: https://docs.appian.com/suite/help/latest/Styled_Text_Editor_Component.html

  • Displays a field that allows for users to type text and format it with a variety of style options.
  • Output is saved as HTML. To get the raw character output, designers can use the Appian function fn!stripHtml() on the output.
  • HTML output can be passed into Send E-Mail node or document generation smart services. Note that not all formats supported by the Rich Text Editor component may be supported by e-mail or document generation.
  • Allows uploading of images which get stored in the specified Appian folder (requires separate install of the Rich Text Editor Connected System Plugin from https://community.appian.com/b/appmarket/posts/rich-text-editor-image-upload-connected-system).

Visit https://community.appian.com/w/the-appian-playbook/1378/end-user-rich-text-editor-component for more information. If you have any problems installing or using the component, please see the https://community.appian.com/w/the-appian-playbook/1603/rich-text-editor-component-plug-in-troubleshooting-guide

Key Features & Functionality

  • Component: fn!richTextField()
  • Allows for size validation
  • Allows for adjustable height
  • Allows for read-only / editable view
  • Supported font formats: "header", "size", "bold", "italic", "underline", "strike", "color", "background", "link", "align", "indent", "list"
  • Designer control over the allowed formats

Supported Browsers: Chrome, Firefox, Edge, Safari
Supported on Mobile

Anonymous
  • I have tried to downoad/install it again in our on-premise environment and the result is the same :

    2022-05-16 09:07:40,128 [Appian Plugin Hot Deploy] INFO  com.appiancorp.plugins.osgi.LoggingPluginFactoryDecorator - Plug-in Artifact 'rich-text-editor-1.8.2.zip' SHA256 hash is 34a81125cf62e3276cc32caf1de624baef6eaa832144f760807f679c2737a2cc
    2022-05-16 09:07:40,216 [Appian Plugin Hot Deploy] ERROR com.appiancorp.plugins.LoggingPluginEventListener - Failed to load Plug-in 'com.appian.richtext' (com.appian.richtext) version 0.0: 'Component plug-in approval verification failed. Please contact Appian for approval process'

  • I downloaded the 1.8.2 version from this site. In the log file it says "Plug-in Artifact 'rich-text-editor-1.8.2.zip"

  • I just tried with the latest zip from the App Market and was able to install without problems.  It's odd that the message says "version 0.0".  Are you using the zip from the App Market or somewhere else?  I recommend downloading the latest version 1.8.2 from the App Market and trying again.  If you continue to have problems, please let me know and we can have the App Market team double-check that the zip is properly approved.

  • Hello,

    We have the following error in the logs when deploying the plugin :

    2022-05-13 08:50:35,717 [Appian Plugin Hot Deploy] INFO  com.appiancorp.plugins.osgi.LoggingPluginFactoryDecorator - Plug-in Artifact 'rich-text-editor-1.8.2.zip' SHA256 hash is 34a81125cf62e3276cc32caf1de624baef6eaa832144f760807f679c2737a2cc
    2022-05-13 08:50:35,768 [Appian Plugin Hot Deploy] ERROR com.appiancorp.plugins.LoggingPluginEventListener - Failed to load Plug-in 'com.appian.richtext' (com.appian.richtext) version 0.0: 'Component plug-in approval verification failed. Please contact Appian for approval process'

  • v1.8.2 Release Notes
    • Better background colors based on read-only-ness
  • You can use stripwith and striphtml to remove the HTML tags and spaces and check if there's any actual content.

    For example, this will return false to indicate the local!data does not contain any actual content: 

    a!localVariables(
    local!data: "<div> </div>",
    local!content: stripwith(
    striphtml(local!data), char(10)&char(32)),
    a!isNotNullOrEmpty(local!content)
    )

    But this will return true to indicate there is actual text there:

    a!localVariables(
    local!data: "<div>Some actual content </div>",
    local!content: stripwith(
    striphtml(local!data), char(10)&char(32)),
    a!isNotNullOrEmpty(local!content)
    )
  • How can we remove extra spaces if added in rich text editor. We use a form layout and have this component. Even if no value is added by default it gets saved as "<div> </div>". If a user in UI just presses the space bar and enter and then space bars then also it is getting saved. We want to save the value only when there is a valid text value. We save it in rule input which is of type "text". Appian Version used in 21.1

  • Hi Do we have this fixed in new version?

  • The maxSize is to validate the length of text you actually store in the database, due to your database column limitation.  If your DB column is VARCHAR(100), you can only store 100 characters, including HTML tags.

    The reason for progress bar was to avoid confusion since the actual character count is always larger than the number of visible characters due to HTML tags.

    If you want to validate to 100 non-HTML characters, just hide the progress bar and use striphtml() to calculate how many visible characters are in the field.  However, keep in mind that what's written to the database is generally much larger than the number of visible characters, so we'd always recommend setting maxSize = the size of your DB column, to avoid errors in the write to DB.