parisek / twig-typography
A Twig extension with typography filter
Requires
- php: ^8.3
- mundschenk-at/php-typography: ^6.0
- symfony/yaml: ^6.0 || ^7.0 || ^8.0
- twig/twig: ^3.27 || ^4.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.0
- friendsofphp/php-cs-fixer: ^3.0
- phpstan/phpstan: ^2.0
- phpunit/phpunit: ^11.0 || ^12.0
This package is auto-updated.
Last update: 2026-06-01 16:23:30 UTC
README
Twig adapter for PHP-Typography — smart quotes, dashes, ellipses, hyphenation, widow protection, fraction glyphs, ordinal suffixes, math symbols, CSS hooks for styling.
Requirements
- PHP 8.3+
- Twig 3 or 4
- Symfony YAML 6, 7, or 8 (always installed as a hard dependency; only invoked at runtime when the constructor receives a
.ymlfile path)
Installation
composer require parisek/twig-typography
Usage
Register on a Twig environment
use Parisek\Twig\TypographyExtension; use Twig\Environment; use Twig\Loader\FilesystemLoader; $twig = new Environment(new FilesystemLoader('/path/to/templates')); // Library defaults — sane English settings. $twig->addExtension(new TypographyExtension()); // — or — load settings from a YAML file: $twig->addExtension(new TypographyExtension(__DIR__ . '/typography.yml')); // — or — pass settings as a PHP array (no filesystem): $twig->addExtension(new TypographyExtension([ 'set_smart_quotes' => true, 'set_smart_dashes' => true, ]));
In templates
{{ title|typography }}
{{ "Lorem ipsum"|typography }}
{# Override constructor defaults for one call: #}
{{ title|typography({ set_smart_dashes: false }) }}
The filter is is_safe: html — its output may contain <sup>, <span class="…">,
and similar markup, and is emitted unescaped.
Configuration
Every key in your YAML or array becomes a method call on
PHP-Typography's Settings class.
The library's full Settings(true) defaults are applied first; your
values override them.
Example: Czech (cs-CZ) settings
# typography.yml — Czech smart typography set_diacritic_language: "cs" # Smart quotes — Czech style „double" and ‚single' set_smart_quotes: TRUE set_smart_quotes_primary: "doubleLow9" # „ … " set_smart_quotes_secondary: "singleLow9" # ‚ … ' # Smart dashes — Czech/EU: en-dash with spaces (not US em-dash) set_smart_dashes: TRUE set_smart_dashes_style: "international" # Smart spacing set_single_character_word_spacing: TRUE # k/s/v/z/o/u/i/a + nbsp — required in CZ set_unit_spacing: TRUE # "5 kg" → "5 kg" set_dewidow: FALSE # last-line widow protection — bad for responsive layouts # Wrapping helpers set_hyphenation: FALSE # leave to CSS `hyphens: auto` + `lang="cs"` set_url_wrap: FALSE set_email_wrap: FALSE
What's not included
This extension exposes PHP-Typography as one Twig filter, |typography.
There's no {% typography %} block tag (despite earlier versions of this
README claiming one — the tag was never implemented in code). To apply
typography to a block of HTML, wrap it in an element and apply the filter
to the rendered string, or define a Twig macro
that encapsulates the pattern you want.
License
GPL-2.0-or-later, see LICENSE.txt.