Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

https://github.com/magesuite/product-symbols

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.

Installation

This module is optional

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

Admin settings

Add a new symbol group:

Catalog -> Product Symbols Groups -> Create new group

Settings

Name

Type

Default

Note

Group Name

string

Ignore product assignment

Yes/No

No

All symbols assigned to this group will be displayed. Symbol selection on product page will be ignored.

Group code

string

Group Code This field can be modified only during group creation

Add a new symbol:

Catalog -> Product Symbol -> Create new symbol

Settings:

Symbols details

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

Groups

multi select

Select from previously defined groups

Sort Order

number

0

Backend

TODO - BE documentation and review of documentation is needed

Frontend

On the frontend side, there is only one template: view/frontend/templates/symbols.group.phtml

It displays symbols from a defined group. Sample XML code (PDP):

  <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:

  • No labels