govuk_publishing_components 29.1.0 → 29.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ea9dce00e2fc90b3a88d941fa237f4d276295be027676233cf31cbf904bec0
-  data.tar.gz: c3ff5045ff3c0f0be4df536e1ea165c896d01e1b680c4f98f838bc213f4d3931
+  metadata.gz: 831296f6233744d3d669b023b5f8243ee118f51ce7b1ba3b8c5f510346b87b9c
+  data.tar.gz: 7d01de1a9e86110a92c486394cf5a1ee509ca3421037cac5b6281b5ecb209690
 SHA512:
-  metadata.gz: 1fe533fa65e9d6d6e97e94d388e1176031f4bdf9eb896867b7f81ba56deb790fc630383060aab98f3e7f09f5f6b8547db2c27d19519631a97fbdd135f6314759
-  data.tar.gz: 3c7659b2fd425a674de931fee53307329f12586aced6775dde5ae21b982661205a1eaab6aacbdf714bbd81e31e7f095184582bf25ca00b323d57410c45d790b4
+  metadata.gz: a0cf8c3cebef33691aab437ff16219573f6d7b0132b266cc28178ae8a06c8e3034ed04275611876cccff7e63418ab38bf7564e17cb1ba98bc2fa877b8743f32c
+  data.tar.gz: 86bb5adec0ebb031efc467ec4bc566f790a1e466fdd454edf4fdca1e94946db467d660d9413943146a720271f34ef97e35d0fda6801d0de01559b832111b73bb

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

@@ -3,7 +3,7 @@
 
   var GOVUK = global.GOVUK || {}
   // For usage and initialisation see:
-  // https://github.com/alphagov/govuk_frontend_toolkit/blob/master/docs/analytics.md#create-an-analytics-tracker
+  // https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics/analytics.md
 
   var Analytics = function (config) {
     this.pii = new GOVUK.Pii()

data/app/assets/javascripts/govuk_publishing_components/analytics/custom-dimensions.js

@@ -57,6 +57,7 @@
       'rendering-application': { dimension: 20 },
       'search-autocomplete-status': { dimension: 21 },
       'navigation-legacy': { dimension: 30, defaultValue: 'none' },
+      'navigation-list-type': { dimension: 31, defaultValue: 'none' },
       'navigation-page-type': { dimension: 32, defaultValue: 'none' },
       'taxon-slug': { dimension: 56, defaultValue: 'other' },
       'taxon-id': { dimension: 57, defaultValue: 'other' },

data/app/assets/javascripts/govuk_publishing_components/analytics/page-content.js

@@ -13,6 +13,8 @@
         return document.querySelectorAll('[data-track-count="accordionSection"]').length
       case isDocumentCollectionPage():
         return document.querySelectorAll('.document-collection .group-title').length
+      case isNewBrowsePage():
+        return document.querySelectorAll('[data-track-count="cardList"]').length
       case isMainstreamBrowsePage():
         return countVisible(document.querySelectorAll('#subsection ul')) || document.querySelectorAll('#section ul').length || document.querySelectorAll('#root ul').length
       case isTopicPage():
@@ -44,6 +46,8 @@
         return document.querySelectorAll('a[data-track-category="navAccordionLinkClicked"]').length
       case isDocumentCollectionPage():
         return document.querySelectorAll('.document-collection .group-document-list li a').length
+      case isNewBrowsePage():
+        return document.querySelectorAll('[data-track-count="cardLink"]').length
       case isMainstreamBrowsePage():
         return countVisible(document.querySelectorAll('#subsection ul a')) || document.querySelectorAll('#section ul a').length || document.querySelectorAll('#root ul a').length
       case isTopicPage():
@@ -67,6 +71,7 @@
   var metaApplicationSelector = 'meta[name="govuk:rendering-application"]'
   var metaFormatSelector = 'meta[name="govuk:format"]'
   var metaNavigationTypeSelector = 'meta[name="govuk:navigation-page-type"]'
+  var metaSectionSelector = 'meta[name="govuk:section"]'
 
   function getMetaAttribute (selector) {
     var element = document.querySelector(selector)
@@ -93,6 +98,12 @@
       getMetaAttribute(metaNavigationTypeSelector) === 'leaf'
   }
 
+  function isNewBrowsePage () {
+    return getMetaAttribute(metaApplicationSelector) === 'collections' &&
+      getMetaAttribute(metaSectionSelector) === 'new_browse_page' &&
+      getMetaAttribute(metaFormatSelector) === 'mainstream_browse_page'
+  }
+
   function isMainstreamBrowsePage () {
     return getMetaAttribute(metaApplicationSelector) === 'collections' &&
       getMetaAttribute(metaFormatSelector) === 'mainstream_browse_page'

data/app/assets/javascripts/govuk_publishing_components/components/accordion.js

@@ -13,6 +13,9 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
     this.sectionClassExpanded = 'govuk-accordion__section--expanded'
     this.sectionHeaderClass = 'govuk-accordion__section-header'
     this.sectionInnerContent = 'govuk-accordion__section-content'
+    this.showAllControls = 'govuk-accordion__show-all'
+    this.sectionButton = 'govuk-accordion__section-button'
+    this.headingText = 'govuk-accordion__section-heading-text'
 
     // Translated component content and language attribute pulled from data attributes
     this.$module.actions = {}
@@ -27,12 +30,21 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
   GemAccordion.prototype.init = function () {
     // Indicate that JavaScript has worked
     this.$module.classList.add('gem-c-accordion--active')
+    this.$module.querySelector('.' + this.showAllControls).classList.add('gem-c-accordion__show-all')
 
     // Feature flag for anchor tag navigation used on manuals
     if (this.$module.getAttribute('data-anchor-navigation') === 'true') {
       this.openByAnchorOnLoad()
       this.addEventListenersForAnchors()
     }
+    // Feature flag for "Show all sections" GA click event tracking
+    if (this.$module.getAttribute('data-track-show-all-clicks') === 'true') {
+      this.addAccordionOpenAllTracking()
+    }
+    // Feature flag for each section GA click event tracking
+    if (this.$module.getAttribute('data-track-sections') === 'true') {
+      this.addEventListenerSections()
+    }
   }
 
   // Navigate to and open accordions with anchored content on page load if a hash is present
@@ -90,5 +102,38 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
     }
   }
 
