govuk_publishing_components 37.0.0 → 37.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe726cba8402c5e0b082b9183eb50b531bc4024e0a8d8420e8aa9bc01bf792ee
-  data.tar.gz: a0ca9fdb633e3f78bacd25fe5f6b1d10353d3ec70b49c8881f65c667c8cb5a6f
+  metadata.gz: 43da95e575a63b626abef7368fbe99d286682778b3933f9b021768277b3a8d17
+  data.tar.gz: a2959e0efd156b0c5d5a70b61561725d55a4c67e58f0e60537970439af0088db
 SHA512:
-  metadata.gz: 983fb3da1f16193554ae6f850a6da73ce0a3a4a92df1e430ab8ccc028e50739188f8225a79cfeefd5aca477632b70105349b853e0bce55b704bba91947700dc4
-  data.tar.gz: bdcc215e867f598b8afd6d502ef393656b4bbca8e2059aa21f15bce7838d4a6ff9f02319f13c365c684f780b544272034d6fd0233e4aa7a5f978d3e6529eda50
+  metadata.gz: 60593190a4219cf35788d97f6f491c9f36ad873772d2b3908bcb21c347fcadcd061e35c25225acaa89199f5cabb6f0769376847521738cc26ff23eb088febce5
+  data.tar.gz: 22a37d5ff61c2164ef441774aae4f9268a9a46b19e7d5dbc847b7e290af706ce038894cd70a992ffe525a17e61ad205476bdb1d4eedc5e486a9f006a38532183

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-copy-tracker.js

@@ -0,0 +1,55 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
+window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analyticsModules || {};
+
+(function (analyticsModules) {
+  'use strict'
+
+  var Ga4CopyTracker = {
+    init: function () {
+      window.addEventListener('copy', this.trackCopy.bind(this))
+    },
+
+    trackCopy: function (event) {
+      try {
+        var text = this.getSelectedText()
+        if (!text) {
+          return // do nothing if no text has been selected
+        }
+        var target = event.target.tagName
+        if (target === 'INPUT' || target === 'TEXTAREA') {
+          return // do nothing if text is being copied from an input
+        }
+
+        var PIIRemover = new window.GOVUK.analyticsGa4.PIIRemover()
+        text = window.GOVUK.analyticsGa4.core.trackFunctions.removeLinesAndExtraSpaces(text)
+        text = PIIRemover.stripPIIWithOverride(text, true, true)
+        var length = text.length
+        text = text.substring(0, 30)
+
+        var data = {
+          event_name: 'copy',
+          type: 'copy',
+          action: 'copy',
+          method: 'browser copy',
+          text: text,
+          length: length
+        }
+        window.GOVUK.analyticsGa4.core.applySchemaAndSendData(data, 'event_data')
+      } catch (e) {
+        console.warn('GA4 copy tracker error: ' + e.message, window.location)
+      }
+    },
+
+    getSelectedText: function () {
+      if (window.getSelection) {
+        return window.getSelection().toString()
+      } else if (document.selection) {
+        return document.selection.createRange().text
+      }
+      return false
+    }
+  }
+
+  analyticsModules.Ga4CopyTracker = Ga4CopyTracker
+})(window.GOVUK.analyticsGa4.analyticsModules)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-schemas.js

@@ -30,7 +30,7 @@
         tool_name: this.undefined,
         percent_scrolled: this.undefined,
         video_current_time: this.undefined,
-        video_duration: this.undefined,
+        length: this.undefined,
         video_percent: this.undefined
       }
     }

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-video-tracker.js

@@ -78,7 +78,7 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       data.url = this.handlers['video-' + player.id + '-url']
       data.text = this.handlers['video-' + player.id + '-title']
       data.video_current_time = Math.round(player.getCurrentTime())
-      data.video_duration = this.handlers['video-' + player.id + '-duration']
+      data.length = this.handlers['video-' + player.id + '-duration']
       data.video_percent = position
 
       window.GOVUK.analyticsGa4.core.applySchemaAndSendData(data, 'event_data')

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4.js

@@ -4,6 +4,7 @@
 //= require ./analytics-ga4/pii-remover
 //= require ./analytics-ga4/ga4-page-views
 //= require ./analytics-ga4/ga4-print-intent-tracker
+//= require ./analytics-ga4/ga4-copy-tracker
 //= require ./analytics-ga4/ga4-specialist-link-tracker
 //= require ./analytics-ga4/ga4-link-tracker
 //= require ./analytics-ga4/ga4-event-tracker

