headzoo/polymer-bundle

Symfony bundle and Twig extension for developing and deploying Polymer web components.

Installs: 84

Dependents: 0

Suggesters: 0

Security: 0

Stars: 11

Watchers: 5

Forks: 6

Open Issues: 4

Type:symfony-bundle

0.0.5.1 2015-06-14 22:54 UTC

This package is not auto-updated.

Last update: 2024-03-16 14:30:35 UTC


README

Symfony bundle and Twig extension for developing and deploying Polymer web components.

Build Status Documentation MIT License

Polyphonic Symfony

This bundle is no where near production ready. Use at your own risk.

The purpose of this bundle is making it easier to use and build Polymer web components within a Symfony project. Polyphonic handles the problems that come up when trying to build and use web components within Twig templates.

Example Element

A simple example of using the {% polymer element %} Twig tag to create a custom <hello-world><hello-world> element. This element displays "Hello, World!" by default, but the message can be changed by setting the name attribute.

Note that there's no need to add <link rel="import" href="polymer/polymer.html"> as the import statement is added automatically. The template is saved in the bundle directory at Resources/public/elements/hello-world/hello-world.html.twig.

{% polymer element "hello-world" attributes="name" %}
    <template>
        <p>Hello, {{name}}!</p>
    </template>
    <script>
        Polymer({
            name: "World"
        });
    </script>
{% endpolymer %}

Using the element in your views:

{% polymer import "@AcmeBundle:hello-world/hello-world.html.twig" %}

<!-- Displays "Hello, World!" -->
<hello-world></hello-world>

<!-- Displays "Hello, Pascal!" -->
<hello-world name="Pascal"></hello-world>

Requirements

PHP 5.5.*
Symfony 2.6.*

Installing

Add headzoo/polymer-bundle to your composer.json requirements.

"require": {
    "headzoo/polymer-bundle": "0.0.3"
}

Run composer update and then add the bundle your AppKernel.php.

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
            new Symfony\Bundle\SecurityBundle\SecurityBundle(),
            ...
            new Headzoo\Bundle\PolymerBundle\PolymerBundle(),
        )
        
        return $bundles;
    }
}

Add the following route to your app/config/routing_dev.yml file.

polymer:
	resource: "@PolymerBundle/Resources/config/routing.yml"
	prefix:   /_polymer

Next: Read the full documentation