Skip to content

README.md

Latest commit

 

History

History
186 lines (144 loc) · 4.5 KB

README.md

File metadata and controls

186 lines (144 loc) · 4.5 KB

Data Transform Plugin for Pattern Lab

This plugin now only works with Twig PatternEngine. You can use old 0.x versions of the plugin for Mustache PatternEngine.

Installation

To install and use the plugin run:

composer require aleksip/plugin-data-transform

Features

Pattern-specific data file support for included patterns

Pattern Lab core only supports global data files and a pattern-specific data file for the main pattern. This plugin adds pattern-specific data file support for included patterns.

Data transform functions

Currently the plugin provides four transform functions for the data read by Pattern Lab. The examples provided are in JSON but Pattern Lab supports YAML too!

Include pattern files

If a value contains the name of a pattern in shorthand partials syntax, the plugin will replace the value with the rendered pattern:

{
    "key": "atoms-form-element-label.html"
}

Advanced syntax with support for passing variables and disabling access to the default data:

Nested
{
    "key": {
        "include()": {
            "pattern": "atoms-form-element-label.html",
            "with": {
                "title": "Textfield label"
            },
            "only": true
        }
    }
}

In both examples the value of key will replaced with the rendered pattern.

Parallel
{
    "key": {
        "include()": {
            "pattern": "atoms-form-element-label.html",
            "only": true
        },
        "title": "Textfield label"
    }
}

Parallel syntax work similarly to nested, in that include() settings are passed in nested under include, but all variables to be used inside include() (if with is unset) can be on the same level.

Join text values

Nested
{
    "key": {
        "join()": [
            "molecules-comment.html",
            "<div class=\"indented\">",
            "molecules-comment.html",
            "</div>",
            "molecules-comment.html"
        ]
    }
}

The value of key will be replaced with the joined strings. Note that in the example molecules-comment.html is the name of a pattern in shorthand partials syntax. These will be replaced with the rendered pattern before the join.

Parallel
{
    "key": {
        "join()": true,
        "0": "molecules-comment.html",
        "1": "<div class=\"indented\">",
        "2": "molecules-comment.html",
        "3": "</div>",
        "4": "molecules-comment.html"
    }
}

Parallel syntax works similarly to nested, except join() needs to be set to true.

Create Drupal Attribute objects

Nested
{
    "key": {
        "Attribute()": {
            "id": ["edit-submit"],
            "type": ["submit"],
            "value": ["Submit"],
            "class": ["button", "button-primary"]
        }
    }
}

The value of key will be replaced with an Attribute object.

Parallel
{
    "key": {
        "Attribute()": true,
        "id": ["edit-submit"],
        "type": ["submit"],
        "value": ["Submit"],
        "class": ["button", "button-primary"]
    }
}

Parallel syntax works similarly to nested, except Attribute() needs to be set to true.

Create Drupal Url objects

Nested
{
    "key": {
        "Url()": {
            "url": "http://example.com",
            "options": {
                "attributes": {
                    "Attribute()": {
                        "class": ["link"]
                    }
                }
            }
        }
    }
}

The value of key will be replaced with an Url object. Note that in the example attributes will be replaced with an Attribute object before the Url object is created.

Parallel
{
    "key": {
        "Url()": "http://example.com",
        "options": {
            "attributes": {
                "Attribute()": true,
                "class": ["link"]
            }
        }
    }
}

Parallel syntax works similarly to nested, except Url() needs to be set to the url. Options can be passed in optionally alongside Url().

Global data and includes

Please note that global data from the _data directory is considered to be pattern-specific data and will overwrite data inherited from a parent pattern. If you want to override data of an included pattern you can use the with keyword.

More examples

Most features provided by this plugin are used in Shila Drupal theme.