PHPackages                             bizley/quill - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. bizley/quill

ActiveYii2-extension[Utility & Helpers](/categories/utility)

bizley/quill
============

Quill editor implementation for Yii 2.

3.3.0(4y ago)64146.7k↓42%135Apache-2.0PHPPHP >=7.1CI passing

Since Dec 18Pushed 3mo ago8 watchersCompare

[ Source](https://github.com/bizley/yii2-quill)[ Packagist](https://packagist.org/packages/bizley/quill)[ GitHub Sponsors](https://github.com/bizley)[ RSS](/packages/bizley-quill/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (10)Dependencies (7)Versions (24)Used By (5)

yii2-quill
==========

[](#yii2-quill)

[![Latest Stable Version](https://camo.githubusercontent.com/03652b68f6f79119ffe1ea63772ad62395d2ce08da9c15f0c1a9849b71d2a2fd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f62697a6c65792f7175696c6c2e737667)](https://camo.githubusercontent.com/03652b68f6f79119ffe1ea63772ad62395d2ce08da9c15f0c1a9849b71d2a2fd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f62697a6c65792f7175696c6c2e737667)[![Total Downloads](https://camo.githubusercontent.com/892af899282e5a20c310453dc0f3ee801bc6e37c21cd9bd25e1c948b4da9aed0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f62697a6c65792f7175696c6c2e737667)](https://packagist.org/packages/bizley/quill)[![License](https://camo.githubusercontent.com/010800af2068f78625ea6cf9046d5cfc336f1cde14f40989c01e2318032f5de9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f62697a6c65792f7175696c6c2e737667)](https://camo.githubusercontent.com/010800af2068f78625ea6cf9046d5cfc336f1cde14f40989c01e2318032f5de9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f62697a6c65792f7175696c6c2e737667)

*Yii 2 implementation of Quill, modern WYSIWYG editor.*

Quill
-----

[](#quill)

You can find Quill at

- [Documentation](https://quilljs.com/docs/quickstart/)
- [Guides](https://quilljs.com/guides/why-quill/)
- [Playground](https://quilljs.com/playground/)
- [GitHub](https://github.com/quilljs/quill)

yii2-quill
----------

[](#yii2-quill-1)

### Installation

[](#installation)

Run console command

```
composer require bizley/quill:^3.3

```

Or add the package to your `composer.json`:

```
{
    "require": {
        "bizley/quill": "^3.3"
    }
}
```

and run `composer update`.

### NPM Assets

[](#npm-assets)

This package might depend on some NPM packages. Make sure you can fetch them by configuring your `composer.json` properly (i.e. by using  - see instructions there).

### Usage

[](#usage)

Use it as an active field extension

```

```

Or as a standalone widget

```

```

### Basic parameters

[](#basic-parameters)

- **theme** *string* default `'snow'`
    `'snow'` (`Quill::THEME_SNOW`) for Quill's [snow theme](https://quilljs.com/docs/themes/#snow),
    `'bubble'` (`Quill::THEME_BUBBLE`) for Quill's [bubble theme](https://quilljs.com/docs/themes/#bubble),
    `false` or `null` to remove theme (you might need to provide your own toolbar in case of no theme).
    See [Quill's documentation for themes](https://quilljs.com/docs/themes/).
- **toolbarOptions** *boolean|string|array* default `true`
    `true` for theme's default toolbar,
    `'FULL'` (`Quill::TOOLBAR_FULL`) for full Quill's toolbar,
    `'BASIC'` (`Quill::TOOLBAR_BASIC`) for few basic toolbar options,
    *array* for toolbar configuration (see below).

### Toolbar

[](#toolbar)

Quill's toolbar from version 1.0 can be easily configured with custom set of buttons.
See [Toolbar module](https://quilljs.com/docs/modules/toolbar/) documentation for details.

You can pass PHP array to `'toolbarOptions'` parameter to configure this module (it will be JSON-encoded).

For example, to get:

```
new Quill('#editor', {
    modules: {
        toolbar: [['bold', 'italic', 'underline'], [{'color': []}]]
    }
});
```

add the following code in widget configuration:

```
[
    'toolbarOptions' => [['bold', 'italic', 'underline'], [['color' => []]]],
],
```

Additional information
----------------------

[](#additional-information)

### Container and form's inputs

[](#container-and-forms-inputs)

Quill editor is rendered in `div` container (this can be changed by setting `'tag'` parameter) and edited content is copied to hidden input field so it can be used in forms. You can modify container's HTML attributes by setting `'options'` parameter and hidden field HTML attributes by setting `'hiddenOptions'` parameter.

### Editor box's height

[](#editor-boxs-height)

When `allowResize` option is set to `false` (default) editor's height is *150px* (this can be changed by setting `'options'` parameter). Setting `allowResize` to `true` resets the minimum height and allows it to be expanded freely. Editor's box extends as new text lines are added.

### Quill source

[](#quill-source)

By default, Quill is provided through the CDN (). You can change the Quill's version set with the current yii2-quill's release by changing `'quillVersion'` parameter but some options may not work correctly in this case. Starting from version 3.0.0 you can use local assets for Quill provided through NPM packet manager - to do so run

```
composer require npm-asset/quill:^1.3

```

Or add the package to your `composer.json`:

```
{
    "require": {
        "npm-asset/quill": "^1.3"
    }
}
```

You also need to set `['localAssets' => true]` in Quill's configuration.

### Additional JavaScript code

[](#additional-javascript-code)

You can use parameter `'js'` to append additional JS code.
For example, to disable user input Quill's API provides this JS:

```
quill.enable(false);
```

To get the same through widget's configuration add the following code:

```
[
    'js' => '{quill}.enable(false);',
],
```

`{quill}` placeholder will be automatically replaced with the editor's object variable name.
For more details about Quill's API visit

### Formula module

[](#formula-module)

Quill can render math formulas using the [KaTeX](https://khan.github.io/KaTeX/) library.
To add this option configure widget with [Formula module](https://quilljs.com/docs/modules/formula/):

```
[
    'modules' => [
        'formula' => true, // Include formula module
    ],
    'toolbarOptions' => [['formula']], // Include button in toolbar
]
```

By default, KaTeX is provided through the CDN (). You can change the version of KaTeX by setting the `'katexVersion'` parameter. Starting from version 3.0.0 you can use local assets for KaTeX provided through NPM packet manager - to do so run

```
composer require npm-asset/katex:^0.15

```

Or add the package to your `composer.json`:

```
{
    "require": {
        "npm-asset/katex": "^0.15"
    }
}
```

You also need to set `['localAssets' => true]` in Quill's configuration.

### Syntax Highlighter module

[](#syntax-highlighter-module)

Quill can automatically detect and apply syntax highlighting using the [highlight.js](https://highlightjs.org/) library. To add this option configure widget with [Syntax Highlighter module](https://quilljs.com/docs/modules/syntax/):

```
[
    'modules' => [
        'syntax' => true, // Include syntax module
    ],
    'toolbarOptions' => [['code-block']] // Include button in toolbar
]
```

By default, highlight.js is provided through the CDN (). You can change the version of highlight.js by setting the `'highlightVersion'` parameter. Starting from version 3.0.0 you can use local assets for highlight.js provided through NPM packet manager - to do so run

```
composer require npm-asset/highlight.js:^11.4

```

Or add the package to your `composer.json`:

```
{
    "require": {
        "npm-asset/highlight.js": "^11.4"
    }
}
```

You also need to set `['localAssets' => true]` in Quill's configuration.

You can change the default highlight.js stylesheet (for both CDN and local version) by setting the `'highlightStyle'`parameter. See [the list of possible styles](https://github.com/isagalaev/highlight.js/tree/master/src/styles).

### Smart Break module

[](#smart-break-module)

You can add Smart Break (support for shift + enter) by using the [quill-smart-break](https://github.com/simialbi/quill-smart-break/) plugin:

```
[
    'modules' => [
        'smart-breaker' => true,
    ],
]
```

Starting from version 3.1.0 quill-smart-break is provided through NPM packet manager by local asset. For previous versions you would have to add it through custom JS (see `js` property).
Run

```
composer require npm-asset/quill-smart-break:^0.2

```

Or add the package to your `composer.json`:

```
{
    "require": {
        "npm-asset/quill-smart-break": "^0.2"
    }
}
```

You also need to set `['localAssets' => true]` in Quill's configuration.

###  Health Score

52

—

FairBetter than 96% of packages

Maintenance55

Moderate activity, may be stable

Popularity47

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 87% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~108 days

Recently: every ~173 days

Total

22

Last Release

1626d ago

Major Versions

1.2.0.1 → 2.02016-10-06

2.6.1 → 3.0.02020-04-11

PHP version history (4 changes)2.3.0PHP >=7.0

2.5.0PHP ^7.0

3.0.0PHP ^7.1

3.2.1PHP >=7.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/b33b799410f9cb8d69a27bce7ae65d5c0a0aa8e097b2624c2f5315400d653b38?d=identicon)[bizley](/maintainers/bizley)

---

Top Contributors

[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (20 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (2 commits)")[![Eseperio](https://avatars.githubusercontent.com/u/5459366?v=4)](https://github.com/Eseperio "Eseperio (1 commits)")

---

Tags

hacktoberfesthighlightkatexquillquilljssyntax-highlightingwidgetwysiwygyii2yii2-quillhighlight.jsyii2widgeteditorwysiwygquillkatex

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/bizley-quill/health.svg)

```
[![Health](https://phpackages.com/badges/bizley-quill/health.svg)](https://phpackages.com/packages/bizley-quill)
```

###  Alternatives

[bizley/contenttools

ContentTools editor implementation for Yii 2.

8017.5k](/packages/bizley-contenttools)[skeeks/cms

SkeekS CMS — control panel and tools based on php framework Yii2

13926.0k66](/packages/skeeks-cms)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)