Download the PHP package namics/twig-nitro-library without Composer
On this page you can find all versions of the php package namics/twig-nitro-library. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download namics/twig-nitro-library
More information about namics/twig-nitro-library
Files in namics/twig-nitro-library
Package twig-nitro-library
Short Description Extension to embrace the Terrific frontend methodology in Twig. Currently it adds a custom component tag to Twig which mimics Nitro's handlebars helper.
License MIT
Homepage https://github.com/namics/twig-nitro-library
Informations about the package twig-nitro-library
Terrific Twig
Extension to embrace the Terrific frontend methodology in Twig.
Adds a custom component
tag to Twig which mimics the Nitro handlebars helper.
Installation
Using composer:
Requirements
The following versions of PHP are currently supported.
- 8.0
- 8.1
Setup
Step 1: Implement TemplateInformationProvider
Step 2: Implement ContextProviderInterface
Step 3: Add TerrificLoader
Step 4: Add TerrificExtension
Step 5: Profit!
Usage
Documentation
Extension
The extension provides terrific extensions to Twig. Currently, the extension provides the ComponentTokenParser
.
Token Parser
The token parser contains the parsing step for the component tag. It tokenizes the stream to different nodes (component
, data
) and an attribute (only
).
The functionality is based on the fantastic Twig_TokenParser_Include
.
Node
The Node compiles the tokenized tag to PHP. To see some of the output, check the ComponentTest
.
Loader
The TerrificLoader
loads templates contained inside the given paths. An implementation of TemplateLocatorInterface
provides the paths where the loader should search for templates. Recursively loads any directories contained inside the given directories.
Template Information Provider
An implementation of TemplateInformationProviderInterface
should return a list of paths where templates live. These should be in the form of ['frontend/components/atoms', 'frontend/components/molecules', 'frontend/components/organisms']
. The component directory will be provided by the TerrificLoader
(Example/example.[ext]
).
Context Provider
This is the tricky part. An implementation of ContextProviderInterface
decides which data will be made available to Twig templates.
TODO: More on that.
ConfigReader
Reads nitro's config.json
and parses essential information such as the component paths and file extension.
Tests
Tests can be run by using the following command:
CI
This project uses GitHub actions.
Run locally
- Install nektos/act.
- Open terminal, go to project directory.
- Run
act -P ubuntu-latest=shivammathur/node:latest
as described here.
Credits
This project is partially sponsored by Namics.