Install the Product Comparison feature

This document describes how to install the Product Comparison feature.

Install feature frontend

Follow the steps below to install the Product Comparison feature frontend.

Prerequisites

Install the required features:

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/product-comparison:"202410.0" --update-with-dependencies

2) Add translations

Add translations as follows:

1. Append glossary for the feature:

product_comparison_page.page_title,Artikel vergleichen,de_DE
product_comparison_page.page_title,Compare products,en_US
product_comparison_page.empty_comparison,Vergleichsliste ist leer.,de_DE
product_comparison_page.empty_comparison,Comparison list is empty.,en_US
product_comparison_page.clear-compare-list,Vergleichsliste leeren,de_DE
product_comparison_page.clear-compare-list,Clear the comparison list,en_US
product_comparison_page.add_to_comparison-list,Vergleichen,de_DE
product_comparison_page.add_to_comparison-list,Compare,en_US
product_comparison_page.remove_from_comparison-list,Aus Vergleich entfernen,de_DE
product_comparison_page.remove_from_comparison-list,Remove from Compare,en_US
product_comparison_page.list_link,Artikelvergleich,de_DE
product_comparison_page.list_link,Product comparison,en_US
product_comparison_page.add_to_comparison.success,Zum Vergleich hinzugefügt,de_DE
product_comparison_page.add_to_comparison.success,Added to comparison,en_US
product_comparison_page.add_to_comparison.error.max,Das Limit ist bereits erreicht,de_DE
product_comparison_page.add_to_comparison.error.max,The limit has already been reached,en_US
product_comparison_page.removed_from_the_list,Artikel wurde aus der Vergleichsliste entfernt.,de_DE
product_comparison_page.removed_from_the_list,Product was removed from the comparison list.,en_US

2. Import data:

console data:import glossary

3) Set up router plugins

Register the following route provider plugins:

src/Pyz/Yves/Router/RouterDependencyProvider.php

<?php

namespace Pyz\Yves\Router;

use Spryker\Yves\Router\RouterDependencyProvider as SprykerRouterDependencyProvider;
use SprykerShop\Yves\ProductComparisonPage\Plugin\Router\ProductComparisonPageRouteProviderPlugin;

class RouterDependencyProvider extends SprykerRouterDependencyProvider
{
    /**
     * @return list<\Spryker\Yves\RouterExtension\Dependency\Plugin\RouteProviderPluginInterface>
     */
    protected function getRouteProvider(): array
    {
        return [
            new ProductComparisonPageRouteProviderPlugin(),
        ];
    }
}

4) Set up widgets

Set up widgets as follows:

1. Register the following plugins to enable widgets:

src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php

<?php

namespace Pyz\Yves\ShopApplication;

use SprykerShop\Yves\ProductComparisonWidget\Widget\ComparisonProductTogglerComparisonListWidget;
use SprykerShop\Yves\ProductComparisonWidget\Widget\LinkToProductComparisonListWidget;
use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider;

class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider
{
    /**
     * @return list<string>
     */
    protected function getGlobalWidgets(): array
    {
        return [
            ComparisonProductTogglerComparisonListWidget::class,
            LinkToProductComparisonListWidget::class,
        ];
    }
}

2. Enable Javascript and CSS changes:

console frontend:yves:build