README

Summernote - Super Simple WYSIWYG editor.

Installation

The preferred way to install this extension is through composer.

Either run

composer require --dev --prefer-dist yii2-extensions/summernote

or add

"yii2-extensions/summernote": "dev-main"

to the require-dev section of your composer.json file.

Usage

Name

use Yii2\Extensions\Summernote\Summernote;

echo Summernote::widget(
    [
        'name' => 'content',
        'value' => $value,
        'config' => [
            'focus' => true,
            'height' => 200,
            'maxHeight' => null,
            'minHeight' => null,
            'placeholder' => 'Write here...',
        ],
    ]
);

Active Field

use Yii2\Extensions\Summernote\Summernote;

echo $form
    ->field($model, 'content')
    ->widget(
        Summernote::class,
        [
            'config' => [
                'focus' => true,
                'height' => 200,
                'maxHeight' => null,
                'minHeight' => null,
                'placeholder' => 'Write here...',
            ],
        ]
    );

Properties of the widget

Property	Type	Description	Default
`config`	`array`	The configuration of the widget.	`[]`

When YII_ENV is set to dev or test, the widget will load the non-minified version of the JavaScript files, otherwise it will load the minified version.