-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48 from customgento/DEV-241-child-product-data
Dev 241 child product data
- Loading branch information
Showing
8 changed files
with
196 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. | ||
|
|
||
| entries: | ||
| - title: Sidebar | ||
| levels: one | ||
| folders: | ||
|
|
||
| - title: ChildProductData (M2) | ||
| output: web | ||
| folderitems: | ||
| - title: Description | ||
| url: "#description" | ||
| output: web | ||
| - title: Key Features | ||
| url: "#key-features" | ||
| output: web | ||
| - title: Usage Instructions | ||
| url: "#usage-instructions" | ||
| output: web | ||
| - title: Requirements | ||
| url: "#requirements" | ||
| output: web | ||
| - title: Compatibility | ||
| url: "#compatibility" | ||
| output: web | ||
| - title: Installation Instructions | ||
| url: "#installation-instructions" | ||
| output: web | ||
| - title: Troubleshooting | ||
| url: "#troubleshooting---i-installed-the-extension-but-it-does-not-work" | ||
| output: web | ||
| - title: Uninstallation | ||
| url: "#uninstallation" | ||
| output: web | ||
| - title: Support | ||
| url: "#support" | ||
| output: web | ||
| - title: Licence | ||
| url: "#licence" | ||
| output: web | ||
| - title: Copyright | ||
| url: "#copyright" | ||
| output: web |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: Child Product Data for Magento 2 | ||
| permalink: child-product-data-m2.html | ||
| summary: "The extension Child Product Data for Magento 2 is a powerful module for Magento, designed to enhance the user experience and provide customers with detailed information about products. With this module installed, customers can directly access the data of child products associated to a configurable product." | ||
| sidebar: cpd_m2_sidebar | ||
| toc: false | ||
| --- | ||
|
|
||
| ## Description | ||
|
|
||
| On a configurable product page, you usually only see the attribute data of the configurable product itself. This extension allows you to display the data of the child products on this page and the values are dynamically changed as soon as you choose a different child product. This way, customers can easily compare the data of the child products and make a well-informed decision. | ||
|
|
||
| ### Key Features: | ||
|
|
||
| 1. **Dynamic Change of Product Data:** As soon as a customer chooses an option of a configurable product, the values of the following attributes are adapted: | ||
| - Product Name | ||
| - SKU | ||
| - Short Description | ||
| - Description | ||
| - "More Information" Block | ||
| - Related Products | ||
| - Upsell Products | ||
| 2. **Seamless Hyvä Compatibility:** The extension is fully compatible with the Hyvä theme, ensuring a smooth integration and an aesthetically pleasing presentation. Your online store can now leverage the power of Hyvä's modern design and user-friendly interface while providing enhanced product information. | ||
| 3. **Universal Hyvä Theme Support:** The extension is not only compatible with the default Hyvä theme. It works also with any Hyvä child theme. You only need to enter the fitting identifiers in the system configuration, and the module will do the rest. | ||
| 4. **Developer-Friendly Architecture:** For developers, Child Product Data offers an easily integrable solution with well-documented code. It follows the Magento 2 coding standards and best practices. | ||
|
|
||
| ## Usage Instructions | ||
| Child Product Data is by default built for a clean Hyvä Theme. | ||
| If you're using Hyvä or a child theme without any adaptions to the product page, you do not need to configure anything at all. | ||
| It will work directly out of the box. The only exception are the related and upsell products. Here, we're still waiting for a Hyvä update to make it work out of the box. Until then, please include the changes from [this Merge Request](https://gitlab.hyva.io/hyva-themes/magento2-default-theme/-/merge_requests/979/diffs){:target="_blank"} in your custom theme. | ||
| As soon as you have a different HTML structure on your product page, you simply need to fill in the fitting identifiers under Store > Config > Catalog > Catalog > Child Product Data. | ||
| Please mind, that a specific attribute could be included at several spots on the page. For example the name of the product is also included in the breadcrumbs. In this case, please enter each identifier in a new line. | ||
| To find out which identifiers you need to use, you can simply inspect the HTML of your product page and look for the fitting elements. | ||
|
|
||
| ![Settings configuration]({{ "images/child-product-data/child-product-data-settings-fields.png" }} "Settings configuration") | ||
|
|
||
| After entering the correct identifiers, please save the configuration and clear the cache. From now on, as soon as you choose a child product, the module will show the child data for the identifiers you configured, for example the adapted product name or the SKU. | ||
| If you do not want to change the data for a specific attribute, you can simply leave the field empty. | ||
|
|
||
| ![Output]({{ "images/child-product-data/child-product-data-output.png" }} "Product page with changed child data (e.g. breadcrumbs, title, SKU)") | ||
|
|
||
| ## Requirements | ||
| - hyva-themes/magento2-default-theme: `~1.0` | ||
| - magento/framework: `~102.0||~103.0` | ||
| - magento/module-catalog: `~103.0||~104.0` | ||
| - magento/module-configurable-product: `~100.4` | ||
| - magento/module-eav: `~102.0` | ||
| - magento/module-store: `~101.0` | ||
| - php: `~7.4.0||~8.1.0||~8.2.0` | ||
|
|
||
| ## Compatibility | ||
| - Hyvä Theme >= `1.0.0` | ||
| - Magento >= `2.4` | ||
|
|
||
| ## Installation Instructions | ||
| The installation procedure highly depends on your setup. In any case, you should use a version control system like git and test the installation on a development system. | ||
| If you are using composer (you should!) and downloaded the extension from the Marketplace or have set up your own composer repository, we recommend installing via composer. | ||
|
|
||
| ### Composer Installation | ||
| 1. `composer require customgento/module-child-product-data` | ||
| 2. `bin/magento module:enable CustomGento_ChildProductData` | ||
| 3. `bin/magento setup:upgrade` | ||
| 4. `bin/magento setup:di:compile` | ||
| 5. `bin/magento cache:flush` | ||
|
|
||
| ### Manual Installation | ||
| 1. unzip the downloaded files | ||
| 2. create the directory `app/code/CustomGento/ChildProductData/`: `mkdir -p app/code/CustomGento/ChildProductData/` | ||
| 3. copy the unzipped files to the newly created directory `app/code/CustomGento/ChildProductData/` | ||
| 4. `bin/magento module:enable CustomGento_ChildProductData` | ||
| 5. `bin/magento setup:upgrade` | ||
| 6. `bin/magento setup:di:compile` | ||
| 7. `bin/magento cache:flush` | ||
|
|
||
| ## Troubleshooting - I installed the extension, but it does not work | ||
| 1. Do you use the latest version of the extension? | ||
| 2. Do you use Magento >= 2.4? | ||
|
|
||
| ## Uninstallation | ||
| The uninstallation procedure depends on your setup: | ||
|
|
||
| ### Uninstallation After Composer Installation | ||
| 1. `bin/magento module:uninstall CustomGento_ChildProductData` | ||
| 2. `bin/magento setup:di:compile` | ||
| 3. `bin/magento cache:flush` | ||
|
|
||
| ### Uninstallation After Manual Installation | ||
| 1. `bin/magento module:disable CustomGento_ChildProductData` | ||
| 2. `bin/magento setup:di:compile` | ||
| 3. `bin/magento cache:flush` | ||
| 4. `rm -r app/code/CustomGento/ChildProductData` | ||
|
|
||
| ## Support | ||
| If you have any issues with this extension, feel free to [contact us](https://www.customgento.com/){:target="_blank"}! | ||
|
|
||
| ## Licence | ||
| [CustomGento Commercial Software Licence](https://www.customgento.com/license){:target="_blank"} | ||
|
|
||
| ## Copyright | ||
| © 2023 - present CustomGento GmbH | ||
|
|