yii2-extensions/summernote

Summernote - Super Simple WYSIWYG editor.

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

Requires

• php: >=8.1
• oomphinc/composer-installers-extender: ^2.0
• yii2-extensions/asset-bootstrap5: dev-main
• yiisoft/yii2: *

Requires (Dev)

• maglnet/composer-require-checker: ^4.6
• php-forge/support: dev-main
• phpunit/phpunit: ^10.2
• roave/infection-static-analysis-plugin: ^1.32
• yii2-extensions/phpstan: dev-main

mit

• wysiwyg
• editor
• yii2
• summernote

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.

Quality code

Support versions Yii2

Testing

Check the documentation testing to learn about testing.

Our social networks

License

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