Download the PHP package blackbes/yii2-ckeditor-kcfinder-widget without Composer
On this page you can find all versions of the php package blackbes/yii2-ckeditor-kcfinder-widget. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yii2-ckeditor-kcfinder-widget
CKEditor Widget for Yii2
Renders a CKEditor WYSIWYG text editor plugin widget.
Installation
The preferred way to install this extension is through composer.
Either run
or add
also you need to make minimum stability to 'dev':
and add KCFinder to dependency
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:
Using inline edition with basic preset:
How to add custom plugins
This is the way to add custom plugins to the editor. Since version 2.0 we are working with the packagist version of the CKEditor library, therefore we are required to use its configuration API in order to add external plugins.
Lets add the popular Code Editor Plugin for example. This plugin would allow us to add a button to our editor's toolbar so we can add code to the content we are editing.
Assuming you have downloaded the plugin and added to the root directory of your Yii2 site. I have it this way:
+ frontend + -- web + -- pbckcode
We can now add it to our CKEditor widget. For this example I am using CKEditorInline
widget. One thing you notice on
this example is that we do not use the preset attribute; this is highly important as we want to add a customized toolbar to our
widget. No more talking, here is the code:
About extra assets
You maybe wonder why there is file dosamigos-ckeditor.widget.js
. The reason is that due to the way Yii2 works with
forms and Cross-Site Request Forgery (csrf). CKEditor does not trigger the on change event nor collects the CSRF token
when using file uploads.
The asset tackles both issues.
Testing
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):
Once all required libraries are installed then do:
Further Information
Please, check the CKEditor plugin site documentation for further information about its configuration options.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The BSD License (BSD). Please see License File for more information.