Development Status
Work In Progress
Active Installs
Maintainers
Download

Last updated: 2022-08-03

Works with CiviCRM 5.35 or higher.

summernote

This extension is utilizing Summernote which is a (relatively) new lightweight (js+css: ~100Kb) WYSIWYG editor library, available as a drop-in replacement for CKEDitor4/5 in CiviCRM.

The editor, along with the use of the powerful elFinder plugin gives an all around solution to the needs of a user.

The extension is licensed under AGPL-3.0.

Features

  • Lightweight (js+css: ~100kb)
  • Lite, Bootstrap4, Bootstrap5 modes included
  • Drop-in replacement for CKEditor4/5
  • Uses elFinder (via the elFinder plugin)
  • 2 different toolbars available (minimal/standard)
  • i18n support (multilingual)
  • Removes the unnecessary and possibly layout breaking Crud that gets added by MSWord, Open Office, and Libre Office Documents (via the summernote-cleaner plugin)

Requirements

  • PHP v7.2+
  • CiviCRM 5.35+

Getting Started

  • Install the extension as usual. Both libraries of summernote and elfinder are being shipped with the extension itself so you won't be needing to download anything extras.
  • Navigate to Administer / Customize Data and Screens / Display Preferences and on the field Wysiwig Editor, pickup Summernote .
  • (Optional) Navigate to Administer > Customize Data and Screens > Summernote and select the toolbar configuration that you would like and also the skin to use. If no configuration is being specified, Summernote will work with the standard toolbar and lite mode.

The Summernote WYSIWYG editor extension comes with 3 plugins already activated by default:

  • elFinder - A worthy replacement of the outdated kcfinder to upload your files/images
  • specialchars - A plugin that adds a button in the toolbar and allows the end-user to insert special characters.
  • cleaner - removes the unnecessary and possibly layout breaking Crud that gets added by MSWord, Open Office, and Libre Office Documents when pasting content.

All the summernote plugins used are slightly modified to be able to work with the CiviCRM ecosystem. The modification involves adding a line of code on the button function.

Configuration options

Minimal

  • Paragraph styles
  • Font: Bold, Italic, Underline, Clear
  • Color: Background/foreground
  • Paragraph: ul, ol, paragraph
  • Table
  • Insert link
  • Insert special symbol
  • View: Fullscreen, codeview, help
  • Insert: ElFinder (plugin)
  • Cleanup: Code cleanup when pasting from word/excel

Default/Standard

  • Paragraph styles
  • Font: Bold, Italic, Underline, Strikethrough, Superscript, Subscript, Clear
  • Font name selection
  • Color: Background/foreground
  • Paragraph: ul, ol, paragraph
  • Table
  • Insert link
  • Insert special symbol
  • View: Fullscreen, codeview, Undo, Redo, help
  • Insert: ElFinder (plugin)
  • Cleanup: Code cleanup when pasting from word/excel

Known Issues

None yet

Credits

Many thanks to everyone involved on creating the ckeditor5 & ckeditor5-extras extensions. This extension's code relied heavily on the work done on both of them.

Disclaimer

This is still a work-in-progress extension.

Support and Maintenance

This extension is supported and maintained by:

iXiam Global Solutions

Distributed under the terms of the GNU Affero General public license (AGPL).

Screenshot (click to enlarge)