README

The implementation of the Froala Editor (license not included) for Craft CMS

Known issue (help wanted!)

Adding links to Craft Entries causing issues when you double click on the entry to link to. Just click once and use the "Select" button.

Sorry for the inconvience. We're working on these annoying issues. But we decided to release a new version because of some missing important other features (like saving links the Craft way).

Installation

Chose one of the options to install

Composer installation

It is possible to install the plugin for Craft 2. Craft is not yet working with composer. It uses the composer installers package to move the package to craft/plugins/ folder.

composer require froala/craft-froala-editor

After requiring the plugin package, it is moved to craft/plugins/. You still need to go to the Craft Plugins page to install and enable it.

Note: it doesn't use Froala Editor sources from composer yet. This will be there for the Craft 3 version of course.

Manual installation

Download the zip at the top right
Extract the files from the zip file
Rename the folder to "froalaeditor"
Copy the froalaeditor/ folder to your craft/plugins/ folder
Login the control panel of your Craft installation and navigate to Settings > Plugins
Hit "install" and the plugin will be installed.

To enable the editor correctly, you should have a purchased a license on www.froala.com.

Once you have a license, for your domain, you can enter the license key in the plugin settings.

Features

Ability to set your license key in plugin settings
Ability to disable/enable editor plugins via settings
Creating fields defined as Richtext Froala Editor
Ability to change enabled plugins per field (inherit from generic plugin settings)
Configuration of Craft Asset sources for image/file uploads
Configuration of custom CSS file to be loaded relative from the site or from a plugin resource