Skip to content

Commit

Permalink
Merge branch 'update'
Browse files Browse the repository at this point in the history
  • Loading branch information
Bizley committed Nov 29, 2018
2 parents ad8e1cb + a8cb462 commit 14e6497
Show file tree
Hide file tree
Showing 8 changed files with 183 additions and 141 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
/nbproject/
nbproject
.idea
vendor
composer.lock
26 changes: 1 addition & 25 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -175,28 +175,4 @@

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright {yyyy} {name of copyright owner}

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2018 Paweł Bizley Brzozowski
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# yii2-quill

![Latest Stable Version](https://img.shields.io/packagist/v/bizley/quill.svg)
![Total Downloads](https://img.shields.io/packagist/dt/bizley/quill.svg)
[![Total Downloads](https://img.shields.io/packagist/dt/bizley/quill.svg)](https://packagist.org/packages/bizley/quill)
![License](https://img.shields.io/packagist/l/bizley/quill.svg)

*Yii 2 implementation of Quill, modern WYSIWYG editor.*
Expand All @@ -18,22 +18,26 @@ You can find Quill at https://quilljs.com/

### Installation

Easiest way to install this extension is through the [Composer](https://getcomposer.org).
Add in your `composer.json`:
`"bizley/quill": "^2.0"`
or run console command:
`php composer.phar require "bizley/quill ^2.0"`
Add the package to your `composer.json`:

If you want to install Quill beta version add:
`"bizley/quill": "^1.0"`
{
"require": {
"bizley/quill": "^2.0"
}
}

and run `composer update` or alternatively run `composer require bizley/quill:^2.1`

### Usage

Use it as an active field extension
`<?= $form->field($model, $attribute)->widget(\bizley\quill\Quill::className(), []) ?>`

or as a standalone widget
`<?= \bizley\quill\Quill::widget(['name' => 'editor', 'value' => '']) ?>`
<?= $form->field($model, $attribute)->widget(\bizley\quill\Quill::class, []) ?>

Or as a standalone widget

<?= \bizley\quill\Quill::widget(['name' => 'editor', 'value' => '']) ?>


### Basic parameters

Expand Down Expand Up @@ -74,8 +78,6 @@ add the following code in widget configuration:
],
```

Toolbar configuration for previous yii2-quill version (**^1.0** with Quill *beta*) is deprecated.

## Additional information

### Container and form's input
Expand Down Expand Up @@ -121,9 +123,9 @@ To add this option configure widget with [Formula module](https://quilljs.com/do
```php
[
'modules' => [
'formula' => true // Include formula module
'formula' => true, // Include formula module
],
'toolbarOptions' => [['formula']] // Include button in toolbar
'toolbarOptions' => [['formula']], // Include button in toolbar
]
```

Expand All @@ -137,7 +139,7 @@ To add this option configure widget with [Syntax Highlighter module](https://qui
```php
[
'modules' => [
'syntax' => true // Include syntax module
'syntax' => true, // Include syntax module
],
'toolbarOptions' => [['code-block']] // Include button in toolbar
]
Expand Down
58 changes: 31 additions & 27 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
{
"name": "bizley/quill",
"description": "Quill editor implementation for Yii 2.",
"type": "yii2-extension",
"keywords": [
"yii2",
"quill",
"wysiwyg",
"widget",
"editor"
],
"license": "Apache-2.0",
"authors": [
{
"name": "Pawel Bizley Brzozowski",
"email": "pawel@positive.codes"
}
],
"support": {
"source": "https://github.com/bizley/yii2-quill"
},
"require": {
"yiisoft/yii2": "^2.0.0"
},
"autoload": {
"psr-4": {
"bizley\\quill\\": ""
}
"name": "bizley/quill",
"description": "Quill editor implementation for Yii 2.",
"type": "yii2-extension",
"keywords": ["yii2","quill","wysiwyg","widget","editor"],
"license": "Apache-2.0",
"authors": [
{
"name": "Pawel Bizley Brzozowski",
"email": "pawel@positive.codes"
}
],
"support": {
"source": "https://github.com/bizley/yii2-quill"
},
"require": {
"php": ">=7.0",
"yiisoft/yii2": ">=2.0.0 <2.1.0"
},
"require-dev": {
"roave/security-advisories": "dev-master"
},
"autoload": {
"psr-4": {
"bizley\\quill\\": "src/"
}
},
"repositories": [
{
"type": "composer",
"url": "https://asset-packagist.org"
}
]
}
Loading

0 comments on commit 14e6497

Please sign in to comment.