README

yii2-editors

适用于Yii2框架的编辑器小部件 - Summernote和Codemirror。

Summernote是一个WYSIWYG富文本HTML输入小部件，使用Summernote WYSWIYG插件，并针对Bootstrap 3.x和4.x进行了样式设计。包括Krajee为Bootstrap 3.x和4.x支持的额外增强，以及格式化代码和渲染预设可配置工具栏的能力。

Codemirror是一个纯文本代码编辑器，允许对各种代码进行语法格式化。

安装

安装此扩展的首选方法是通过composer。检查此扩展的composer.json以获取此扩展的要求和依赖项。阅读此web提示/wiki，了解如何设置应用程序的composer.json中的minimum-stability设置。

要安装，请运行以下命令之一：

$ php composer.phar require kartik-v/yii2-editors "@dev"

或

"kartik-v/yii2-editors": "@dev"

将其添加到您的composer.json文件的require部分。

有关按版本变化的详细信息，请参阅变更日志。

演示

您可以在文档和示例中查看扩展的使用详情。

先决条件

Codemirror小部件需要页面上的Font Awesome图标资产来渲染工具栏。您可以使用以下选项之一在页面上渲染Font Awesome图标资产：

• 选项1：Font Awesome的CSS版本

<!-- on your view layout file HEAD section -->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">

• 选项2：SVG/JS版本的Font Awesome（例如，从kartik-v/yii2-icons库中获取）

// on your view layout file
use kartik\icons\FontAwesomeAsset;
FontAwesomeAsset::register($this);

用法

Summernote WYSIWYG编辑器

use kartik\editors\Summernote;

// Usage with ActiveForm and model and default settings
echo $form->field($model, 'content')->widget(Summernote::class, [
    'options' => ['placeholder' => 'Edit your blog content here...']
]);

// With model & without ActiveForm and default settings
echo Summernote::widget([
    'model' => $model,
    'attribute' => 'html_content',
]);

// Without model and setting advanced custom widget configuration options
echo Summernote::widget([
    'name' => 'blog_post',
    'value' => '',
    'useKrajeeStyle' => true,
    'useKrajeePresets' => true,
    'enableFullScreen' => true,
    'enableCodeView' => false,
    'enableHelp' => false,
    'enableHintEmojis' => true,
    'hintMentions' => ['jayden', 'sam', 'alvin', 'david']
]);

Codemirror代码编辑器

use kartik\editors\Codemirror;

// Usage with ActiveForm and model and default settings
echo $form->field($model, 'program_code')->widget(Codemirror::class, [
    'preset' => Codemirror::PRESET_PHP,
    'options' => ['placeholder' => 'Edit your code here...']
]);

// With model & without ActiveForm and default settings
echo Codemirror::widget([
    'model' => $model,
    'attribute' => 'json_code',
    'preset' => Codemirror::PRESET_JSON,
]);

// Without model and setting advanced custom widget configuration options
echo Codemirror::widget([
    'name' => 'js_code',
    'value' => '',
    'preset' => Codemirror::PRESET_JS,
    'useKrajeePresets' => true,
    'libraries' => [
        'addon/display/placeholder.js',
        'addon/fold/xml-fold.js',
        'addon/edit/matchbrackets.js',
        'addon/edit/matchtags.js',
        'addon/selection/active-line.js',
        'addon/selection/selection-pointer.js',
    ],
    'pluginOptions' => [
        'modes' => ['xml', 'javascript', 'css'],
    ]
]);

许可

yii2-editors采用BSD-3-Clause许可证发布。有关详细信息，请参阅捆绑的LICENSE.md。