ccc008/kindeditor

描述

维护者

详细信息

github.com/ccc008/kindeditor

源代码

安装: 6

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 8

语言:JavaScript

dev-master 2017-11-23 14:17 UTC

This package is not auto-updated.

Last update: 2024-09-29 04:09:02 UTC


README

修复了Linux下的一些bug,由于Yii China无法更新这些信息,抱歉。使用方法务必参考本文,YiiChina上的方法有拼写问题,因为无法修改,所以一定要看这个!!!*

中文的使用说明在页面下部

安装

运行以下命令之一

$ php composer.phar require ccc008/kindeditor "*"

或者

"ccc008/kindeditor": "*"

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

'ccc008\\kindeditor\\'=>array($vendorDir . '/ccc008/kindeditor'),

使用示例

在控制器中添加 actions() 方法

public function actions()
{
    return [
        'Kupload' => [
            'class' => 'pjkui\kindeditor\KindEditorAction',
            'max_size'=>1024*1024*10, //最大上传10MB
        ]
    ];
}10

##用于视图

echo \pjkui\kindeditor\KindEditor::widget([]);

或者:

echo $form->field($model,'colum')->widget('pjkui\kindeditor\KindEditor',[]);

或者:

<?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
['clientOptions'=>['allowFileManager'=>'true',
'allowUpload'=>'true']]) 
?>

配置

您可以为 clientOptioneditorType 配置以更改kindeditor的偏好,详细配置请参阅官方网站KindEditor网站

###editorType 配置

  1. 作为文本编辑器,默认配置。

用法

 <?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
        ['clientOptions'=>['allowFileManager'=>'true',
                            'allowUpload'=>'true'
                            ]
        ]) ?>
  1. uploadButtonKindediotr 作为上传文件按钮,可自动上传文件/图片到服务器
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                    ['clientOptions'=>[
                                        'allowFileManager'=>'true',
                                        'allowUpload'=>'true'
                                        ],
                    'editorType'=>'uploadButton
                    ]) 
?>
  1. colorpickerkindeditor 作为取色器使用
<?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
                                                    'editorType'=>'colorpicker'])
        ?>
  1. file-managerkindeditor 作为文件管理器,可以查看和选择其上传的文件。用法
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                    ['clientOptions'=>[
                                'allowFileManager'=>'true',
                                'allowUpload'=>'true'
                                    ],
                        'editorType'=>'file-manager'
                        ]) 
        ?>
  1. image-dialogkindeditor 作为图片上传对话框使用
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                        ['clientOptions'=>['allowFileManager'=>'true',
                                            'allowUpload'=>'true'
                                            ],
                        'editorType'=>'image-dialog'
                        ]) 
?>
  1. file-dialogkindeditor 作为文件上传对话框使用
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                                ['clientOptions'=>['allowFileManager'=>'true',
                                                    'allowUpload'=>'true'],
                                'editorType'=>'file-dialog'
                                ])
    ?>

简单示例

use \pjkui\kindeditor\KindEditor;
echo KindEditor::widget([
    'clientOptions' => [
        //editor size
        'height' => '500',
        //custom menu 
        'items' => [
        'source', '|', 'undo', 'redo', '|', 'preview', 'print', 'template', 'code', 'cut', 'copy', 'paste',
        'plainpaste', 'wordpaste', '|', 'justifyleft', 'justifycenter', 'justifyright',
        'justifyfull', 'insertorderedlist', 'insertunorderedlist', 'indent', 'outdent', 'subscript',
        'superscript', 'clearhtml', 'quickformat', 'selectall', '|', 'fullscreen', '/',
        'formatblock', 'fontname', 'fontsize', '|', 'forecolor', 'hilitecolor', 'bold',
        'italic', 'underline', 'strikethrough', 'lineheight', 'removeformat', '|', 'image', 'multiimage',
        'flash', 'media', 'insertfile', 'table', 'hr', 'emoticons', 'baidumap', 'pagebreak',
        'anchor', 'link', 'unlink', '|', 'about'
        ]
]);

KindEditor中文手册

如何安装

第一种方法:如果已安装composer,可以运行此命令

$ php composer.phar require pjkui/kindeditor "*"

第二种方法:将

"pjkui/kindeditor": "*"

添加到项目 composer.json 文件的 require 部分。

第三种方法:直接将程序文件放在系统的 vendor 下面,实际上建议使用 composer,这是一个比较方便和规范的安装方法。如果是复制的话,有一个文件需要修改,以确保这个kindeditor类被加载。这个文件是 /vendor/composer/autoload_psr4.php。添加一行

'pjkui\\kindeditor\\'=>array($vendorDir . '/pjkui/kindeditor'),

使用方法

##控制器
在控制器中添加此方法:

public function actions()
{
    return [
        'Kupload' => [
            'class' => 'pjkui\kindeditor\KindEditorAction',
        ]
    ];
}

##视图
首先在视图中添加

echo \pjkui\kindeditor\KindEditor::widget([]);

或者:

echo $form->field($model,'colum')->widget('pjkui\kindeditor\KindEditor',[]);

或者:

<?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
['clientOptions'=>['allowFileManager'=>'true',
'allowUpload'=>'true']]) 
?>

