README

Renders a CKEditor WYSIWYG text editor plugin widget.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require "skeeks/yii2-ckeditor" "*"

or add

"skeeks/yii2-ckeditor" : "*"

to the require section of your application's composer.json file.

Skins & Plugins

This widget works with default's dev-full/stable branch of CKEditor, with a set of plugins and skins. If you wish to configure a different skins or plugins that the one proposed, you will have to download them separately and configure the widget's clientOptions attribute accordingly.

Usage

The library comes with two widgets: CKEditor and CKEditorInline. One is for classic edition and the other for inline editing respectively.

Using a model with a basic preset:

use skeeks\yii2\ckeditor\CKEditorWidget;
use skeeks\yii2\ckeditor\CKEditorPresets;

<?= $form->field($model, 'text')->widget(CKEditorWidget::className(), [
	'preset' => CKEditorPresets::BASIC
]) ?>

<?= $form->field($model, 'text')->widget(CKEditorWidget::className(), [
	'options' => ['rows' => 6],
	'preset' => CKEditorPresets::FULL
]) ?>

<?= $form->field($model, 'description_short')->widget(
	\skeeks\cms\widgets\formInputs\ckeditor\Ckeditor::className(),
	[
		'preset' => \skeeks\yii2\ckeditor\CKEditorPresets::CLEAN,
		'clientOptions' =>
		[
			'height' => 200,
			'extraPlugins'    	=> 'ckwebspeech,sourcedialog,codemirror,ajax,codesnippet,xml,widget,lineutils,dialog,dialogui',
			'toolbarGroups' => [
				['name' => 'undo'],
				['name' => 'basicstyles', 'groups' => ['basicstyles', 'cleanup']],
				['name' => 'colors'],
				['name' => 'links', 'groups' => ['links']],
				['name' => 'others','groups' => ['others', 'about']],
			],
			'removeButtons' => 'Subscript,Superscript,Flash,Table,HorizontalRule,Smiley,SpecialChar,PageBreak,Iframe',
			'removePlugins' => 'elementspath',
			'resize_enabled' => true
		]
	]
); ?>

Further Information

Please, check the CKEditor plugin site documentation for further information about its configuration options.

SkeekS CMS (Yii2) — fast, simple, effective!
skeeks.com | cms.skeeks.com