Download the PHP package beyondcode/laravel-tag-helper without Composer
On this page you can find all versions of the php package beyondcode/laravel-tag-helper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download beyondcode/laravel-tag-helper
More information about beyondcode/laravel-tag-helper
Files in beyondcode/laravel-tag-helper
Package laravel-tag-helper
Short Description Add powerful HTML tag helpers to your Laravel application
License MIT
Homepage https://github.com/beyondcode/laravel-tag-helper
Informations about the package laravel-tag-helper
Laravel Tag Helpers
This package allows you to register custom "tag helpers" in your Laravel application. These helpers can modify the HTML code.
For example, instead of this:
You can use custom tag helpers to turn this code into this:
Installation
You can install the package via composer:
The package will automatically register itself.
Usage
You can create your own Tag Helper, by creating a new class and extend from the BeyondCode\TagHelper\Helper
class.
Within this class you can define on which HTML elements and attributes your helper should be triggered:
To use and apply this tag helper, you need to register it. Typically you would do this in the AppServiceProvider boot()
method or a service provider of your own.
Since you only register the class name of the custom tag helper, you can use dependency injection inside of your custom helper class.
Binding your helper to HTML elements and attributes
In your custom tag helper, you can use the $targetAttribute
and $targetElement
properties to specify which HTML element (div
, form
, a
, etc.) and which attributes (<div custom="value />
, <form method="post">
, etc.) you want to bind this helper to.
If you do not provide a targetElement
on your own, this package will use a *
as a wildcard in order to target all elements with a specific attribute, like this:
This tag helper would be called for every HTML element that has a my-attribute
attribute.
Manipulating DOM Elements
Once your tag helper successfully matches one or multiple HTML elements, the process
method of your tag helper will be called.
Inside of this method, you can manipulate the HTML element.
Available features:
Changing the HTML element tag
In this example, we are binding our helper to HTML elements <my-custom-link href="/"></my-custom-link>
. In the process method, we can then change the tag internally to a
to render this as a link.
Manipulating Attributes
You can also add, edit or delete HTML element attributes.
In this example, we are binding our helper to all link tags that have a custom route
attribute.
We then update the href
attribute of our link, remove the route
attribute and add a new title
attribute.
Manipulating Outer / Inner Text
Your custom tag helpers can you manipulate the HTML that is inside or outside of the current element.
Passing variables to your tag helpers
You can pass attribute values to your tag helpers as you would usually pass attributes to HTML elements. Since the modifications of your tag helpers get cached, you should always return valid Blade template output in your modified attribute values.
You can not directly access the variable content inside of your tag helper, but only get the attribute string representation.
For example, to get the attribute value of the method
attribute:
You can access this data, using the getAttribute
method inside your helper:
If you want to write Blade output, you sometimes need to know if the user passed a variable or function call, or a string value. To tell the difference, users can pass variable data by prefixing the attribute using a colon.
If you want to output this attribute into a blade template, you can then use the getAttributeForBlade
method and it will
either give you an escaped string representation of the attribute - or the unescaped representation, in case it got prefixed by a colon.
For example:
This will output:
But if you pass a dynamic parameter like this:
This will output:
This way you do not need to manually care about escaping and detecting dynamic variables.
Built-In Helpers
This package ships with a couple useful tag helpers out of the box.
CSRF Helper
Just add a csrf
attribute to any form
element to automatically add the Laravel CSRF field to it.
Will become:
Caveats
csrf
needs to be in a line with another attribute.
Form Method Helper
When your form
contains a method
other then GET
or POST
, the helper will automatically add a _method
hidden field with the correct value to your form.
Will become:
Link
When your a
tags contains a route
attribute, this helper will change the href to the appropriate route.
You can also provide a route-parameters
attribute, to pass additional parameters to the route generation.
Examples:
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Marcel Pociot
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-tag-helper with dependencies
illuminate/view Version ~5.5.0|~5.6.0|~5.7.0
sunra/php-simple-html-dom-parser Version ^1.5.2