Skip to main content

MageMe WebForms Magento 2 Module | Hyvä Compatibility

This guide provides detailed instructions on installing the Hyva_MageMeWebForms compatibility module, which integrates WebForms functionalities seamlessly with Hyva Themes.

warning

WebForms 3.3 or later is required for Hyvä Theme compatibility. Make sure you have the correct version installed before proceeding.

info

For older WebForms 3 versions, you need to get the compatibility module from https://gitlab.hyva.io/hyva-themes/hyva-compat/magento2-mageme-webforms

Prerequisites​

  • Magento 2: Ensure Magento 2 is installed on your server.
  • Server Access: You must have administrative access to your server's command line.
  • Composer: Confirm that Composer is installed for managing Magento 2 components.
  • Hyvä Themes: Hyvä Themes must be installed in your Magento 2 environment.
  • WebForms: Version 3.3 or later must be installed.

Step 1: Install the Hyva Compatibility Module Fallback​

Before installing the Hyva_MageMeWebForms module, install the Hyva Compatibility Module Fallback. This module ensures compatibility between Hyva Themes and WebForms.

  1. Add the repository for the Hyva Compatibility Module Fallback to your Magento 2 installation: 
    composer config repositories.hyva-themes/magento2-compat-module-fallback git git@gitlab.hyva.io:hyva-themes/magento2-compat-module-fallback.git
  2. Install the module: 
    composer require hyva-themes/magento2-compat-module-fallback
  3. Enable the module: 
    php bin/magento module:enable Hyva_CompatModuleFallback
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento cache:clean

Step 2: Install the Hyva_MageMeWebForms Compatibility Module​

Install the compatibility module to integrate WebForms with Hyva Themes.

  1. Install the module using Composer: 
    composer require mageme/module-webforms-3-hyva
  2. Enable the module: 
    php bin/magento module:enable Hyva_MageMeWebForms
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento cache:clean

Hyvä Theme Developer Configuration Settings​

The Hyvä Theme Developer Configuration page provides an array of customizable settings for developers to control the visual layout and behavior of forms in Magento 2. These settings are specifically tailored to the Hyvä theme, offering flexibility for developers to enhance user interface elements such as form layouts, field layouts, input elements, and validation messages. The settings allow you to apply custom CSS classes to various components of the form, enabling precise styling and behavior adjustments.

Key Settings Include:​

  • Form Layout: Adjusts the overall form structure, including CSS classes for the form container and fieldset.
  • Field Layout: Customizes the layout of individual field blocks.
  • Input Elements: Provides options to style text inputs, textareas, select dropdowns, radio buttons, checkboxes, and time input fields with specific CSS classes.
  • Labels and Messages: Allows customization of label and message appearance, including field labels, validation messages, and success messages.

Location in Admin:​

  • Navigate to Stores -> Configuration -> WebForms -> Hyvä Theme Developer to access these settings.

This configuration page is essential for Magento 2 developers who want to fine-tune form presentation without direct template modifications, using CSS to achieve a visually cohesive user experience.

Verify Installation​

  1. Check module status:

    php bin/magento module:status

    Ensure Hyva_CompatModuleFallback and Hyva_MageMeWebForms are listed as enabled.

  2. Test the integration on your website to confirm that WebForms features adapt well to your Hyva theme.

Conclusion​

With the Hyva_MageMeWebForms module installed and configured, you can leverage the powerful quoting capabilities of WebForms with the aesthetic and performance benefits of Hyva Themes. If you encounter issues, refer to module documentation or contact support for assistance.