Download the PHP package nadar/quill-delta-parser without Composer
On this page you can find all versions of the php package nadar/quill-delta-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nadar/quill-delta-parser
More information about nadar/quill-delta-parser
Files in nadar/quill-delta-parser
Package quill-delta-parser
Short Description A PHP library to parse Quill WYSIWYG editor deltas into HTML - flexible and extendible for custom elements.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package quill-delta-parser
Quill Delta to HTML Parser
A PHP library to parse Quill WYSIWYG editor deltas into HTML - flexible and extendable for custom elements. Every element is parsed by the same mechanism, making it easy to extend and understand. It also sanitizes the output value, making it more secure, especially when using user-generated text.
What is Quill? Quill is a free, open source WYSIWYG editor built for the modern web. With its modular architecture and expressive API, it is completely customizable to fit any need.
Installation
The package is available only through Composer:
Usage
Where $json is the ops JSON array from Quill, for example:
This would render the following HTML:
Extend the Parser
To extend the Parser by adding your own listeners (this can be the case if you are using Quill plugins which generate custom delta code), you have to decide whether it's an:
- Inline element: Replaces content with new parsed content, mostly the case when working with Quill extensions.
- Block element: Encloses the whole input with a tag, for example, a heading.
An example for a mention plugin that generates the following delta {"insert":{"mention":{"id":"1","value":"Basil","denotationChar":"@"}}}; an inline plugin could look like this:
Now register the listener:
Override Built-in Listeners
Certain listeners (image, video, color) produce an HTML output which may not suit your use case, so you have the option to override the properties of those plugins and re-register the Listener. Here's an example with the image tag:
If you want to replace a class with your own image class, use overwriteListener to achieve the same result, but with your totally custom class. The reason is that listeners are registered by their class names.
Or, of course, when you have a separate file for your class:
Debugging
Sometimes, understanding how delta is handled and parsed can be challenging to debug. Therefore, you can use the debugger class, which will print a table with information about how the data is parsed.
There is also a built-in Docker Compose file which provides access to the output.php file. The output.php helps to directly write content with the Quill editor while displaying what is rendered, including all debug information. To run this Docker webserver, execute the following command in the root directory of your Git repository clone:
and visit http://localhost:5555/ in your browser.
Credits
All versions of quill-delta-parser with dependencies
ext-json Version *