Rich Text
by Appian Corporation
Description
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
Features
- 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
Release notes
a11y: replace role=img with visually-hidden text markers for diff blocks
Version history (47)
1.20.0
Support for <ins> and <del> tags
1.19.0
Copy/paste enhancements for summernote. Aria labels and descriptions.
1.19.0
Copy/paste enhancements for summernote. Aria labels and descriptions.
1.17.2
Bug fix regarding superscript and subscript
1.17.1
Bug fix regarding the insert table dropdown menu
1.17.0
Minor enhancements to spacing and sizing
1.16.0
Allow file:// protocol for summernote links
1.15.1
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
1.15.0
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
1.14.0
Add superscript and subscript to richTextEditorField
1.13.2
Updated Summernote to 0.9.1
1.13.1
Fixed an issue with pasting from Word.
1.13.0
Added superscript and subscript.
1.12.3
Fixed an issue with the field refreshing while user is typing.
1.12.2
Fixed an issue with the field refreshing while user is typing.
1.12.1
Fixed the insertable items issue
1.12.0
New output parameter called uploadedImages which outputs metadata about the images uploaded during the user's session.
1.11.3
Updated to improve accessibility.
- Set aria-expanded="false" as the default for buttons that expand to a menu.
- Set aria-label="formatting options" on the toolbar to announce the purpose of the toolbar for screen readers.
- Removed aria-hidden="true" from the close button on the link dialog to comply with the Fourth Rule of ARIA Use (https://www.w3.org/TR/using-aria/#fourth).
- Updated the keyboard focus indicator on the color palette menu to increase the color contrast.
1.11.1
Upgraded the bootstrap version.
Images uploaded will now use the Opaque URL for documents, introduced in 20.3 - https://docs.appian.com/suite/help/22.4/Opaque_URL_Guidance.html. This change requires the usage of a version of the companion Connected System plugin that also relies on Opaque URLs.
1.10.2
Upgraded bootstrap and jquery version
1.10.1
Upgraded the bootstrap version
1.9.1
Fixes issue reported in https://community.appian.com/b/appmarket/posts/rich-text-editor from scottl189 about not being able to click into the component except at the top
1.9.0
Added designer-configured insertable items
1.8.3
Accessibility: allow tabbing through buttons
1.8.2
Better background colors based on read-only-ness
1.8.1
IE support
1.8.0
- Added aria labels for fn!richTextField()
- Enabled mailto links for fn!richTextFieldWithTables()
1.7.0
Support for French language, custom CSS files for richTextFieldWithTables
1.6.1
Allowing HTML links with a protocol to open in another application (CS request)
1.6.0
Minor update to the inline docs & to auto-width table columns when the component is readOnly
1.5.3
New component to support tables
1.4.0
Does not set validations on initial load when readOnly or disabled (this was previously triggering a SAIL re-evaluation).
1.3.1
--- v1.3.1 release notes --- Image support for Internet Explorer 11 browser
--- v1.3.0 release notes --- Automatically saving input text into html format on load.
--- v1.2.1 release notes --- Fixing small bug when submitting quickly after typing
--- v1.2.0 release notes --- Fixing small bug when navigating away quickly after typing
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.3.0
--- v1.3.0 release notes --- Automatically saving input text into html format on load.
--- v1.2.1 release notes --- Fixing small bug when submitting quickly after typing
--- v1.2.0 release notes --- Fixing small bug when navigating away quickly after typing
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.2.1
April - resubmitting 1.2.1 due to admin console not syncing
--- v1.2.1 release notes --- Fixing small bug when submitting quickly after typing
--- v1.2.0 release notes --- Fixing small bug when navigating away quickly after typing
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.2.1
--- v1.2.1 release notes --- Fixing small bug when submitting quickly after typing
--- v1.2.0 release notes --- Fixing small bug when navigating away quickly after typing
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.2.0
--- v1.2.0 release notes --- Fixing small bug when navigating away quickly after typing
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.1.0
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.1.0
--- 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.
Credit and a huge thanks to Wesley Jones who designed and wrote most of the Image Upload code.
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.15
--- v1.0.14 release notes ---- Implements Javascript Debounce to perform a saveValue operation if there is a break in user typing for 0.5 seconds
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.14
--- v1.0.14 release notes ---- Bug fix for IE 11 support
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.13
---- v1.0.13 release notes ---- Update keyboard shortcuts to use Cmd for Mac
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.12
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.12
---- v1.0.12 release notes ---- Fixes nested list issues Supports keyboard shortcuts for indenting and lists
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version
1.0.11
---- v1.0.11 release notes ---- Fixes rendering bug with IE11
---- v1.0.10 release notes ---- Improved styling when printing web pages All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version.
1.0.10
Improved styling when printing web pages Improved styling under IE11 All styles are in-lined for better email support (no more classnames) Fixes disappearing line breaks bug Problems rendering on some Samsung devices has been fixed in latest Appian Mobile App version.
1.0.9
Adds mobile support (note: some Samsung devices don't initially show Component Plugins until the screen is rotated. This framework issue is being investigated by Appian).