Download the PHP package ehyiah/ux-quill without Composer

QuillJs Bundle for Symfony using Symfony UX

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

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

It comes with some extra features out of the box like image uploading to custom endpoint instead of base64 only.

• Installation

• Basic Usage

• Display Result

• Customize quillJS with options and extra_options

• Handle images uploads

• Handle images uploads security

• Customize toolbar icons

• Extend Quill stimulus controller

• EasyAdmin Integration
• EasyAdmin Usage

Installation

Step 1 Require bundle

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

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

OR

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:

Display result

in a twig template :

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

• if you use the inline styling option simply :

For the most basic this is only what you have to do.

Customize Options

quill_options :

This is where you will choose what elements you want to display in your WYSIWYG. You can build an array like you would do following the QuillJs official documentation Or use a more convenient with Autocomplete using the many Fields Object in this bundle.

This example will display a h1 and h2 header options side by side

This example will display a h1 and h2 header options side by side and another Group containing a Bold and an Italic fields

You can add as many Groups as you like or just One if you don't need the WYSIWYG options to have spaces between them.

Available Fields

• Below is the list of available fields from QuillJS (https://v2.quilljs.com/docs/formats)

• Below is a list of fields not available in QuillJS but taken from community:

quill_extra_options

assets example

OR associative array, this will allow you to override default built-in CDN assets for katex (use for FormulaField) and highlight (use for CodeBlockField)

Image upload Handling

In ImageField : QuillJS transforms images in a base64 encoded file by default to save your files. However, you can specify a custom endpoint to handle image uploading and pass in response the entire public URL to display the image.

currently handling 2 methods :

1: data sending in base64 inside a application/json request

• in JSON mode data will look like this by calling $request->getContent() and in content-type headers

2: sending in a multipart/form-data request

• in form mode you will find a in content-type headers and file will be present in $request->files named as a Symfony\Component\HttpFoundation\File\UploadedFile
• then you can handle it like you would do with a FileType and access the file like this :

upload mode configuration :

example of a JSON configuration to send a request to the upload endpoint that returns a JSON response containing the URL to the uploaded image.

see below for a detail on these options values.

available options in upload handler:

upload endpoint security:

example of a JSON configuration with jwt security.

• If your response in a classic simple Symfony\Component\HttpFoundation\Response, you can simply return a response like this one for exemple and do not need to specify the json_response_file_path option.

• If your response is a JSON response like a Symfony\Component\HttpFoundation\JsonResponse, the json_response_file_path option can be used to specify the url inside the json response. in the exemple below json_path_file_response must be 'file.url'.

• If your response is a JSON response like a Symfony\Component\HttpFoundation\JsonResponse, and the json_response_file_path is null.

Modules

PHP configurable modules

For these modules, you can configure them directly in your PHP form : https://quilljs.com/docs/modules

You can add/customize quill modules in this option field. You can create your own modules classes, they need to implement the ModuleInterface and add the name and options properties. Some modules are automatically loaded when they are needed in fields.

Example of how to use modules:

Other modules that need custom JavaScript

For other modules, you will need to extend Quill controller (see below) to use them as they required custom JavaScript as you cannot configure them in PHP.

icons

You can customize icons used in the toolbar, pass the toolbar name and a new svg exemple :

Extend Quill stimulus controller

If you need to extend the default behavior of the built-in controller, this is possible. For example, you need to modify module registration and/or add custom JavaScript to modify quill behavior.

Some modules like Keyboard and Clipboard need custom JavaScript to be written. The easiest way to do so is to create a custom stimulus controller to extend the default behavior.

You can do this easily by attaching to various events to avoid being forced to rewrite the entire controller.

Events

some events are dispatched:

Example of an extended controller to add Keyboard features

1. Create a new Stimulus controller inside your project

2. Then in your form type

Easyadmin Integration

Integration will depend on how you handle assets in your project, AssetMapper or Webpack.

1. Optional first step

If you already have an entrypoint JavaScript file that you want to re-use in admin then skip this step. And directly go to the AssetMapper or Webpack integration.

Otherwise: create a quill-admin.js inside the assets directory

2. See Webpack

When using AssetMapper

create a new entry in importmap.php (the key must be quill-admin as it is the name used in the built-in QuillAdminField, but you can specify whatever you want as the actual JavaScript file in path)

and it should be done. but read below

WARNING => at the moment there seems to have an issue with easyadmin with the ->addAssetMapperEntries() function as I can not get it work as it should be.

a quick fix is to add in your crudControllers

OR

in your Dashboard controller

When using webpack

• Create in webpack.config a new entry (the entry name must be quill-admin as it is the name used in the built-in QuillAdminField, but you can specify whatever you want as the actual JavaScript file in path)

remember to recompile assets (yarn build/watch or npm equivalent).

EasyAdmin Field usage

Then you can use the QuillAdminField like this :

Or add custom options like you would do with the normal type