backendorf / module-installment
Add installment feature to Magento 2 catalog
Package info
github.com/backendorf/magento2-installment
Language:HTML
Type:magento2-module
pkg:composer/backendorf/module-installment
Requires
- magento/framework: ^102.0 || ^103.0
- magento/module-catalog: ^103.0 || ^104.0
README
A powerful and flexible Magento 2 module designed to display installment values and strategic discounts directly on your storefront catalog and product pages. Now fully compatible with Hyvä Themes while maintaining support for Luma/Standard themes.
🚀 Features
- Multi-Theme Support: Native support for Hyvä Themes (Alpine.js) and Luma/Standard themes (jQuery).
- Installment Display: Show installment options across Product, Category, and Search pages.
- Strategic Discounts: Display custom discounts (e.g., PIX, Bank Transfer) with automatic calculation and deduplication.
- Configurable Logic:
- Define maximum installments and minimum installment value.
- Support for Simple and Compound interest calculations.
- Customizable Interest: Set specific interest rates for each installment level.
- Flexible Templates: Specific price templates for
catalog_category_view,catalogsearch_result_index, andcatalog_product_view. - Custom Styling: Control primary colors, highlight text colors, and font weights directly from the admin panel.
⚡ Hyvä Integration
This module is built to leverage Hyvä's performance:
- Alpine.js Components: Lightweight and reactive installment calculations.
- Tailwind CSS: Automatically registers module templates for the Tailwind CSS build process.
- CSP Compatible: All JavaScript components are built to comply with Content Security Policy.
🛠️ Installation
Using Composer (Recommended)
composer require backendorf/module-installment
Enable the Module
bin/magento module:enable Backendorf_Installment bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush
For Hyvä Themes
To ensure Tailwind classes are generated correctly for your theme:
bin/magento hyva:config:generate
⚙️ Configuration
Navigate to Stores > Configuration > Backendorf > Installment to configure:
- General Settings: Enable/Disable the module, set installment limits, and display behavior.
- Interest Rates: Configure calculation types and specific rates per installment.
- Discounts: Add dynamic discount rules based on percentages.
- Price Templates: Customize the HTML output for different page types.
- Styles: Personalize the look and feel (colors and typography) to match your brand.
📋 Requirements
- Magento 2.4.x
- PHP 8.1+
- Hyvä Themes (Optional, but fully supported)
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.