Including Patterns
To include one pattern within another, for example to create a molecule from several atoms, you can either use:
- a shorthand include syntax or
- the default include syntax for the template language you're using (e.g. Mustache, Twig, Handlebars).
The Shorthand Include Syntaxpermalink
The shorthand include syntax is less verbose than the default include syntax for many template languages. The shorthand syntax uses the following format:
[patternGroup]-[patternName]
For example, to include the following pattern in a molecule:
atoms/images/landscape-16x9.mustache
The shorthand include syntax would be:
atoms-landscape-16x9
The pattern type matches the top-level folder and is atoms. The pattern name matches the template file and is landscape-16x9. Any digits used in the filename for ordering (which is deprecated, use the order parameter instead) are dropped from both the pattern type and pattern name references. Pattern subgroups are never a part of the shorthand include syntax. This way patterns can be re-organized within a pattern type and/or by using digits (which is deprecated, use the order parameter instead) without needing to change your pattern includes.
The following are examples of using the shorthand include syntax with our supported PatternEngines:
{{> atoms-landscape-16x9 }} // Mustache
{% include "atoms-landscape-16x9" %} // Twig
The shorthand syntax also allows for fuzzy matching on pattern names. This means that if you feel your pattern name is going to be unique within a given pattern type you can supply just the unique part of the pattern name and the partial will be included correctly. For example, using the shorthand syntax the pattern atoms-landscape-16x9.mustache could be written as:
atoms-16x9
Warning: Because subgroups are not included in the shorthand include syntax a given pattern name needs to be unique within its pattern type and not just its pattern subgroup. If you run into this problem you can do one of two things:
- use the default include syntax for your template language or
- give your pattern a unique name and use the pattern's documentation to provide the pattern name
The Default Include Syntaxpermalink
If you need more specificity when including patterns the Node version of Pattern Lab also support the include syntax for the template language that you're using. For example, the syntax for Mustache is the path to the pattern minus the .mustache extension. Let's say we wanted to include the following pattern in a molecule:
atoms/images/landscape-16x9.mustache
The default Mustache include syntax would be:
Important: Unlike the shorthand include syntax the template language specific include syntax must include any digits used for ordering (which is deprecated, use the order parameter instead) and subgroup directories. Pattern paths need to be updated when either is changed for a given pattern.
Examples and Gotchaspermalink
Here are some examples of how to include patterns as well as some gotchas.
// partials to match
atoms/global/test.mustache
atoms/global/test-with-picture.mustache
// using the shorthand partials syntax
// will match atoms/global/test.mustache
// will match atoms/global/test-with-picture.mustache
// using the default mustache partials syntax
// will match atoms/global/test.mustache