gfrodriguez/yii2-ckeditor

There is no license information available for the latest version (1.0.0) of this package.

Yii2 CKEditor

Installs: 7

Dependents: 0

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:JavaScript

Type:yii2-extension

1.0.0 2018-10-04 04:20 UTC

README

This is a fork MihailDev/yii2-ckeditor and sadovojav/yii2-ckeditor

Features:

  • The ability to add custom plugins
  • Initialisation editor on event
  • Added custom plugins

Plugins:

Composer

The preferred way to install this extension is through Composer.

Either run php composer.phar require gfrodriguez/yii2-ckeditor "dev-master"

or add "gfrodriguez/yii2-ckeditor": "dev-master" to the require section of your composer.json

Use

  • Widget
use gfrodriguez\ckeditor\CKEditor;

echo CKEditor::widget();
  • ActiveForm
use gfrodriguez\ckeditor\CKEditor;

echo $form->field($post, 'text_full')->widget(CKEditor::className());

Parameters

  • array editorOptions - CKeditor options
  • array containerOptions - Container options
  • array extraPlugins - Extra plugins connection
  • string initOnEvent = false - Event type for initialization
Example
echo $form->field($post, 'text_full')->widget(CKEditor::className(), [
    'extraPlugins' => [
        ['test', '@root/uploads/plugins/test-plugin/', 'plugin.js']
    ],
    'editorOptions' => [
        'toolbar' => [
			['Preview', 'Viewss'],
			['Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Undo', 'Redo'],
			['Find', 'Replace', '-', 'SelectAll', '-', 'Scayt'],
			['Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', 'TextColor', 'BGColor', '-', 'RemoveFormat'],
			['NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock'],
			['Image', 'Table', 'SpecialChar', 'Mathjax'],// 'Footnotes'],
			['Styles', 'Format'],
			['Maximize', 'ShowBlocks'],
			['About'],
        ],
        'allowedContent' => true,
        'forcePasteAsPlainText' => true,
        'extraPlugins' => 'test,image2,widget,oembed,video',
        'language' => Yii::$app->language,
        'height' => 500,
		'mathJaxLib' => '//cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS_HTML',
        'disableNativeSpellChecker' => false,
        'scayt_sLang' => Yii::$app->language,
        'removePlugins' => 'scayt,wsc',
        'disableNativeSpellChecker' => false,
        'qtRows' => 8, // Count of rows in the quicktable (default: 8)
        'qtColumns' => 10, // Count of columns in the quicktable (default: 10)
        'qtBorder' => '1', // Border of the inserted table (default: '1')
        'qtWidth' => '90%', // Width of the inserted table (default: '500px')
        'qtCellPadding' => '0', // Cell padding of the inserted table (default: '1')
        'qtCellSpacing' => '0', // Cell spacing of the inserted table (default: '1')
        'qtPreviewSize' => '14px', // Cell size of the preview table (default: '14px')
        'qtPreviewBackground' => '#c8def4' // Cell background of the preview table on hover (default: '#e5e5e5')
    ],
]);

Initialisation editor on event

'initOnEvent' => 'focus' //dblclick, mouseover, etc.

Use extra plugins

  1. Add extra plugin connection information
'extraPlugins' => [
    ['test', '@root/uploads/plugins/test-plugin/', 'plugin.js']
],
  • test required - plugin name
  • @root/uploads/plugins/test-plugin/ required - path to plugin
  • plugin.js required - plugin script file
  1. Add extra plugin to editorOptions -> extraPlugins
'extraPlugins' => 'dialog,lineutils,wordcount,notification,image2,widget,oembed,quicktable,tableresize,filetools,notificationaggregator,mathjax',

Without space after comma.

  1. If your plugin use the button, add it on the panel
'toolbar' => [
    ['test'],
],

Links