具体相关功能配置

编辑器相关配置,请在 view 中配置,参数为 clientOptions,例如自定义菜单,编辑器大小等,具体参数请查看KindEditor官网文档

editorType 配置

  1. 配置为富文本编辑器,默认配置

示例:

<?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
        ['clientOptions'=>['allowFileManager'=>'true',
                            'allowUpload'=>'true'
                            ]
        ])
 ?>
  1. 此时配置kindeditor为上传文件按钮,可以自动上传文件到服务器 示例:
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                    ['clientOptions'=>[
                                        'allowFileManager'=>'true',
                                        'allowUpload'=>'true'
                                        ],
                    'editorType'=>'uploadButton
                    ]) 
?>
  1. 配置kindeditor为取色器 示例:
<?= $form->field($model, 'content')->widget('pjkui\kindeditor\KindEditor',
                                                    'editorType'=>'colorpicker'])
        ?>
  1. 配置kindeditor为文件管理器,可以查看和选择其上传的文件。 示例:
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                    ['clientOptions'=>[
                                'allowFileManager'=>'true',
                                'allowUpload'=>'true'
                                    ],
                        'editorType'=>'file-manager'
                        ]) 
        ?>
  1. 配置kindeditor为图片上传对话框。 示例:
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                        ['clientOptions'=>['allowFileManager'=>'true',
                                            'allowUpload'=>'true'
                                            ],
                        'editorType'=>'image-dialog'
                        ]) 
?>
  1. 配置kindeditor为文件上传对话框。 示例:
<?= $form->field($model, 'article_pic')->widget('pjkui\kindeditor\KindEditor',
                                ['clientOptions'=>['allowFileManager'=>'true',
                                                    'allowUpload'=>'true'],
                                'editorType'=>'file-dialog'
                                ])
    ?>

简单示例

use \pjkui\kindeditor\KindEditor;
echo KindEditor::widget([
    'clientOptions' => [
        //编辑区域大小
        'height' => '500',
        //定制菜单
        'items' => [
        'source', '|', 'undo', 'redo', '|', 'preview', 'print', 'template', 'code', 'cut', 'copy', 'paste',
        'plainpaste', 'wordpaste', '|', 'justifyleft', 'justifycenter', 'justifyright',
        'justifyfull', 'insertorderedlist', 'insertunorderedlist', 'indent', 'outdent', 'subscript',
        'superscript', 'clearhtml', 'quickformat', 'selectall', '|', 'fullscreen', '/',
        'formatblock', 'fontname', 'fontsize', '|', 'forecolor', 'hilitecolor', 'bold',
        'italic', 'underline', 'strikethrough', 'lineheight', 'removeformat', '|', 'image', 'multiimage',
        'flash', 'media', 'insertfile', 'table', 'hr', 'emoticons', 'baidumap', 'pagebreak',
        'anchor', 'link', 'unlink', '|', 'about'
       ],
       'id'=>'thisID',//填写你想给textarea的id
]);