batchnz/craft-ckeditor

Edit rich text content in Craft CMS using CKEditor.

1.1.2 2020-03-09 09:00 UTC

Requires

• craftcms/cms: ^3.0.0-RC15

MIT

• Pixel & Tonic
• Batch Development

• cms
• CKEditor
• html
• yii2
• craftcms

README

This plugin adds a “CKEditor” field type to Craft CMS, which provides a rich text editor powered by CKEditor 5 (Developer Preview v0.11.0).

Requirements

This plugin requires Craft CMS 3.0.0-RC15 or later.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “CKEditor”. Then click on the “Install” button in its modal window.

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require craftcms/ckeditor

# tell Craft to install the plugin
./craft install/plugin ckeditor

Configuration

HTML Purifier Configs

CKEditor fields use HTML Purifier to ensure that no malicious code makes it into its field values, to prevent XSS attacks and other vulnerabilities.

You can create custom HTML Purifier configs that will be available to your CKEditor fields. They should be created as JSON files in your config/htmlpurifier/ folder.

Use this as a starting point, which is the default config that CKEditor fields use if no custom HTML Purifier config is selected:

{
    "Attr.AllowedFrameTargets": ["_blank"],
    "Attr.EnableID": true
}

See the HTML Purifier documentation for a list of available config options.

Roadmap

You can track our progress toward the 1.0 GA release from the 1.0 project.