Rich Text Editor Component

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
  • Can you give an example of "noise" that isn't stripped today? Either an HTML tag or attribute.

    We don't use a library for this, but the underlying component should only allow a specific whitelist of tags and attributes which match the same ones that can be applied manually, using the buttons/keyboard shortcuts of the component.

  • Hi team, are there any plans to update the summernote editor to include a summernote cleaner plugin to handle additional HTML "noise" copy and pasted text from external sources like MS Word? Something similar to https://www.jsdelivr.com/package/npm/summernote-cleaner.

  • v1.16.0 Release Notes
    • Allow file:// protocol for summernote links
  • v1.15.1 Release Notes
    • Long requested release -- Summernote (richTextFieldWithTables) finally supports images!!
    • Quill (richTextField) no longer has any functionality that Summernote does not have!!
    • We thoroughly encourage all users to:
    • 1 - Use the OOTB a!styledTextEditorField for all use cases it supports
    • 2 - Use fn!richTextFieldWithTables for all other use cases
    • 3 - Avoid fn!richTextField other than for backwards compatibility requirements, as it will no longer be maintained
  • Can you please add a feature to upload a document (PDF, Excel, any file type) instead of just an image file? Provide an additional parameter to pass the file extension type. No preview required, only a preview will be available for image

  • v1.15.0 Release Notes
    • Long requested release -- Summernote (richTextFieldWithTables) finally supports images!!
    • Quill (richTextField) no longer has any functionality that Summernote does not have!!
    • We thoroughly encourage all users to:
    • Use the OOTB a!styledTextEditorField for all use cases it supports
    • Use fn!richTextFieldWithTables for all other use cases
    • Avoid fn!richTextField other than for backwards compatibility requirements, as it will no longer be maintained
  • v1.14.0 Release Notes
    • Add superscript and subscript to `richTextEditorField`

  • Hi Team,

    Our application is setup on split DNS. When connected through VPN, it redirects via Load balancer, whereas, if it's not with VPN, it redirects via cloudflare. When connected to VPN there is no issues. When it's routed via cloudflare Rich Text editor is not visible, as the domain example-static.com & example-dynamic.com cannot be configured in cloudflare. Is there any way to access statis & dynamic contests without static & dynamic URLs

    We have also tested with style text component. We noticed that some features available in Rich text plugin was not available here. So it would not be possible to implement this solution

    Regards,

    Ferosha

  • v1.13.2 Release Notes
    • Updated Summernote to 0.9.1
  • v1.13.1 Release Notes
    • Fixed an issue with pasting from Word.