PHP Quill Renderer

Render quill insert deltas to HTML, Markdown and GitHub flavoured Markdown.

Description

Quill deltas renderer, converts deltas to HTML and Markdown, the Quill attributes supported are listed in the table below, the goal is to eventually support every Quill feature.

Quill is a modern WYSIWYG editor built for compatibility and extensibility.

v4.00.0 and continued development

I released version 4.00.0 to update dependencies to PHP 7.4 and PHP 8.0. After a hiatus, I'm back to use Quill in commercial projects, so I will be upgrading the library at some point this year.

Initially, the work will be towards supporting PHP 8 and 7.4 features and a general cleanup, the code needs to be updated to be more modular and allow plugins, then you can pick and choose what functions to support.

No timeline, I'm working on this in my limited free time.

Installation

The easiest way to use the PHP Quill Renderer is via composer. composer require deanblackborough/php-quill-renderer, alternatively you can include the classes in my src/ directory directly in your library or app.

Usage

Via API, single $quill_json

try {
    $quill = new \DBlackborough\Quill\Render($quill_json);
    $result = $quill->render();
} catch (\Exception $e) {
    echo $e->getMessage();
}

echo $result;

Via API, multiple $quill_json, passed in via array

try {
    $quill = new RenderMultiple($quill_json, 'HTML');
    
    $result_one = $quill->render('one');
    $result_two = $quill->render('two');
} catch (\Exception $e) {
    echo $e->getMessage();
}

echo $result_one;
echo $result_two;

Direct, parse and then render, single $quill_json - updated in v3.10.0

$parser = new \DBlackborough\Quill\Parser\Html();
$renderer = new \DBlackborough\Quill\Renderer\Html();

$parser->load($quill_json)->parse();

echo $renderer->load($parser->deltas())->render();

Direct, parse and then render, multiple $quill_json - updated in v3.10.0

$parser = new \DBlackborough\Quill\Parser\Html();
$renderer = new \DBlackborough\Quill\Renderer\Html();

$parser->loadMultiple(['one'=> $quill_json_1, 'two' => $quill_json_2)->parseMultiple();

echo $renderer->load($parser->deltasByIndex('one'))->render();
echo $renderer->load($parser->deltasByIndex('two'))->render();

Quill attributes and text flow support

Copyright and license

The deanblackborough/php-quill-renderer library is copyright © Dean Blackborough and licensed for use under the MIT License (MIT).

Credits

• carlos [Bugfix] v1.01.0.
• pdiveris [Issue #43] - Null inserts.
• Mark Davison - Pushed me in the right direction for v3.00.0.
• tominventisbe [Issue #54] - Parser::load() does not reset the deltas array.
• tominventisbe [Issue #55] - Image deltas with multiple attributes incorrectly being passed to Compound delta.
• bcorcoran [Issue #81] - Suggested reverting requirements to necessary requirements.
• kingga [Issue #86] - Video support.
• Jonathanm10 [Issue #87] - Newlines proceeding inserts ignored, bug report.
• raphaelsaunier [Issue #87] - Newlines proceeding inserts ignored, bug location.
• Basil [Issue #101] - Newline only inserts being ignored by parser.
• Lee Hesselden [PR #104] - Color delta to allowing spans with a style:color="#xxx" definition. (Feature will be extended by [Issue #106])
• Alex [PR #112] - Custom attributes assigned to style attribute if sensible.
• davidraijmakers [Issue #108] - Children not supported with headers.
• philippkuehn [Issue #109] - Multiple list output incorrect and paragraphs not being closed.
• mechanicalgux [Issue #117] - Compound deltas don't know that they can be links.
• Lode Claassen [PR #121] - Missing supported format in exception messages.
• Lode Claassen [PR #122] - Validation code DRY.
• Lode Claassen [PR #123] - Allow already decoded json to be passed to parser.
• Nicholas Humphries [PR #128] - Videos with attributes not supported.
• hybridvision [Issue #132] - Issue rendering single item lists when they aren't the first content.

Coding standards and documentation credits

• Lode Claassen [PR #113] - Incorrect case in keyword.
• Theo W - Readme documentation updates