README

Yii 2.x 的 Redactor 编辑器

这是一个为 Imperavi Redactor '所见即所得' 编辑器包装的 Yii 2.0 PHP 框架。它会自动加载所需的所有 Redactor 插件。

yii2-wysiwyg 的演示请访问此处。

安装

安装 yii2-wysiwyg 的首选方式是通过 Composer。您可以将以下内容添加到您的 composer.json 文件的 require 部分

"sjaakp/yii2-wysiwyg": "*"

或者运行

composer require sjaakp/yii2-wysiwyg "*"

您可以通过下载 ZIP 格式的源代码手动安装 yii2-wysiwyg。

Redactor 文件

Redactor 是商业软件，不通过 Composer 提供。您必须手动下载。

Yii2-wysiwyg 假设 Redactor 文件（即在从 Imperavi 获取的 ZIP 文件中 'redactor' 目录的完整内容）位于 '@app/redactor'。您可以通过在应用程序配置文件中设置参数 'redactor' 来设置另一个源路径，通常称为 config 目录中的 web.php 或 main.php，如下所示

$params = [
    'adminEmail' => ...,
    'redactor' => <path to Redactor files, or alias>
];

$config = [
    // ...
    'params' => $params,
    // ...
]

该路径可能和将作为别名设置。

使用 Wysiwyg

Wysiwyg 仅是一个普通的 Yii 2 InputWidget。在表单中，它可以这样使用

<?php
    use sjaakp\wysiwyg\Wysiwyg;
?>

<?php $form = ActiveForm::begin([
    // ... form options ...
]); ?>

    ... other fields ...
    
    <?= $form->field($model, 'story')->widget(Wysiwyg::class, [
        // ... Wysiwyg options ...
    ]) ?>
    
    ... more fields ...

<?php ActiveForm::end(); ?>

如同任何 InputWidget 一样，Wysiwyg 也可以在表单外部使用。在这种情况下，它应与一个 name 和一个 value 关联

<?php
    use sjaakp\wysiwyg\Wysiwyg;
?>

<?= Wysiwyg::widget([
    'name' => 'myWysiwyg',
    'value' => 'Initial text...',
    // ... other options ...
]) ?>

选项

Wysiwyg 具有与 InputWidget 相同的所有属性，以及以下属性

redactorOptions array Imperavi Redactor 的选项。请参阅 Imperavi Web 页面了解可能的选择。有很多选项！
includeCss bool 是否应该注册 CSS 文件。如果将 CSS 包含在网站的主文件中，请将此设置为 false。

sjaakp /yii2-wysiwyg

维护者

详细信息

README

Yii 2.x 的 Redactor 编辑器

安装

Redactor 文件

使用 Wysiwyg

选项