rybakit / twig-deferred-extension
An extension for Twig that allows to defer block rendering.
Fund package maintenance!
rybakit
Installs: 2 282 387
Dependents: 4
Suggesters: 0
Security: 0
Stars: 109
Watchers: 10
Forks: 3
Open Issues: 2
Requires
- twig/twig: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16
- phpunit/phpunit: ^6.1|^7.0|^8.0|^9.0
README
An extension for Twig that allows to defer block rendering.
Installation
composer require rybakit/twig-deferred-extension
Note that this extension requires Twig 3 or above. If you need support for older versions of Twig, please refer to the legacy repository.
Initialization
use Twig\DeferredExtension\DeferredExtension; use Twig\Environment; ... $twig = new Environment($loader); $twig->addExtension(new DeferredExtension());
Simple example
{% block foo deferred %} {{ bar }} {% endblock %} {% set bar = 'bar' %}
The foo
block will output "bar".
Advanced example
Just for example purposes, first create a global twig variable:
use Twig\Environment; ... $twig = new Environment($loader); $twig->addGlobal('assets', new \ArrayObject());
Then build the following set of templates:
{# layout.html.twig #} <!DOCTYPE html> <html> <head> ... </head> <body> {% block content '' %} {{ assets.append('/js/layout-header.js') }} {% block javascripts deferred %} {% for asset in assets %} <script src="{{ asset }}"></script> {% endfor %} {% endblock %} {{ assets.append('/js/layout-footer.js') }} </body> </html> {# page.html.twig #} {% extends "layout.html.twig" %} {% block content %} {{ assets.append('/js/page-header.js') }} {% if foo is defined %} {{ include("subpage1.html.twig") }} {% else %} {{ include("subpage2.html.twig") }} {% endif %} {{ assets.append('/js/page-footer.js') }} {% endblock %} {# subpage1.html.twig #} {{ assets.append('/js/subpage1.js') }} {# subpage2.html.twig #} {{ assets.append('/js/subpage2.js') }}
The resulting html will be the following:
<!DOCTYPE html> <html> <head> ... </head> <body> <script src="/js/layout-header.js"></script> <script src="/js/page-header.js"></script> <script src="/js/subpage2.js"></script> <script src="/js/page-footer.js"></script> <script src="/js/layout-footer.js"></script> </body> </html>
Block overriding
{# index.twig #} {% extends "base.twig" %} {% block foo %}foo is not deferred anymore{% endblock %} {% block bar deferred %}bar is deferred now{% endblock %} {# base.twig #} {% block foo deferred %}foo is deferred{% endblock %} {% block bar %}bar is not deferred{% endblock %}
License
The library is released under the MIT License. See the bundled LICENSE file for details.