+  // To track the Accordion's "Show all sections" / "Hide all sections" button click events and pass them to the GA event tracking
+  GemAccordion.prototype.addAccordionOpenAllTracking = function () {
+    this.$module.querySelector('.' + this.showAllControls).addEventListener('click', function (event) {
+      var expanded = event.target.getAttribute('aria-expanded') === 'true'
+      var label = expanded ? 'Show all sections' : 'Hide all sections'
+      var action = expanded ? 'accordionOpened' : 'accordionClosed'
+      var options = { transport: 'beacon', label: label }
+      if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
+        window.GOVUK.analytics.trackEvent('pageElementInteraction', action, options)
+      }
+    })
+  }
+
+  GemAccordion.prototype.addEventListenerSections = function () {
+    var sections = this.$module.querySelectorAll('.' + this.sectionButton)
+    nodeListForEach(sections, function (section) {
+      section.addEventListener('click', this.addAccordionSectionTracking.bind(this, section))
+    }.bind(this))
+  }
+
+  // If the Accordion's sections are opened on click, then pass them to the GA event tracking
+  GemAccordion.prototype.addAccordionSectionTracking = function (section) {
+    var expanded = section.getAttribute('aria-expanded') === 'false'
+    var label = section.querySelector('.' + this.headingText).textContent
+    var action = expanded ? 'accordionOpened' : 'accordionClosed'
+    var options = { transport: 'beacon', label: label }
+
+    if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
+      window.GOVUK.analytics.trackEvent('pageElementInteraction', action, options)
+      console.log('pageElementInteraction', action, options)
+    }
+  }
+
   Modules.GemAccordion = GemAccordion
 })(window.GOVUK.Modules)

data/app/assets/stylesheets/govuk_publishing_components/components/_accordion.scss

@@ -1,2 +1,7 @@
 @import "mixins/prefixed-transform";
 @import "govuk/components/accordion/accordion";
+
+// Prevent elements inside the button from receiving click events
+.gem-c-accordion__show-all > * {
+  pointer-events: none;
+}

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

@@ -5,6 +5,8 @@
   id ||= "default-id-#{SecureRandom.hex(4)}"
   items ||= []
   anchor_navigation ||= false
+  track_show_all_clicks ||= false
+  track_sections ||= false
 
   accordion_classes = %w(gem-c-accordion govuk-accordion)
   accordion_classes << (shared_helper.get_margin_bottom)
@@ -22,6 +24,8 @@
   data_attributes ||= {}
   data_attributes[:module] = 'govuk-accordion gem-accordion'
   data_attributes[:anchor_navigation] = anchor_navigation
