Download the PHP package magehx/htmx-actions without Composer
On this page you can find all versions of the php package magehx/htmx-actions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download magehx/htmx-actions
More information about magehx/htmx-actions
Files in magehx/htmx-actions
Package htmx-actions
Short Description Magento 2 module that provides a base controller to manage HTMX requests.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package htmx-actions
MageHx_HtmxActions
A Magento 2 module that enhances HTMX integration by providing structured controllers, events, view models, services, and enums to streamline dynamic HTML responses.
An HTMX request expects an HTML snippet in response, which will be dynamically swapped into the frontend page.
This module provides many utilities to ease this process.
It offers a convenient base for handling common HTMX response scenarios, allowing you to return HTML fragments efficiently and consistently.
✨ Features
- Abstract Controller: Simplifies handling HTMX requests with a base controller.
- Event Dispatching: Fires events during the HTMX request lifecycle for extensibility.
- View Models: Provides view models to assist in rendering HTMX attributes in templates.
- Header Management Service: Offers a service to manage HTMX-specific response headers.
- Enumerations: Defines enums for HTMX attributes and headers to ensure consistency.
- HTMX Attribute Renderers: Includes traits for rendering HTMX attributes in templates.
📦 Installation
Install the module via Composer:
🔧 Usage
Abstract Controller
Extend the MageHx\HtmxActions\Controller\HtmxAction to handle HTMX requests:
getBlockResponse()- This allows to retrieve a block response from the given layout handles.getMultiBlockResponse()- This allows to retrieve combined blocks response from the given layout handles.getEmptyResponse()- Gives empty response. Useful when you decided to not swap the content in the frontend.
Event Dispatching
The controller dispatches useful events during the HTMX request lifecycle:
hxactions_block_response_before: Fires before preparing the block response. Useful to add more layout handles or change the block itself.hxactions_block_response_after: Fires after preparing the block response. Useful to change the response.hxactions_multi_blocks_response_before: Fires before preparing the multi block response.hxactions_multi_blocks_response_after: Fires after preparing the multi block response.
Observers can be created to listen to these events for custom logic.
View Models
MageHx\HtmxActions\ViewModel\HxAttributesRenderer provides many convenient ways to render HTMX attributes on HTML elements
The outputs will look like this:
You can also chain attributes using the hxBuilder() method for rendering HTMX attributes. Example:
This will also give you the same result as in the first case.
There are many other methods supported like get, indicator, swap and many more.
Header Management Service
Utilize the MageHx\HtmxActions\Service\HtmxHeaderReader to manage HTMX request/response headers:
and there are many more such useful header methods available there.
Enumerations
The module defines enums for HTMX attributes and headers:
HtmxCoreAttributes: Includesget,post,target,swap,trigger, etc.HtmxAdditionalAttributes: Includesboost,indicator, etc.HtmxHeaders: IncludesHX-Trigger,HX-Redirect,HX-Refresh, etc.
These enums ensure consistency and reduce typos in attribute names.
🔗 Requirements
- Magento 2.4.0+
- PHP 8.1+
🛠️ License
This module is open-sourced software licensed under the MIT license.
💬 Feedback / Contributions
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
