govuk_web_banners 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3559a09b54ed3fbc2bcfd16a6b7ef76412070c470bc92ee3d5449b9d6dce67cf
-  data.tar.gz: 25fb54615aa30d92cb11c1fdd31f2993ee5eb7f1cc3c0c472734805ae4e56597
+  metadata.gz: 78cff5e2766b1a4474b41626672a49a2651215b50930c581aa76787e3c3466da
+  data.tar.gz: ce5e7349198cfa85423aec9ed2aea15950afec97c0f026057677535bdfeec42b
 SHA512:
-  metadata.gz: a54b1d94889ead1bc27dc09a2108b2fd20c05f99bbef023c96a1ed958fce67c9499eb618f722948629953120459ec94b5ff11137d4615ee26aa69cee2e751c44
-  data.tar.gz: f9de6a03acd68640e38599fed629d37e46d5813727c250757369fd454e90f9ab4025862f163deb41837360dbe2ce869f4af23b4473c88ab8e737bab8916da5ab
+  metadata.gz: 6a7b506e17f400ef571d1132ad3b92b603a442fcb861714052b5aadd2d95ea15e155c3c92ad1320d9988a852dbefbbeb722fe0f9b432f3c8039c557eb829a192
+  data.tar.gz: 7c9b69ab4bd65fd1c1984f451e97c9e72acf56ecb2c2a6289d1cd2b47bb19e779035aef296b9b596399affbb2c9c1759cecef6da553b68519b364758b4a5ef0d

data/README.md

@@ -108,7 +108,7 @@ global_banners:
   title: "Register to Vote"
   title_href: /register-to-vote
   text: "You must register to vote before the election"
-  permanent: false
+  always_visible: false
   exclude_paths:
   - /find-your-local-electoral-office
   start_date: 2024/10/21
@@ -122,12 +122,12 @@ Each banner must include a `title`, `title_href`, `text`, and a valid `start_dat
 > `start_date` is **mandatory** here (unlike in recruitment banners) because it's
 > needed to create a banner_version to pass to the underlying component. This lets
 > the component reset the cookie that records how many times a banner has been seen
-> (by default banners are shown only three times, see the `permanent` option below.)
+> (by default banners are shown only three times, see the `always_visible` option below.)
 
 Optional keys are:
 - `name` (an identifying name for this banner, not rendered
   anywhere)
-- `permanent` (defaults to false. If false, banner is hidden if the user
+- `always_visible` (defaults to false. If false, banner is hidden if the user
   has consented to cookies and has seen this banner more than 3 times)
 - `exclude_paths` an array of paths on which the banner should not be shown.
   Note that the banner is never shown on the path it points to, this

data/app/views/govuk_web_banners/_global_banner.html.erb

@@ -2,9 +2,9 @@
 <% if global_banners.any? %>
   <%= render "govuk_publishing_components/components/global_banner", {
       title: global_banners.first.title,
-      title_path: global_banners.first.title_href,
+      title_href: global_banners.first.title_href,
       text: global_banners.first.text,
-      permanent: global_banners.first.permanent,
+      always_visible: global_banners.first.always_visible,
       banner_version: global_banners.first.version,
   } %>
 <% end %>

data/config/govuk_web_banners/global_banners.yml

@@ -1,2 +1,9 @@
 # Check README.md for how to format this file
-global_banners: []
+global_banners:
+- name: Emergency Alerts
+  title: "Emergency Alerts"
+  title_href: /alerts
+  text: "Test on Sunday 7 September, 3pm"
+  always_visible: true
+  start_date: 2025/08/31
+  end_date: 2025/09/08

data/config/govuk_web_banners/recruitment_banners.yml

@@ -151,3 +151,48 @@ banners:
     - /government/organisations/hm-revenue-customs/about/recruitment
   start_date: 2025/08/08
   end_date: 2025/09/05
+- name: HMRC banner - CXD New Employee 2025/08/13
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_new_employee
+  page_paths:
+    # government-frontend
+    - /new-employee/employee-information
+  start_date: 2025/08/13
+  end_date: 2025/10/08
+- name: HMRC banner - CXD Get PAYE 2025/08/13
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_PAYE_forms_p45_p60
+  page_paths:
+    # government-frontend
+    - /get-paye-forms-p45-p60
+  start_date: 2025/08/13
+  end_date: 2025/10/08
+- name: HMRC banner - CXD Payroll 2025/08/13
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_running_payroll
+  page_paths:
+    # government-frontend
+    - /running-payroll
+  start_date: 2025/08/13
+  end_date: 2025/10/08
+- name: HMRC banner - CXD PAYE Checklist 2025/08/13
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_starter_checklist_for_PAYE
+  page_paths:
+    # frontend
+    - /guidance/starter-checklist-for-paye
+  start_date: 2025/08/13
+  end_date: 2025/10/08
+- name: HMRC banner - CXD New Job 2025/08/13
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_Tell_HMRC_new_job_or_more_than_one_job
+  page_paths:
+    # frontend
+    - /guidance/tell-hmrc-if-you-have-a-new-job-or-more-than-one-job
+  start_date: 2025/08/13
+  end_date: 2025/10/08

data/lib/govuk_web_banners/global_banner.rb

@@ -16,7 +16,7 @@ module GovukWebBanners
       global_banners_data["global_banners"].map { |attributes| GlobalBanner.new(attributes:) }
     end
 
-    attr_reader :name, :title, :title_href, :text, :start_date, :end_date, :show_arrows, :permanent, :exclude_paths
+    attr_reader :name, :title, :title_href, :text, :start_date, :end_date, :show_arrows, :always_visible, :exclude_paths
 
     def initialize(attributes:)
       @name = attributes["name"]
@@ -28,7 +28,7 @@ module GovukWebBanners
       @start_date = attributes["start_date"] ? ActiveSupport::TimeZone[GovukWebBanners::TIME_ZONE].parse(attributes["start_date"]) : nil
       @end_date = attributes["end_date"] ? ActiveSupport::TimeZone[GovukWebBanners::TIME_ZONE].parse(attributes["end_date"]) : Time.now + 10.years
       @show_arrows = attributes["show_arrows"] == "true"
-      @permanent = attributes["permanent"] == "true"
+      @always_visible = attributes["always_visible"] == "true"
       @exclude_paths = attributes["exclude_paths"] || []
       @exclude_paths << title_href if title_href&.start_with?("/")
     end

data/lib/govuk_web_banners/version.rb

@@ -1,3 +1,3 @@
 module GovukWebBanners
-  VERSION = "1.6.0".freeze
+  VERSION = "1.8.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_web_banners
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - GOV.UK Dev