+  data_attributes[:track_show_all_clicks] = track_show_all_clicks
+  data_attributes[:track_sections] = track_sections
 
   translations.each do |key, translation|
     locales[key] = shared_helper.t_locale(translation)

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

@@ -18,8 +18,10 @@
         <%= heading %>
       <% end %>
     <% end %>    
-
-    <%= content_tag('ul', class: ul_classes) do %>
+    <%# data-track-count is used for analytics purposes in 
+    https://github.com/alphagov/govuk_publishing_components/blob/main/app/assets/javascripts/govuk_publishing_components/analytics/page-content.js 
+    %>
+    <%= content_tag('ul', class: ul_classes, "data-track-count": "cardList" ) do %>
       <%
         items.each do |item|
         link = item[:link]
@@ -33,7 +35,8 @@
             <%= 
               link_to link[:text], link[:path], 
               class: "govuk-link gem-c-cards__link", 
-              data: link[:data_attributes] 
+              data: link[:data_attributes],
+              "data-track-count": "cardLink"
             %>
           <% end %>
           <% if item[:description] %>

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

@@ -6,9 +6,7 @@
   hide ||= false
   new_tab ||= false
 
-
   data_attributes ||= {}
-  data_attributes[:module] = 'intervention'
   suggestion_data_attributes ||= {}
   dismiss_data_attributes ||= {}
 

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

@@ -309,3 +309,37 @@ examples:
             text: How people read
           content:
             html: <p class="govuk-body">This is the content for How people read.</p>
+  with_track_show_all_clicks:
+    description: |
+      To switch on Google Analytics for the "Show all sections" button on click, pass `track_show_all_clicks: true` the values passed on open will be
+      `Event Action: accordionOpened` `Event Category: pageElementInteraction` `Event Label: Show all sections` 
+    data:
+      track_show_all_clicks: true
+      items:
+        - heading:
+            text: Writing well for the web
+            id: writing-well-for-the-web
+          content:
+            html: <p class="govuk-body">This is content for accordion 1 of 2</p><p class="govuk-body">This content contains a <a href="#anchor-nav-test" class="govuk-link">link</a></p>
+        - heading:
+            text: Writing well for specialists
+          content:
+            html: <p class="govuk-body" id="anchor-nav-test">This is content for accordion 2 of 2</p>
+  with_track_sections:
+    description: |
+      To switch on Google Analytics for each section, on click, pass `track_sections: true` the values passed on open will be
+      `Event Action: accordionOpened` / `accordionClosed` `Event Category: pageElementInteraction` and the `Event Label` being the heading text.
+      
+      (`track_show_all_clicks: true` can be added to track the "Show all sections" button as well, if required)
+    data:
+      track_sections: true
+      items:
+        - heading:
+            text: Writing well for the web
+            id: writing-well-for-the-web
+          content:
+            html: <p class="govuk-body">This is content for accordion 1 of 2</p><p class="govuk-body">This content contains a <a href="#anchor-nav-test" class="govuk-link">link</a></p>
+        - heading:
+            text: Writing well for specialists
+          content:
+            html: <p class="govuk-body" id="anchor-nav-test">This is content for accordion 2 of 2</p>

data/config/locales/en.yml

@@ -177,8 +177,8 @@ en:
       navigation_search_heading: Search and popular pages
       navigation_search_subheading: Search
       popular_links:
-      - label: 'Invasion of Ukraine'
-        href: "/government/topical-events/russian-invasion-of-ukraine-uk-government-response"
+      - label: 'Moving to the UK from Ukraine'
+        href: "/guidance/move-to-the-uk-if-youre-from-ukraine"
       - label: 'Coronavirus (COVID-19)'
         href: "/coronavirus"
       - label: Find a job

data/lib/govuk_publishing_components/presenters/attachment.rb

@@ -5,8 +5,7 @@ module GovukPublishingComponents
       # rather than direct email for users to request accessible formats. When the pilot
       # scheme is rolled out further this can be removed.
       # Currently the HMRC are participating in the pilot.
-      EMAILS_IN_ACCESSIBLE_FORMAT_REQUEST_PILOT = %w[govuk_publishing_components@example.com
-                                                     different.format@hmrc.gov.uk].freeze
+      EMAILS_IN_ACCESSIBLE_FORMAT_REQUEST_PILOT = %w[govuk_publishing_components@example.com].freeze
 
       delegate :opendocument?, :document?, :spreadsheet?, to: :content_type
 

data/lib/govuk_publishing_components/presenters/meta_tags.rb

