Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This module adds the possibility to define product symbols (with name, icon, and description), group symbols together, and display them on the frontend, most frequently on the Product Details Page or on tiles.

Table of Contents
minLevel1
maxLevel7

Installation

Info

This module is optional

Code Block
composer require "creativestyle/magesuite-product-symbols" ^1.0.0

User manual

3.9. Product symbols

Admin settings

Add a new symbol group:

...

Name

Type

Default

Note

Is Enabled

Yes/No (required)

Yes

Symbol Name

string (required)

Symbol Icon

Upload image or select from Gallery. Maximum file size: 50 MB.

Short Description

string

Description

string

Add CMS Page

select

Choose a block that will be displayed on PDP details page

Groups

multi select

Select from previously defined groups

Sort Order

number

0

Add condition for a symbol

...

Assign symbol/symbols to a product

For the specific product open the Product Symol tab and choose the desired badge or badges:

...

Backend

Note

TODO - BE documentation and review of documentation is needed

...

Code Block
  <referenceBlock name="product.info.details.main">
      <block class="MageSuite\ProductSymbols\Block\Symbol\Group" name="product.info.details.main.symbols" as="product.symbols" template="MageSuite_ProductSymbols::symbols/group.phtml">
          <arguments>
              <argument name="included_groups" xsi:type="array">
                  <item name="0" xsi:type="string">symbols</item>
              </argument>
          </arguments>
      </block>
  </referenceBlock>

Example:

...

Display the same CMS content based on symbols on PDPs

If a static block is set in Add CMS Page content of this block (f.e. CC components) will be displayed on choose PDPs.

First, create a block with CMS content.

Then create a new symbol or edit an existing one. Assigned block with CMS content - Add CMS Page option.

...

Create a rule for the symbol, f.e:

...

As a result, an additional CMS section is displayed on PDPs that meet symbol condition criteria.

...

A new section will be displayed on PDPs of products that have the given symbols assigned. It will be placed just below CC section in the details area.

Code Block
<referenceBlock name="product.info.details">
    <block name="symbol.cms" template="MageSuite_ProductSymbols::product/view/cms.phtml" group="detailed_info">
        <arguments>
            <argument name="title" translate="true" xsi:type="string">Product Showcase</argument>
            <argument name="sort_order" xsi:type="string">40</argument>
            <argument name="contain_content" xsi:type="boolean">false</argument>
            <argument name="is_collapsible" xsi:type="boolean">false</argument>
            <argument name="in_nav" xsi:type="boolean">false</argument>
            <argument name="symbol_view_model" xsi:type="object">MageSuite\ProductSymbols\ViewModel\Symbol\Group</argument>
        </arguments>
    </block>
</referenceBlock>