Option to delay loading GTM until user interaction is triggered

yireo · Jun 19, 2023 · fad2369 · fad2369
1 parent a7b7a74
commit fad2369
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.4.0] - 19 June 2023
 ### Added
-- Delay loading GTM until user interaction is triggered
+- Option to delay loading GTM until user interaction is triggered
 
 ## [3.3.4] - 16 June 2023
 ### Fixed

diff --git a/Config/Config.php b/Config/Config.php
@@ -80,6 +80,16 @@ public function isDebug(): bool
         return (bool)$this->getModuleConfigValue('debug');
     }
 
+    /**
+     * Wait for user interaction to start
+     *
+     * @return bool
+     */
+    public function waitForUserInteraction(): bool
+    {
+        return (bool)$this->getModuleConfigValue('wait_for_ui');
+    }
+
     /**
      * Check whether mouse clicks are debugged as well
      *

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "yireo/magento2-googletagmanager2",
-  "version": "3.3.4",
+  "version": "3.4.0",
   "license": "OSL-3.0",
   "type": "magento2-module",
   "homepage": "https://www.yireo.com/software/magento-extensions/googletagmanager2",

diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -53,6 +53,13 @@
                         <field id="debug">1</field>
                     </depends>
                 </field>
+                <field id="wait_for_ui" type="select" translate="label" sortOrder="4" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Wait for user interaction</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <depends>
+                        <field id="enabled">1</field>
+                    </depends>
+                </field>
                 <field id="category_products" translate="label" sortOrder="5" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Maximum Products in Category</label>
                     <comment>Maximum number of products to load in a specific category overview. 0 to disable</comment>

diff --git a/etc/config.xml b/etc/config.xml
@@ -6,6 +6,7 @@
                 <enabled>0</enabled>
                 <id/>
                 <debug>0</debug>
+                <wait_for_ui>0</wait_for_ui>
                 <category_products>3</category_products>
                 <product_eav_attributes>material</product_eav_attributes>
                 <category_eav_attributes>id,name</category_eav_attributes>

diff --git a/view/frontend/templates/script.phtml b/view/frontend/templates/script.phtml
@@ -29,7 +29,7 @@ $config = $block->getConfig();
         events.forEach(function (eventType) {
             window.addEventListener(eventType, initYireoGoogleTagManager2, {once: true, passive: true})
         })
-    })(['keydown', 'mouseover', 'scroll', 'touchstart', 'wheel']);
+    })([<?php if ($config->waitForUserInteraction() === false) : ?>'load', <?php endif; ?>'keydown', 'mouseover', 'scroll', 'touchstart', 'wheel']);
 </script>
 
 <?php if ($config->isDebug()): ?>