@@ -1,6 +1,8 @@
 module GovukPublishingComponents
   module Presenters
     class MetaTags
+      FORMATS_THAT_MIGHT_INCLUDE_POSTCODES = %w[smart_answer finder local_transaction place special_route transaction].freeze
+
       attr_reader :content_item, :details, :links, :local_assigns, :request
 
       def initialize(content_item, local_assigns, request)
@@ -31,6 +33,7 @@ module GovukPublishingComponents
         meta_tags["govuk:schema-name"] = content_item[:schema_name] if content_item[:schema_name]
         meta_tags["govuk:content-id"] = content_item[:content_id] if content_item[:content_id]
         meta_tags["govuk:navigation-page-type"] = content_item[:navigation_page_type] if content_item[:navigation_page_type]
+        meta_tags["govuk:navigation-list-type"] = content_item[:navigation_list_type] if content_item[:navigation_list_type]
         meta_tags["govuk:section"] = content_item[:section] if content_item[:section]
         meta_tags["govuk:withdrawn"] = "withdrawn" if content_item[:withdrawn_notice].present?
         meta_tags["govuk:content-has-history"] = "true" if has_content_history?
@@ -148,8 +151,7 @@ module GovukPublishingComponents
         # document_type
         return local_assigns[:strip_postcode_pii] if local_assigns.key?(:strip_postcode_pii)
 
-        formats_that_might_include_postcodes = %w[smart_answer finder]
-        formats_that_might_include_postcodes.include?(content_item[:document_type])
+        FORMATS_THAT_MIGHT_INCLUDE_POSTCODES.include?(content_item[:document_type])
       end
     end
   end

data/lib/govuk_publishing_components/presenters/public_layout_helper.rb

@@ -2,40 +2,6 @@ module GovukPublishingComponents
   module Presenters
     class PublicLayoutHelper
       FOOTER_NAV = [
-        {
-          title: "Coronavirus (COVID-19)",
-          columns: 2,
-          items: [
-            {
-              href: "/coronavirus",
-              text: "Coronavirus (COVID-19): guidance and support",
-              attributes: {
-                data: {
-                  track_category: "footerClicked",
-                  track_action: "coronavirusLinks",
-                  track_label: "Coronavirus (COVID-19): guidance and support",
-                },
-              },
-            },
-          ],
-        },
-        {
-          title: "Brexit",
-          columns: 1,
-          items: [
-            {
-              href: "/brexit",
-              text: "Check what you need to do",
-              attributes: {
-                data: {
-                  track_category: "footerClicked",
-                  track_action: "transitionLinks",
-                  track_label: "Check what you need to do",
-                },
-              },
-            },
-          ],
-        },
         {
           title: "Services and information",
           columns: 2,

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "29.1.0".freeze
+  VERSION = "29.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 29.1.0
+  version: 29.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -112,30 +112,30 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
   requirement: !ruby/object:Gem::Requirement
@@ -154,30 +154,30 @@ dependencies:
   name: govuk_schemas
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: govuk_test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n-coverage
   requirement: !ruby/object:Gem::Requirement
@@ -196,16 +196,16 @@ dependencies:
   name: percy-capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -252,16 +252,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
@@ -280,44 +280,44 @@ dependencies:
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: uglifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -464,7 +464,6 @@ files:
 - app/assets/javascripts/govuk_publishing_components/components/error-summary.js
 - app/assets/javascripts/govuk_publishing_components/components/feedback.js
 - app/assets/javascripts/govuk_publishing_components/components/govspeak.js
-- app/assets/javascripts/govuk_publishing_components/components/intervention.js
 - app/assets/javascripts/govuk_publishing_components/components/layout-header.js
 - app/assets/javascripts/govuk_publishing_components/components/layout-super-navigation-header.js
 - app/assets/javascripts/govuk_publishing_components/components/metadata.js
@@ -1891,7 +1890,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: A gem to document components in GOV.UK frontend applications

data/app/assets/javascripts/govuk_publishing_components/components/intervention.js

@@ -1,17 +0,0 @@
-window.GOVUK = window.GOVUK || {}
-window.GOVUK.Modules = window.GOVUK.Modules || {};
-
-(function (Modules) {
-  function Intervention ($module) {
-    this.$module = $module
-  }
-
-  Intervention.prototype.init = function () {
-    if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
-      // Send a tracking event when this component is shown
-      window.GOVUK.analytics.trackEvent('interventionBanner', 'interventionShown')
-    }
-  }
-
-  Modules.Intervention = Intervention
-})(window.GOVUK.Modules)