https://github.com/EvanLovely/plugin-twig-namespaces

Pattern Lab plugin for registering new Twig Namespaces
https://github.com/EvanLovely/plugin-twig-namespaces

Last synced: 3 months ago
JSON representation

Pattern Lab plugin for registering new Twig Namespaces

• Host: GitHub
• URL: https://github.com/EvanLovely/plugin-twig-namespaces
• Owner: EvanLovely
• License: mit
• Created: 2016-10-11T20:25:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-10T23:21:47.000Z (about 7 years ago)
• Last Synced: 2024-10-28T10:42:27.620Z (3 months ago)
• Language: PHP
• Size: 10.7 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• component-based-theming - Twig Namespaces Plugin

README

        
[![Packagist](https://img.shields.io/packagist/v/evanlovely/plugin-twig-namespaces.svg)](https://packagist.org/packages/evanlovely/plugin-twig-namespaces) [![Gitter](https://img.shields.io/gitter/room/pattern-lab/php.svg)](https://gitter.im/pattern-lab/php)

# Twig Namespaces Plugin for Pattern Lab

This adds namespaces to Twig in Pattern Lab. 

## Installation

To add this plugin to your project using [Composer](https://getcomposer.org/) type:

    composer require evanlovely/plugin-twig-namespaces

See Packagist for [information on the latest release](https://packagist.org/packages/evanlovely/plugin-twig-namespaces).

## Usage

In `config.yml`, add this:

```yml

plugins:

  twigNamespaces:

    enabled: true

    roots: 

      - ../root1

      - ../root2

    namespaces:

      foo:

        recursive: true

        paths:

          - ../bar

          - ../baz

```

Paths are relative to `composer.json` and `vendor/` in the same directory as the config directory (not config file). Assuming this folder structure

- pattern-lab/

  - config/

    - config.yml

  - composer.json

- root1/

  - 01-mountains/

    - hood.twig

  - 02-rivers

    - sandy.twig

- bar/

    - item1.twig

    - subdir/

        - subitem1.twig

- baz/

    - item2.twig

You could now use this in Twig:

```twig

{% include "@mountains/hood.twig" %}

{% include "@rivers/sandy.twig" %}

{@ include "@foo/item1.twig" %}

{@ include "@foo/subitem1.twig" %}

{@ include "@foo/item2.twig" %}

```

You can use either the `roots` or the `namespaces` approach without the other. The `roots` approach is how Pattern Lab registers the namespaces of all folders under `source/_patterns/` like `@atoms` and is therefore useful for including files from other Pattern Labs (watch out for namespace collisions - i.e. you can only have one `@atoms`). And the `namespaces` approach is how the Drupal [Component Libraries](https://www.drupal.org/project/components) module registers Twig namespaces, though it could also be used to register the core modules template files in Pattern Lab so you could `{% extend "@blocks/block.html.twig" %}` if you'd like. If using `namespaces` and you set `recursive: true`, then it will add all sub directories. 

Also, you can set `twigNamespaces.readFromFile` to a path to a JSON or Yaml file and it will read those contents and use it in place of `twigNamespaces.namespaces`.

## Disabling the Plugin

To disable the plugin you can either directly edit `./config/config.yml` or use the command line option:

    php core/console --config --set plugins.twigNamespaces.enabled=false

---

**Happy Pattern Labbing!**