Rich Text Editor Component

Overview

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).

Visit End-User Rich Text Editor Component for more information.

If you have any problems installing or using the component, please see the 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
Parents
  • v1.1.0 Release Notes
    Big new release! The Rich Text Editor now supports image uploading. To enable this new capability, please deploy both the updated Component Plug-in (zip) and the new Connected System Plugin (jar) files. Then create a new Connected System using the provided Rich Text Editor Connected System template. You will also need a folder where users have access to upload images. Then in a!richTextField(), set allowImages to true and pass your connected system and folder.
  • Does this release update to slowness of rendering rich text editor compare to oob sail component

  • Sorry, no.  We're working with Engineering to see what, if anything, can be done to speed up the loading of the component.  

    For the curious, Appian loads pretty much all of its static files (JS, CSS, etc) when you first log-in, so no additional downloads need to happen as you load new pages and SAIL UIs.  However, component plug-ins are different and their content gets loaded only when they are rendered.  Unfortunately since they are sandboxed, if you have multiple on the page then their content each has to get loaded again, once for each instance of the component.  We're looking into ways to streamline the number of separate static files in the component and also add more caching to the product to reduce the time to load the component..

Comment
  • Sorry, no.  We're working with Engineering to see what, if anything, can be done to speed up the loading of the component.  

    For the curious, Appian loads pretty much all of its static files (JS, CSS, etc) when you first log-in, so no additional downloads need to happen as you load new pages and SAIL UIs.  However, component plug-ins are different and their content gets loaded only when they are rendered.  Unfortunately since they are sandboxed, if you have multiple on the page then their content each has to get loaded again, once for each instance of the component.  We're looking into ways to streamline the number of separate static files in the component and also add more caching to the product to reduce the time to load the component..

Children
No Data