Download the PHP package studiometa/twig-toolkit without Composer

Twig toolkit

A set of useful extension and components for Twig.

Installation

Usage

Add the Studiometa\TwigToolkit\Extension to your Twig instance:

If you pass a Twig\Loader\FilesystemLoader instance to the extension constructor, a meta namespace pointing to the templates/ folder of this package will be added. You will then be able to include components from this package with the @meta alias:

Reference

Namespace

When provided with a \Twig\Loader\FilesystemLoader parameter, the extension will register a @meta namespace referring to the templates folder of this package. You will be able to import file in this folder directly from you project's templates:

Functions

{{ html_classes(<classes>) }}

A function to manage classes more easily.

Params

• classes (String | Array | Object)

Examples

{{ html_styles(<styles>) }}

A function to manage style attributes more easily.

Params

• styles (Object)

Examples

{{ html_attributes(<attrs>) }}

A function to render HTML attributes more easily with the following features:

• The class attribute will automatically be processed by the class method described above
• Array and objects will be converted to JSON
• Attributes keys will be converted from any format to kebab-case
• Values will be escaped to prevent XSS attacks

Params

• attrs (Object): The attributes to render

Examples

{{ merge_html_attributes(attr, default_attr, required_attr) }}

Merge HTML attributes smartly, useful to define default and required attributes at the component level and allow users to add custom ones.

This filter can also be used as a function.

Params

• attr (Object): The user provided attributes
• default (Object): The default attributes
• required (Object): The required attributes

Examples

You can define default and required attributes in a component's template:

And then include your component with custom attributes:

You can take advantage of named arguments to avoid passing a value for the default attributes argument:

{{ twig_toolkit_url(string) }}

Wrapper for the Spatie\Url\Url class to easily manipulate URLs. See the spatie/url documentation for details on its API.

Params

• url (string): The URL to parse for manipulation

Examples

Tags

{% html_element '<tag>' with attrs %}

Render an HTML element with the given attributes. Useful to avoid setting dynamic HTML element tags with the <{{ tag }}>...</{{ tag }}> pattern.

Params

• tag (String): The name of the tag
• attrs (Object): An object describing the element's attribues

Examples