hampe/zurb-ink-bundle

Creating email templates is hard. This Bundle provides help.

Installs: 7 137

Dependents: 0

Stars: 8

Watchers: 5

Forks: 4

Language: PHP

1.0.8 2015-03-21 11:16 UTC

README

Creating email templates is hard. This Symfony Bundle provides some help:

  • Zurb Ink Integration for awesome and responsive emails. Checkout their documentation.
  • Use normal CSS files for styling, add them via {{ zurb_ink_styles.add("@YourBundle/Resources/public/css/styles.css") }}.
  • Automatic inline styles via the {% ìnlinestyle %} tag (powered by Tijs Verkoyen's CssToInlineStyles).
  • Imports your CSS rules also in html head via {{ includeStyles(zurb_ink_styles) }}

Installation

You can install this bundle using composer

composer require hampe/zurb-ink-bundle

or add the package to your composer.json file directly.

After you have installed the package, you just need to add the bundle to your AppKernel.php file:

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Hampe\Bundle\ZurbInkBundle\HampeZurbInkBundle(),
    // ...
);

Usage

Option A: Extend the base.html.twig

If you want to use the zurb ink framework, extend the HampeZurbInkBundle::base.html.twig.

{% extends 'HampeZurbInkBundle::base.html.twig' %}
{% block preHtml %}
    {# add your css files here, please use a bundle relative path #}
    {{ zurb_ink_styles.add("@YourBundle/Resources/public/css/style1.css") }}
    {{ zurb_ink_styles.add("@YourBundle/Resources/public/css/style2.css") }}
    ...
{% endblock %}
{% block body %}
    {# html #}
{% endblock %}

Note: If you prefer not to have the CSS-Styles also in the <head> of your HTML-Document, you can override the headStyles-Block: {% block headStyles %}{% endblock %}. Be aware that some CSS-Rules can't be realized with inline-styles, like :hover-States or @media-Queries (both uesed by ZURB Ink Framework)!

Option B: Write your own template from scratch

{# add your styles before the inlinestyle tag #}
{{ zurb_ink_styles.add("@YourBUndle/Resources/public/css/style.css") }}
{% inlinestyle %}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <meta name="viewport" content="width=device-width"/>
        <style type="text/css">
            {% autoescape false %}
                {{ includeStyles(zurb_ink_styles) }}
            {% endautoescape %}
        </style>
    </head>
    <body>
    {% block body %}

    {% endblock %}
    </body>
</html>
{% endinlinestyle %}

License

See the LICENSE file for license info (it's the MIT license).