yii2-extensions/summernote

Summernote - Super Simple WYSIWYG editor.

Installs: 211

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

Language:JavaScript

dev-main / 1.0.x-dev 2023-12-15 21:31 UTC

This package is auto-updated.

Last update: 2024-11-15 23:33:31 UTC


README

Summernote - Super Simple WYSIWYG editor.


php-version PHPUnit PHPUnit Codecov Infection

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

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.

Quality code

static-analysis phpstan-level style-ci

Support versions Yii2

Yii20 Yii22

Testing

Check the documentation testing to learn about testing.

Our social networks

Twitter

License

The MIT License. Please see License File for more information.