CKEditor widget for Yii2.
Renders a CKEditor WYSIWYG text editor plugin widget.
The preferred way to install this extension is through composer.
composer require 2amigos/yii2-ckeditor-widget:~1.0
"2amigos/yii2-ckeditor-widget" : "~1.0"
to the require section of your application's
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
clientOptions attribute accordingly.
The library comes with two widgets:
CKEditorInline. One is for classic edition and the other for inline
Using a model with a basic preset:
use dosamigos\ckeditor\CKEditor; <?= $form->field($model, 'text')->widget(CKEditor::className(), [ 'options' => ['rows' => 6], 'preset' => 'basic' ]) ?>
Using inline edition with basic preset:
use dosamigos\ckeditor\CKEditorInline; <?php CKEditorInline::begin(['preset' => 'basic']);?> This text can be edited now :) <?php CKEditorInline::end();?>
To test the extension, is better to clone this repository on your computer. After, go to the extensions folder and do
the following (assuming you have
composer installed on your computer):
$ composer install --no-interaction --prefer-source --dev
Once all required libraries are installed then do:
Please, check the CKEditor plugin site documentation for further information about its configuration options.
Please see CONTRIBUTING for details.
The BSD License (BSD). Please see License File for more information.
Web development has never been so fun!