Skip to content

Commit

Permalink
Fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-kl1 committed Aug 11, 2024
1 parent 2cdadf4 commit 80d0072
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 13 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Packagist](https://img.shields.io/packagist/dt/opengento/module-product-breadcrumbs.svg?style=flat-square)](https://packagist.org/packages/opengento/module-product-breadcrumbs/stats)
[![Packagist](https://img.shields.io/packagist/dm/opengento/module-product-breadcrumbs.svg?style=flat-square)](https://packagist.org/packages/opengento/module-product-breadcrumbs/stats)

This module allows to toggle server side rendered breadcrumb for product pages.
This module allows to toggle server side rendered breadcrumbs for product pages.

- [Setup](#setup)
- [Composer installation](#composer-installation)
Expand Down Expand Up @@ -41,13 +41,16 @@ bin/magento setup:upgrade

## Features

This module is Hyva-ready!
This module render server-sided product breadcrumb so it's visible to any robot without requiring any js loads and process.
Can you still enable the js breadcrumb so your user can see natural breadcrumbs following their navigation.
This module render server-sided product breadcrumbs so it's visible to any robot without requiring any js loads and process.
Can you still enable the js breadcrumbs so your user can see natural breadcrumbs following their navigation.

If your store use Hyva theme, this module works out-of-the-box when the breadcrumbs is server-side rendering. If you want
to print a default breadcrumb then override it with client-side rendering, you need to override the client-side rendered
breadcrumbs template and update the script.

## Documentation

- Toggle render server side the product rbeadcrumbs
- Toggle render server side the product breadcrumbs
- Toggle allows client side to override product breadcrumbs based on navigation
- Select best strategy to generate the product breadcrumbs (native, deepest, shallowest)
- Exclude some root categories from being used to generate the breadcrumbs
Expand Down
6 changes: 3 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "opengento/module-product-breadcrumbs",
"description": "This module allows to toggle server side rendered breadcrumb for product pages.",
"description": "This module allows to toggle server side rendered breadcrumbs for product pages.",
"keywords": [
"php",
"magento",
Expand All @@ -15,10 +15,10 @@
"require": {
"php": "^8.1",
"magento/framework": "*",
"magento/module-backend": "*",
"magento/module-config": "*",
"magento/module-store": "*",
"magento/module-catalog": "*"
"magento/module-catalog": "*",
"magento/module-theme": "*"
},
"require-dev": {
"magento/magento-coding-standard": "^33",
Expand Down
13 changes: 9 additions & 4 deletions etc/adminhtml/system.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,28 @@
<section id="catalog">
<group id="seo">
<field id="render_product_breadcrumbs_server_side" translate="label comment" type="select" sortOrder="30" showInDefault="1" canRestore="1">
<label>Render Product Breadcrumbs from Server Side</label>
<comment>This setting depends of the theme. For Hyva store, also use the hyva settings.</comment>
<label>Render Product Breadcrumbs from Server-Side</label>
<comment>This setting depends of the theme. If your store use Hyva theme, disable client-side breadcrumbs rendering.</comment>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<config_path>catalog/seo/render_product_breadcrumbs_server_side</config_path>
</field>
<field id="override_product_breadcrumbs_client_side" translate="label comment" type="select" sortOrder="31" showInDefault="1" canRestore="1">
<label>Override Product Breadcrumbs on Client Side</label>
<comment>This setting depends of the theme. For Hyva store, also use the hyva settings.</comment>
<label>Override Product Breadcrumbs on Client-Side</label>
<comment>If your store use Hyva theme, this setting is by-passed. You may want to enable the Hyva client-side breadcrumbs rendering.</comment>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<config_path>catalog/seo/override_product_breadcrumbs_client_side</config_path>
</field>
<field id="product_breadcrumbs_strategy" translate="label" type="select" sortOrder="32" showInDefault="1" canRestore="1">
<label>Product Breadcrumbs Strategy</label>
<source_model>Opengento\ProductBreadcrumbs\Model\Config\Source\Strategies</source_model>
<config_path>catalog/seo/product_breadcrumbs_strategy</config_path>
</field>
<field id="product_breadcrumbs_exclude_categories" translate="label comment" type="multiselect" sortOrder="33" showInDefault="1" canRestore="1">
<label>Product Breadcrumbs Excluded Categories</label>
<source_model>Opengento\ProductBreadcrumbs\Model\Config\Source\TopLevelCategories</source_model>
<can_be_empty>1</can_be_empty>
<comment>Leave empty to allow all categories on breadcrumbs.</comment>
<config_path>catalog/seo/product_breadcrumbs_exclude_categories</config_path>
</field>
</group>
</section>
Expand Down
2 changes: 1 addition & 1 deletion etc/module.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Opengento_ProductBreadcrumbs">
<sequence>
<module name="Magento_Backend"/>
<module name="Magento_Config"/>
<module name="Magento_Store"/>
<module name="Magento_Catalog"/>
<module name="Magento_Theme"/>
<module name="Hyva_Theme"/>
</sequence>
</module>
</config>

0 comments on commit 80d0072

Please sign in to comment.