t3g / symfony-template-bundle
TYPO3 Template Bundle
Installs: 18 433
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 6
Forks: 4
Open Issues: 13
Language:Twig
Type:symfony-bundle
Requires
- php: ^8.1
- erusev/parsedown: ^1.7 || 2.*.*@dev
- knplabs/knp-menu-bundle: ^2.2 || ^3.0
- knplabs/knp-paginator-bundle: ^3.0 || ^4.0 || ^5.0
- setasign/fpdi: ^2.3
- symfony/asset: ^5.4 || ^6.4
- symfony/dependency-injection: ^5.4 || ^6.4
- symfony/deprecation-contracts: ^2.5 || ^3.0
- symfony/form: ^5.4 || ^6.4
- symfony/framework-bundle: ^5.4 || ^6.4
- symfony/http-kernel: ^5.4 || ^6.4
- symfony/security-bundle: ^5.4 || ^6.4
- symfony/translation: ^5.4 || ^6.4
- symfony/twig-bundle: ^5.4 || ^6.4
- tecnickcom/tcpdf: ^6.7
- twig/twig: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- overtrue/phplint: ^3.0 || ^4.0
- symfony/phpunit-bridge: ^5.4 || ^6.4
- symfony/webpack-encore-bundle: ^1.13
Suggests
- symfony/webpack-encore-bundle: Needed to support encore entrypoints.
- dev-master
- 4.0.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.6
- 3.3.5
- 3.3.4
- 3.3.3
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.1
- 3.2.0
- 3.1.0
- 3.0.0
- 2.17.1
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.1
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.1
- 2.11.0
- 2.10.1
- 2.10.0
- 2.9.0
- v2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.1
- 2.1.0
- 2.0.1
- 2.0.0
- 1.0.0
- dev-dependabot/npm_and_yarn/chart.js-4.4.6
- dev-dependabot/npm_and_yarn/yaireo/tagify-4.31.6
- dev-feature/application-organization
- dev-dependabot/npm_and_yarn/multi-9f37c16f8f
- dev-task/public-profile-pages
- dev-dependabot/npm_and_yarn/chart.js-4.4.5
- dev-dependabot/npm_and_yarn/stylelint-16.10.0
- dev-dependabot/npm_and_yarn/multi-9423f4c335
- dev-dependabot/npm_and_yarn/multi-cf87d80143
- dev-dependabot/npm_and_yarn/multi-d66d039ac5
- dev-dependabot/npm_and_yarn/webpack-5.94.0
- dev-test/twig-version
- dev-dependabot/npm_and_yarn/fortawesome/fontawesome-free-6.6.0
- dev-dependabot/npm_and_yarn/ws-8.17.1
- dev-dependabot/npm_and_yarn/braces-3.0.3
- dev-bugfix/more-precise-relative-time
This package is auto-updated.
Last update: 2024-10-29 07:55:54 UTC
README
This package is used across various TYPO3 Symfony Applications to ensure a streamlined visual experience and reduced maintenance.
- Symfony Template Bundle
- Installation
- Configuration
- Page Template
- EMail Template
- Utilities
- Twig Extensions
- Twig Tags
- JavaScript Libraries
Installation
composer require t3g/symfony-template-bundle
Ensure that symfony default scripts are present in your composer.json
file.
{ "scripts": { "auto-scripts": { "cache:clear": "symfony-cmd", "assets:install %PUBLIC_DIR%": "symfony-cmd" }, "post-install-cmd": [ "@auto-scripts" ], "post-update-cmd": [ "@auto-scripts" ] } }
Configuration
The bundle comes with a sensible default configuration, which is listed below. You can define these options if you need to change them:
# config/packages/template.yaml template: application: # Example: Intercept name: 'Template Bundle' # Example: intercept platformkey: ~ copyright: author: TYPO3 GmbH url: https://typo3.com routes: # Example: app_index home: app_index privacy: https://typo3.com/privacy-policy legal: https://typo3.com/legal-notice feedback: https://support.typo3.com menu: # Example: App\Menu\MenuBuilder class: T3G\Bundle\TemplateBundle\Menu\MenuBuilder assets: # Example: app encore_entrypoint: ~ email: legal_footer: | TYPO3 GmbH, Emanuel-Leutze-Straße 11, DE-40547 Düsseldorf, Germany Phone: +49 (0)211 20 54 36 0, Web: www.typo3.com, Email: info@typo3.com Court of registration: Amtsgericht Düsseldorf HRB 77950 CEO: Daniel Fau, (CTO & Procuration) Frank Nägler Supervisory Board: Olivier Dobberkau, Ric van Westhreenen, Stefan Busemann theme: # Example: md navbar_breakpoint: lg use_logo: false background: light
bin/console config:dump-reference template
Configuration will be available within the templates and can be accessed through template
variable.
Examples:
<title>{% block title %}{% endblock %} - {{ template.application.name }}</title>
<a class="navbar-brand" href="{{ path(template.application.routes.home) }}"> <i class="fab fa-typo3 text-primary"></i> <strong>{{ template.application.name }}</strong> </a>
Encore
composer require symfony/webpack-encore-bundle
To enable your encore entrypoint simply configure the key within the yaml configuration.
# config/packages/template.yaml template: application: assets: encore_entrypoint: app
Extending Menus
# config/packages/template.yml template: application: menu: class: App\Menu\MenuBuilder
<?php namespace App\Menu; use T3G\Bundle\TemplateBundle\Menu\MenuBuilder as TemplateMenuBuider; class MenuBuilder extends TemplateMenuBuider { public function mainDefault(array $options) { $menu = parent::mainDefault($options); $menu->addChild( 'home', [ 'route' => 'app_index', 'label' => 'Home', 'extras' => [ 'icon' => 'home', ], ] ); return $menu; } }
Available methods to override mainDefault
, mainProfile
and mainFooter
.
Dividing Menus
$menu->addChild($this->getDivider());
Page Template
Extend Default Layout
{% extends '@Template/layout.html.twig' %}
Available Blocks
title
{% block title %}Home{% endblock %}
<title>Home - {{ template.application.name }}</title>
headline
This block will only be rendered obove the body block if defined in the template.
{% block headline %}Super Headline{% endblock %}
<div class="page-wrapper"> <!-- HEADER --> <!-- FLASHMESSAGES --> <main class="page-main"> <div class="content-section content-section-small bg-primary text-white"> <div class="container"> <h1 class="h2">Super Headline</h1> </div> </div> <!-- BODY BLOCK --> </main> <!-- FOOTER --> </div>
body
{% block body %} <div class="content-section"> <div class="container"> BODY CONTENT </div> </div> {% endblock %}
<div class="page-wrapper"> <!-- HEADER --> <!-- FLASHMESSAGES --> <main class="page-main"> <!-- HEADLINE --> <div class="content-section"> <div class="container"> BODY CONTENT </div> </div> </main> <!-- FOOTER --> </div>
footer
{% block footer %} <div class="content-section"> <div class="container"> FOOTER CONTENT </div> </div> {% endblock %}
<div class="page-wrapper"> <!-- HEADER --> <!-- FLASHMESSAGES --> <!-- MAIN HEADLINE AND BODY --> <footer class="page-footer"> <div class="content-section"> <div class="container"> FOOTER CONTENT </div> </div> <!-- COPYRIGHT AND FOOTER MENU --> </footer> </div>
stylesheets
Stylesheet block will be rendered after the base
and encore
css before the closing </head>
.
javascripts
JavaScript block will be rendered after base
and encore
javascript before the closing </body>
.
EMail Template
Extend Default Layout
{% extends '@Template/email.html.twig' %}
Available Blocks
email_subject
{% block email_subject %}Reset Your Password{% endblock %}
email_plaintext
{% block email_plaintext %} Forgot your password? Let's get you a new one. We got a request to change the password for the account with the username {{ user.username }}. You can reset your password by accessing {{ confirmationUrl }} If you don't want to reset your password, you can ignore this email. {% endblock %}
email_html_preview
{% block email_html_preview %} You requested a password reset for your account. {% endblock %}
email_html_body
{% block email_html_body %} <h3>Forgot your password?<br>Let's get you a new one.</h3> <p>We got a request to change the password for the account with the username <strong style="color: #222222;">{{ user.username }}</strong>.</p> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="buttonBlock" style="min-width:100%;"> <tbody class="buttonBlockOuter"> <tr> <td style="padding-top: 36px; padding-right:18px; padding-bottom:36px; padding-left:18px;" valign="top" align="center" class="buttonBlockInner"> <table border="0" cellpadding="0" cellspacing="0" class="buttonContentContainer" style="border-collapse: separate !important;border-radius: 3px;background-color: #ff8700;"> <tbody> <tr> <td align="center" valign="middle" class="buttonContent" style="font-family: "Helvetica Neue", Helvetica, Arial, Verdana, sans-serif; font-size: 16px; padding: 18px;"> <a class="button " title="Reset Your Password" href="{{ confirmationUrl }}" rel="noopener noreferrer" target="_blank" style="font-weight: bold;letter-spacing: -0.5px;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;">Reset Your Password</a> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <p style="font-size: 12px;">Or reset your password using this link: {{ confirmationUrl }}</p> <p style="font-size: 12px;">If you don't want to reset your password, you can ignore this email.</p> {% endblock %}
Utilities
AvatarUtility::getAvatar(string $email, int $size)
<?php use T3G\Bundle\TemplateBundle\Utility\AvatarUtility; echo AvatarUtility::getAvatar('info@typo3.com', 32); // <img src="https://...avatar.png" class="avatar" height="32" width="32">
AvatarUtility::getAvatarUrl(string $email, int $size)
<?php use T3G\Bundle\TemplateBundle\Utility\AvatarUtility; echo AvatarUtility::getAvatarUrl('info@typo3.com', 32); // https://...avatar.png
Twig Extensions
AutolinkExtension
autolink
Twig filter to automaticly convert urls, emails and phone numbers to links.
{{ value|autolink }}
or
{% apply autolink %} <p> Phone: +49 (0)211 205436-0<br> Web: www.typo3.com<br> Email: info@typo3.com </p> {% endapply %}
<p> Phone: <a href="tel:+492112054360">+49 (0)211 205436-0</a><br> Web: <a href="https://www.typo3.com" target="_blank" rel="noopener">www.typo3.com</a><br> Email: <a href="mailto:info@typo3.com">info@typo3.com</a> </p>
AvatarExtension
avatar
Twig function to display avatars.
{{ avatar('info@typo3.com', 32) }}
<img src="https://...avatar.png" class="avatar" height="32" width="32">
IconExtension
icon
Twig function to display typo3 icons.
{{ icon('actions-heart', 'auto') }}
<span class="icon icon-size-auto icon-state-default"> <span class="icon-markup"> <svg role="img" class="icon-color"><use xlink:href="/bundles/template/icons/sprites/actions.svg#actions-heart"></use></svg> </span> </span>
MarkdownExtension
markdown
Twig function to render markdown as HTML.
{{ value|markdown }}
TemplateExtension
template_function_exist
A function to check if a function is available within the current Twig Environment.
{% if template_function_exist('relativetime') %} The relativetime function is available. {% endif %}
template_function_call
Twig always checks for all functions with a template, also within a condition. This function is a wrapper around the original function call that is only executed if the function actually exists.
# Template will still work if `encore_entry_link_tags` is not defined, function just returns null. {{ template_function_call('encore_entry_link_tags', template.application.assets.encore_entrypoint) }} # Template will fail if `encore_entry_link_tags` is not registered. {{ encore_entry_link_tags(template.application.assets.encore_entrypoint) }}
DateTimeExtension
to_datetime
Converts a unix timestamp to datetime object.
{{ to_datetime(timestamp) }}
localdate
Returns a localized string representing this date.
{{ localdate(datetimeObject) }}
localdatetime
Returns a localized string representing this datetime.
{{ localdatetime(datetimeObject) }}
relativetime
Returns a string representation of a time relative to now, such as "in two days". Rounds down by default.
For possible values see luxon documentation.
Usage
{{ relativetime(datetimeObject) }}
Example
With specific time units.
{{ relativetime(datetimeObject, ['minutes', 'seconds']) }}
timediff
Returns a string representing the difference between a date and now() such as "1 year and 11 months".
{{ timediff(datetimeObject) }}
Twig Tags
frame
Usage
{% frame with options %}Inner Content{% endframe %}
Example
{% frame with { id: 'identifier', color: 'primary', center: true } %} <p class="lead">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p> {% endframe %}
<div id="identifier" class="frame frame-size-default frame-background-primary frame-no-backgroundimage frame-space-before-none frame-space-after-none"> <div class="frame-container"> <div class="frame-inner text-center"> <p class="lead">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p> </div> </div> </div>
expand
Usage
{% expand %}Inner Content{% endexpand %}
Example
{% expand %} <p class="lead">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p> {% endexpand %}
<div class="expander"> <input class="expander-checkbox" type="checkbox" id="expander-6267e5f76fa06"> <label for="expander-6267e5f76fa06" class="expander-toggle"> Show more </label> <div class="expander-content"> <div class="expander-content-inner"> <p class="lead">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p> </div> </div> </div>
JavaScript Libraries
Datepicker
The library can be enabled and configured through the attribute data-datepicker
, pass the configuration as json encoded string.
Example HTML
<input type='text' name='date' placeholder='Select Date...' data-datepicker='{}' class="form-control" >
<input type='text' name='date' placeholder='Select Datetime...' data-datetimepicker='{}' class="form-control" >
Example FormBuilder
$builder->add('date', DateType::class, [ 'widget' => 'single_text', 'attr' => [ 'placeholder' => 'Select Date...', 'data-datepicker' => json_encode( [], JSON_THROW_ON_ERROR ), ], 'html5' => false ]);
$builder->add('date', DateTimeType::class, [ 'widget' => 'single_text', 'attr' => [ 'placeholder' => 'Select Datetime...', 'data-datetimepicker' => json_encode( [], JSON_THROW_ON_ERROR ), ], 'html5' => false ]);
Source: https://flatpickr.js.org/
Choices
The library can be enabled and configured through the attribute data-choicesjs
, pass the configuration as json encoded string.
Example HTML
<select name='country' data-choicesjs='{"maxItemCount":1}' > <option value="">Please select a country</option> ... <option value="DE" selected="selected">Germany</option> <option value="GH">Ghana</option><option value="GI">Gibraltar</option> <option value="GL">Greenland</option><option value="GD">Grenada</option> ... </select>
Example FormBuilder
$builder->add('country', ChoiceType::class, [ 'attr' => [ 'data-choicesjs' => json_encode( [ 'maxItemCount' => 1, ], JSON_THROW_ON_ERROR ), ], 'choices' => $countryChoices, 'empty_data' => null, 'placeholder' => 'Please select a country', ]);
Source: https://github.com/jshjohnson/Choices
Taginput
The library can be enabled and configured through the attribute data-taginput
, pass the configuration as json encoded string.
Example FormBuilder
$builder->add('usernames', TextType::class, [ 'attr' => [ 'data-taginput' => json_encode([], JSON_THROW_ON_ERROR), ], ]); $usernames = array_map( function($item) { return $item['value']; }, json_decode($form->getData()['usernames'], true) );
Source: https://github.com/yairEO/tagify