Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ommu/yii2-redactor

Extension Redactor WYSIWYG for Yii2 framework
https://github.com/ommu/yii2-redactor

imperavi imperavi-redactor redactor wysiwyg yii2 yii2-extension

Last synced: 3 months ago
JSON representation

Extension Redactor WYSIWYG for Yii2 framework

Awesome Lists containing this project

README

        

yii2-redactor
=============
Extension redactor for Yii2 Framework.

Installation
------------

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist ommu/yii2-redactor "*"
```

or
```
"ommu/yii2-redactor": "*"
```

to the require section of your composer.json.

Configure
-----------------

Add to config file (config/web.php or common\config\main.php)

```
'modules' => [
'redactor' => 'yii\redactor\RedactorModule',
],
```
or if you want to change the upload directory.
to path/to/uploadfolder
default value `@webroot/uploads`

```
'modules' => [
'redactor' => [
'class' => 'yii\redactor\RedactorModule',
'uploadDir' => '@webroot/path/to/uploadfolder',
'uploadUrl' => '@web/path/to/uploadfolder',
'imageAllowExtensions'=>['jpg','png','gif']
],
],
```

note: You need to create uploads folder and chmod and set security for folder upload
reference: [Protect Your Uploads Folder with .htaccess](http://tomolivercv.wordpress.com/2011/07/24/protect-your-uploads-folder-with-htaccess/),
[How to Setup Secure Media Uploads](http://digwp.com/2012/09/secure-media-uploads/)

Config view/form

```
= $form->field($model, 'body')->widget(\yii\redactor\widgets\Redactor::className()) ?>
```

or not use ActiveField

```
= \yii\redactor\widgets\Redactor::widget([
'model' => $model,
'attribute' => 'body'
]) ?>
```
or config advanced redactor reference [Docs](http://imperavi.com/redactor/docs/)

```
= $form->field($model, 'body')->widget(\yii\redactor\widgets\Redactor::className(), [
'clientOptions' => [
'imageManagerJson' => ['/redactor/upload/image-json'],
'imageUpload' => ['/redactor/upload/image'],
'fileUpload' => ['/redactor/upload/file'],
'lang' => 'zh_cn',
'plugins' => ['clips', 'fontcolor','imagemanager']
]
])?>
```

change default subfolder - optional, name subfolder only [a-zA-Z]
```
= $form->field($model, 'body')->widget(\yii\redactor\widgets\Redactor::className(), [
'clientOptions' => [
'imageManagerJson' => ['/redactor/upload/image-json', 'subfolder' => 'news'],
'imageUpload' => ['/redactor/upload/image', 'subfolder' => 'news'],
'fileUpload' => ['/redactor/upload/file', 'subfolder' => 'news'],
'lang' => 'zh_cn',
'plugins' => ['clips', 'fontcolor','imagemanager']
]
])?>
```

Bummer! i was tested on my project but not have many time to write document on file and usage.
If you have problem please create a [issue](https://github.com/ommu/yii2-redactor/issues)

Thanks!