data/app/assets/javascripts/govuk_publishing_components/components/option-select.js

@@ -172,7 +172,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
       try {
         buttonAttributes = JSON.parse(buttonAttributes)
         for (var rawKey in buttonAttributes) {
-          var key = rawKey.replace(/_/i, '-').toLowerCase()
+          var key = rawKey.replace(/_/g, '-').toLowerCase()
           var rawValue = buttonAttributes[rawKey]
           var value = typeof rawValue === 'object' ? JSON.stringify(rawValue) : rawValue
           button.setAttribute('data-' + key, value)

data/app/assets/stylesheets/govuk_publishing_components/components/_layout-header.scss

@@ -1,3 +1,4 @@
+@import "govuk_publishing_components/individual_component_support";
 @import "govuk_publishing_components/components/search";
 @import "govuk_publishing_components/components/skip-link";
 @import "govuk/components/header/header";

data/app/views/govuk_publishing_components/components/_feedback.html.erb

@@ -9,10 +9,14 @@
   email_regex = /[^\s=\/?&]+(?:@|%40)[^\s=\/?&]+/
   url_without_pii = utf_encode(request.original_url.gsub(email_regex, '[email]'))
   path_without_pii = utf_encode(request.fullpath.gsub(email_regex, '[email]'))
+
+  disable_ga4 ||= false
+  data_module = "feedback"
+  data_module << " ga4-event-tracker" unless disable_ga4
 %>
 
-<div class="gem-c-feedback govuk-!-display-none-print" data-module="feedback ga4-event-tracker">
-  <%= render "govuk_publishing_components/components/feedback/yes_no_banner" %>
-  <%= render "govuk_publishing_components/components/feedback/problem_form", url_without_pii: url_without_pii %>
-  <%= render "govuk_publishing_components/components/feedback/survey_signup_form", path_without_pii: path_without_pii %>
+<div class="gem-c-feedback govuk-!-display-none-print" data-module="<%= data_module %>">
+  <%= render "govuk_publishing_components/components/feedback/yes_no_banner", disable_ga4: %>
+  <%= render "govuk_publishing_components/components/feedback/problem_form", url_without_pii: url_without_pii, disable_ga4: %>
+  <%= render "govuk_publishing_components/components/feedback/survey_signup_form", path_without_pii: path_without_pii, disable_ga4: %>
 </div>

data/app/views/govuk_publishing_components/components/docs/feedback.yml

@@ -25,3 +25,8 @@ shared_accessibility_criteria:
 examples:
   default:
     data: {}
+  with_ga4_tracking_disabled:
+    description: |
+      Disables GA4 tracking on the feedback component. Tracking is enabled by default, which adds a data module and data-attributes with JSONs to the feedback buttons. See the [ga4-event-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-event-tracker.md) for more information.
+    data:
+      disable_ga4: true

data/app/views/govuk_publishing_components/components/feedback/_problem_form.html.erb

@@ -38,15 +38,21 @@
         rows: 3
       } %>
 
+      <%
+        unless disable_ga4 
+          ga4_submit_button_event = {
+            event_name: "form_submit",
+            type: "feedback",
+            text: t("components.feedback.send", locale: :en),
+            section: t("components.feedback.help_us_improve_govuk", locale: :en),
+          }.to_json
+        end
+      %>
+
       <%= render "govuk_publishing_components/components/button", {
         text: t("components.feedback.send"),
         data_attributes: {
-          ga4_event: {
-            event_name: "form_submit",
-            type: "feedback",
-            text: "Send",
-            section: "Help us improve GOV.UK",
-          }
+          ga4_event: ga4_submit_button_event
         }
       } %>
 

data/app/views/govuk_publishing_components/components/feedback/_survey_signup_form.html.erb

@@ -25,15 +25,21 @@
         describedby: "survey_explanation"
       } %>
 
+      <%
+        unless disable_ga4
+          ga4_send_button_event = {
+            event_name: "form_submit",
+            type: "feedback",
+            text: t("components.feedback.send_me_survey", locale: :en),
+            section: t("components.feedback.help_us_improve_govuk", locale: :en),
+          }.to_json
+        end
+      %>
+
       <%= render "govuk_publishing_components/components/button", {
         text: t("components.feedback.send_me_survey"),
         data_attributes: {
-          ga4_event: {
-            event_name: "form_submit",
-            type: "feedback",
-            text: "Send me the survey",
-            section: "Help us improve GOV.UK",
-          }
+          ga4_event: ga4_send_button_event
         }
       } %>
 

data/app/views/govuk_publishing_components/components/feedback/_yes_no_banner.html.erb

