Pell content editor Widget for Yii2 ¶
Renders a Pell WYSIWYG text editor plugin widget.
Installation ¶
The preferred way to install this extension is through composer.
Either run
composer require coderius/yii2-pell-widget:"@dev"
or add
"coderius/yii2-pell-widget" : "@dev"
to the require section of your application's composer.json file.
Usage ¶
For example to use the datepicker with a model:
`php
echo Pell::widget([
'model' => $model,
'attribute' => 'text',
]);
`
The following example will used not as an element of form:
`php
echo Pell::widget([
'asFormPart' => false,
'value' => $value,
]);
`
You can also use this widget in an ActiveForm using the widget() method, for example like this:
use coderius\pell\Pell;
<?= $form->field($model, 'text')->widget(Pell::className(), []);?>
About ClientOptions ¶
Please, remember that if you are required to add javascript to the configuration of the js plugin and is required to be
plain JS, make use of JsExpression. That class was made by Yii for that specific purpose. For example:
// Having the following scenario
<script>
function jsFunctionToBeCalled() {
// ...
}
</script>
<?= $form->field($model, 'content')->widget(Pell::className(), [
'clientOptions' => [
'defaultParagraphSeparato' => 'div',
// ...
'actions' => [
'bold',
'italic',
'underline',
'strikethrough',
'heading1',
'heading2',
'paragraph',
'quote',
'olist',
'ulist',
'code',
'line',
'link',
'image',
[
'name' => 'backColor',
'icon' => '<div style="background-color:pink;">A</div>',
'title' => 'Highlight Color',
// this will render the function name without quotes on the configuration options of the plugin
'result' => new JsExpression('jsFunctionToBeCalled')
],
],
// ...
]
]
]); ?>
Testing ¶
$ phpunit
Further Information ¶
Please, check the Pell plugin github documentation for further information about its configuration options.
Contributing ¶
Please see CONTRIBUTING for details.
Credits ¶
License ¶
The MIT License (MIT). Please see License File for more information.
Web development has never been so fun!
coderius.biz.ua