README

Symfony UX Bundle implementing the Quill JS Wysiwyg https://quilljs.com/

Also, Working out of the with EasyAdmin

New Documentation: https://ehyiah.github.io/ux-quill/

If you need an easy-to-use WYSIWYG (with no complex configuration) into a symfony project, this is what you need.

• Installation
• Basic Usage
• Display Result

Installation

Step 1 Require bundle

  composer require ehyiah/ux-quill

If you are using the AssetMapper Component you're done !

step 2 next run (If you are using webpack encore, not needed with AssetMapper)

    yarn install --force
    yarn watch

OR

    npm install --force
    npm run watch

It's done, you can use the QuillType to build a QuillJs WYSIWYG

You can add as many WYSIWYG fields inside same page like any normal fields.

Basic Usage

In a form, use QuillType. It works like a classic Type except it has more options : e.g:

    use Ehyiah\QuillJsBundle\Form\QuillType;

    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            // ...
            ->add('myField', QuillType::class)
        ;
    }

Display result

In a twig template, the easiest way is to use the provided Twig component:

{# emits the required <link> tags once per request (AssetMapper only) #}
{{ quill_content_styles() }}

<twig:QuillContent value="{{ post.content }}" />

The component only renders the HTML wrappers; it does not pull any CSS by itself. Use quill_content_styles() (AssetMapper) or import the stylesheets in your CSS entry (Webpack). See usage docs for details, including the opt-in cosmetic stylesheet for mentions.

For inline style (no CSS required on frontend):

<twig:QuillContent value="{{ post.content }}" style="inline" />

Or manually:

• if you use the default class styling option you may need to encapsulate the content so the quill stylesheet can be applied like this :

    <div class="ql-snow">
        <div class="ql-editor">
            {{ myField|raw }}
        </div>
    </div>

• if you use the inline styling option simply :

    <div>{{ myField|raw }}</div>