Topdata Compare Products Manual
Welcome to the documentation for the “Topdata Compare Products” plugin. This manual will guide you through the setup and functionality.
Navigation:
- Configuration Guide: Learn about all available settings in the plugin configuration.
- Usage Guide: See how the product comparison feature works from a customer’s perspective.
Usage Guide
This guide explains how customers can use the product comparison feature on your storefront.
Adding Products to Compare
- A customer can add a product to the comparison list by clicking the compare icon (
<sw_icon 'chart-bar-filled'>). This icon appears on product boxes in category listings and on the product detail page. - After clicking the icon, a small modal window confirms that the product has been added.
- The total number of products being compared will appear in the shop’s header.
The Comparison Modal
Customers can view the comparison list by clicking on the “Compare products” link in the header. This opens a full-screen modal with the following features:
- Products Display: Compared products are shown side-by-side in columns, displaying their image, title, price, and an “add to cart” button.
- Property Table: Below the products, a table lists all relevant properties.
- Different Values: Properties where the products have different values are highlighted with an icon (
<sw_icon 'x'>). - Same Values: Properties where all products share the same value are marked with an icon (
<sw_icon 'checkmark'>).
- Different Values: Properties where the products have different values are highlighted with an icon (
- Group Tabs: If product grouping is active in the plugin configuration, customers will see tabs at the top of the modal. They can switch between different comparison groups (e.g., “Smartphones” and “Tablets”).
- Removing a Product: Each product in the comparison has a remove (
<sw_icon 'x'>) button to take it off the list.
Filtering and Viewing Options
Within the modal, several controls are available:
- Show Properties Differences / All: A button that allows the user to toggle between viewing all properties and viewing only the properties that have different values among the products.
- Hide/Show Properties: A button to collapse or expand the entire properties table.
- Show on Page: This button opens a new, shareable page that displays the current comparison. This is useful for sending a direct link to someone.
- Share Link: On mobile devices, a “Share Comparison” button appears, allowing users to easily share the URL of the comparison page.
Configuration Guide
This guide explains all the configuration options for the “Topdata Compare Products” plugin. You can find these settings in your Shopware Admin under Extensions > My Extensions > Topdata Compare Products > Configuration.
Product Grouping
This section controls how products are grouped for comparison.
-
Show compare button:
- When enabled, a compare icon is displayed on product boxes in listings and on the product detail page.
- If you have the “Topdata Product Menu” plugin installed, a compare option will also be added to that menu.
-
Allow compare products without special property:
- If you define a “Property to group products” (see below), this setting determines the behavior for products that do not have that specific property.
- Enabled (Default): Products without the grouping property can still be added to a default comparison group.
- Disabled: Only products that possess the selected grouping property can be compared.
-
Maximum number of products in the comparison group:
- Sets the maximum number of products that can be compared against each other within a single group (e.g., in one tab of the compare modal). Default is 4.
-
Maximum number of comparison groups:
- Sets the maximum number of different comparison groups (tabs) that can be active at the same time. Default is 4.
- This is relevant if a “Property to group products” is selected, as products with different values for that property will create separate groups.
-
Property to group products:
- Allows you to select a product property (e.g., “Device Type”) to be used for grouping.
- When a user adds a product, they will be added to a comparison group based on their value for this property (e.g., all “Smartphones” in one group, all “Tablets” in another).
- If no property is selected, all products are added to one universal comparison group.
-
Hidden properties:
- Allows you to select one or more property groups that should be hidden from the comparison table. This is useful for excluding irrelevant or technical properties.
Compare Extra Fields
This section allows you to include non-property fields in the comparison table.
- Show product number: When enabled, the product number is displayed for each item in the comparison.
- Show EAN: When enabled, the EAN is displayed for each item.
- Show manufacturer product number: When enabled, the Manufacturer Product Number (MPN) is displayed for each item.
- Compare weight: When enabled, product weight is included as a comparable attribute.
- Compare width: When enabled, product width is included as a comparable attribute.
- Compare height: When enabled, product height is included as a comparable attribute.
- Compare length: When enabled, product length is included as a comparable attribute.
- Compare by custom fields:
- Select custom fields to be included in the comparison table.
- Supported field types:
text,number,date/time,checkbox,active switch,colour picker, andselect. Other types will be ignored.