@@ -1,3 +1,28 @@
+<%
+  unless disable_ga4
+    ga4_yes_button_event = {
+      "event_name": "form_submit",
+      "type": "feedback",
+      "text": t("components.feedback.yes", locale: :en), 
+      "section": t("components.feedback.is_this_page_useful", locale: :en),
+      }.to_json
+
+    ga4_no_button_event = {
+      "event_name": "form_submit",
+      "type": "feedback",
+      "text": t("components.feedback.no", locale: :en),
+      "section": t("components.feedback.is_this_page_useful", locale: :en)
+      }.to_json
+
+    ga4_problem_button_event = {
+      "event_name": "form_submit",
+      "type": "feedback",
+      "text": t("components.feedback.something_wrong", locale: :en),
+      "section": t("components.feedback.is_this_page_useful", locale: :en)
+    }.to_json
+  end
+%>
+
 <div class="gem-c-feedback__prompt gem-c-feedback__js-show js-prompt" tabindex="-1">
   <div class="gem-c-feedback__prompt-content">
     <div class="gem-c-feedback__prompt-questions js-prompt-questions" hidden>
@@ -20,14 +45,31 @@
             <% end %>
           </li>
           <li class="gem-c-feedback__option-list-item">
-            <button class="govuk-button gem-c-feedback__prompt-link js-page-is-useful" data-track-category="yesNoFeedbackForm" data-track-action="ffYesClick" data-ga4-event='{"event_name":"form_submit","type":"feedback","text":"Yes", "section": "Is this page useful?"}'>
+            <%= tag.button(
+              class: "govuk-button gem-c-feedback__prompt-link js-page-is-useful",
+              data: {
+                track_category: "yesNoFeedbackForm",
+                track_action: "ffYesClick",
+                ga4_event: ga4_yes_button_event,
+              }) do %>
               <%= t("components.feedback.yes") %> <span class="govuk-visually-hidden"><%= t("components.feedback.is_useful") %></span>
-            </button>
+            <% end %>
           </li>
           <li class="gem-c-feedback__option-list-item">
-            <button class="govuk-button gem-c-feedback__prompt-link js-toggle-form js-page-is-not-useful" data-track-category="yesNoFeedbackForm" data-track-action="ffNoClick" aria-controls="page-is-not-useful" aria-expanded="false" data-ga4-event='{"event_name":"form_submit","type":"feedback","text":"No", "section": "Is this page useful?"}'>
+
+            <%= tag.button(
+              class: "govuk-button gem-c-feedback__prompt-link js-toggle-form js-page-is-not-useful",
+              aria: {
+                controls: "page-is-not-useful",
+                expanded: "false",
+              },
+              data: {
+                track_category: "yesNoFeedbackForm",
+                track_action: "ffNoClick",
+                ga4_event: ga4_no_button_event,
+              }) do %>
               <%= t("components.feedback.no") %> <span class="govuk-visually-hidden"><%= t("components.feedback.is_not_useful") %></span>
-            </button>
+            <% end %>
           </li>
         </ul>
       </div>
@@ -38,9 +80,19 @@
     </div>
 
     <div class="gem-c-feedback__prompt-questions gem-c-feedback__prompt-questions--something-is-wrong js-prompt-questions" hidden>
-      <button class="govuk-button gem-c-feedback__prompt-link js-toggle-form js-something-is-wrong" data-track-category="Onsite Feedback" data-track-action="GOV-UK Open Form" aria-controls="something-is-wrong" aria-expanded="false" data-ga4-event='{"event_name":"form_submit","type":"feedback","text":"Report a problem with this page", "section": "Is this page useful?"}'>
+      <%= tag.button(
+        class: "govuk-button gem-c-feedback__prompt-link js-toggle-form js-something-is-wrong",
+        aria: {
+          expanded: "false",
+          controls: "something-is-wrong"
+        },
+        data: {
+          track_category: "Onsite Feedback",
+          track_action: "GOV-UK Open Form",
+          ga4_event: ga4_problem_button_event,
+        }) do %>
         <%= t("components.feedback.something_wrong") %>
-      </button>
+      <% end %>
     </div>
   </div>
 </div>

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "37.0.0".freeze
+  VERSION = "37.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 37.0.0
+  version: 37.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -452,6 +452,7 @@ files:
 - app/assets/javascripts/govuk_publishing_components/all_components.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-auto-tracker.js
+- app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-copy-tracker.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-core.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-ecommerce-tracker.js
 - app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-event-tracker.js