element119/module-page-builder-custom-data-attributes-commerce

A Magento 2 module that allows custom data to be added to Commerce-specific Page Builder content.

2.0.0 2022-06-06 08:19 UTC

This package is auto-updated.

Last update: 2024-11-06 13:29:11 UTC


README

element119 | Page Builder Custom Data Attributes (Commerce)

status github release github release date magento license packagist downloads

🤝 Compatibility

For Magento Open Source, install element119/module-page-builder-custom-data-attributes instead.


This module is an Adobe Commerce compatible version of element119/module-page-builder-custom-data-attributes. It adds support for the additional Page Builder content types added by Commerce-only modules. This currently includes:

  • Dotdigitalgroup_Enterprise

  • Magento_BannerPagBuilder


Installing this module on Magento Open Source results in errors being thrown due to the modifications that target the Commerce-only content types.


📝 Features

✔️ Allows custom data to be added to Commerce-specific Page Builder content

✔️ Supports custom Page Builder content types

✔️ Gives store admins full over the name and value of custom attributes

✔️ Uses dynamic rows to allow admins to create, edit, and delete custom attributes as required


🔌 Installation

Run the following command to install this module:

composer require element119/module-page-builder-custom-data-attributes-commerce
php bin/magento setup:upgrade

⏫ Updating

Run the following command to update this module:

composer update element119/module-page-builder-custom-data-attributes-commerce

❌ Uninstallation

Run the following command to uninstall this module:

composer remove element119/module-page-builder-custom-data-attributes-commerce
php bin/magento setup:upgrade

🔧 Custom Content Types

To add custom data attributes to custom Page Builder content types simply copy the code below and paste it into the <element name="main"> node of all appropriate view/adminhtml/pagebuilder/content_type/{{custom_content_type}}.xml files.

<attribute name="custom_attributes"
           source="data-custom-attributes"
           converter="Element119_PageBuilderCustomDataAttributes/js/converter/attribute/custom-data-attributes"/>

An expanded XML tree is shown below to serve as an example.

<type name="your_custom_content_type_name">
    <appearances>
        <appearance name="your_custom_content_type_appearance">
            <elements>
                <element name="main">
                    <attribute name="custom_attributes"
                               source="data-custom-attributes"
                               converter="Element119_PageBuilderCustomDataAttributes/js/converter/attribute/custom-data-attributes"/>
                </element>
            </elements>
        </appearance>
    </appearances>
</type>

📚 User Guide

Configuration and Output

full


Notes

The HTML data-custom-attributes attribute will not be added when there is no data to output.

step-4

paypal

For those that want to support this project.