xervice/atomic

2.0.0 2018-08-27 08:56 UTC

Requires

• php: >=7.1.0
• twig/extensions: ^1.5.0
• xervice/twig: ^3.0.0

Requires (Dev)

• codeception/codeception: *
• phpstan/phpstan: *
• symfony/var-dumper: *

MIT

• Mike Bertram

README

Installation

Register atomic twig extension for atomic design in the TwigDependencyProvider.

<?php

namespace App\Twig;

use Xervice\Atomic\Communication\Twig\AtomicTwigExtension;
use Xervice\Twig\TwigDependencyProvider as XerviceTwigDependencyProvider;

class TwigDependencyProvider extends XerviceTwigDependencyProvider
{
    /**
     * @return array
     */
    protected function getTwigExtensions(): array
    {
        return [
            new AtomicTwigExtension()
        ];
    }
}

Configuration

Using

After using the extension, you can define the following folder structure in your module:

• MyModule
  • Presentation
    • Theme
      • atomic
        • atoms
        • molecules
        • organisms
      • templates
      • pages

Settings You can define settings in your twig template to overwrite them, by embedding components:

    {% setting data = {
        name: 'default'
    } %}

    {{ data.name }}

Example atom MyModule/Presentation/Theme/atomic/atoms/example/example.twig

    {% setting data = {
        name: 'default'
    } %}
    {% block body %}{% endblock %}

Use example atom

    {% embed atom('example', 'MyModule') with {
        data: {
            name: 'Test'
        }
    } %}
        {% block body %}{{ data.name }}{% endblock %}
    {% endembed %}