2amigos / yii2-tinymce-widget
TinyMCE widget for Yii2.
Installs: 1 029 508
Dependents: 46
Suggesters: 0
Security: 0
Stars: 102
Watchers: 22
Forks: 45
Open Issues: 17
Language:JavaScript
Type:yii2-extension
Requires
- tinymce/tinymce: >=4
- yiisoft/yii2: ^2.0
Requires (Dev)
- phpunit/phpunit: 4.*
README
Renders a TinyMCE WYSIWYG text editor plugin widget.
Installation
The preferred way to install this extension is through composer.
Either run
composer require 2amigos/yii2-tinymce-widget:~1.1
or add
"2amigos/yii2-tinymce-widget" : "~1.1"
to the require section of your application's composer.json
file.
Usage
use dosamigos\tinymce\TinyMce;
<?= $form->field($model, 'text')->widget(TinyMce::className(), [
'options' => ['rows' => 6],
'language' => 'es',
'clientOptions' => [
'plugins' => [
"advlist autolink lists link charmap print preview anchor",
"searchreplace visualblocks code fullscreen",
"insertdatetime media table contextmenu paste"
],
'toolbar' => "undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image"
]
]);?>
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(TinyMce::className(), [ 'options' => ['rows' => 16], 'language' => 'en_GB', 'clientOptions' => // ... // this will render the function name without quotes on the configuration options of the plugin 'file_picker_callback' => new JsExpression('jsFunctionToBeCalled'), // ... ] ]); ?>
Testing
$ phpunit
Further Information
Please, check the TinyMCE 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.
Web development has never been so fun!
www.2amigos.us