govuk_publishing_components 9.1.1 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db15d537c17313a0793b88dc3ccac1f8ba3496e4a74b90243c0727e7b978354a
-  data.tar.gz: 61a1abf7b80c7d18a6279ac941cced1642389918dbd4b5cef98d98d24b522d53
+  metadata.gz: a9be81dd115b4d1d6c4929ae4ab37967b49f0c754fc8f019b4f3c0d46b31c73b
+  data.tar.gz: 764428bcf5091952d69fa9672d09611da78707b753147462387ac2e8d435f427
 SHA512:
-  metadata.gz: 6128034653da026744dc30526dda393da4d0ee1ed124d700b36b4e8833c244b8db785050af8ef35d313e50ec09ae31c1841d05f492a5af4c781ec57d9cb492bf
-  data.tar.gz: 026ba2c40a3a797853af4586a29f2f9a82b02b1b887eef5364f7db7d8155af74d84988c22160f900c03a0f47f179866955a675a23e30272c90e00026b3d88557
+  metadata.gz: 5ece0a6bf7872b6adfc8a706825ba1e71953984554315c26539bff89781dcda35d6b7320db7be7b77a313433ca0417c2dc75587002ebeb7000dfee19d33443b2
+  data.tar.gz: 6cfa01de0ec959dc64a5c96e272df97a84258e67fa55665eb652f08e15d1e8de1408b37063f10ad1784b0637403531dca953f091774f5c94e71f191cdf6f56ef

data/app/assets/stylesheets/govuk_publishing_components/_all_components.scss

@@ -25,6 +25,7 @@
 @import "components/label";
 @import "components/lead-paragraph";
 @import "components/notice";
+@import "components/organisation-logo";
 @import "components/phase-banner";
 @import "components/previous-and-next-navigation";
 @import "components/radio";

data/app/assets/stylesheets/govuk_publishing_components/components/_document-list.scss

@@ -15,9 +15,12 @@
   display: inline-block;
 }
 
+.gem-c-document-list__item-title--context {
+  margin-right: $gutter-one-third;
+}
+
 .gem-c-document-list__item-context {
   color: $grey-1;
-  margin-left: $gutter-one-third;
 }
 
 .gem-c-document-list__item-description {

data/app/assets/stylesheets/govuk_publishing_components/components/_organisation-logo.scss

@@ -0,0 +1,141 @@
+// Default logo corresponds with the "medium stacked" Whitehall equivalent
+.gem-c-organisation-logo {
+  font-family: $helvetica-regular;
+  font-size: 13px;
+  line-height: (15 / 13);
+  font-weight: 400;
+
+  @include media(tablet) {
+    font-size: 18px;
+    line-height: 20px;
+  }
+}
+
+.gem-c-organisation-logo__container {
+  text-transform: none;
+  text-decoration: none;
+  display: block;
+  color: $black;
+  height: auto;
+  width: auto;
+
+  // Logo direction never changes, even for rtl content.
+  direction: ltr;
+}
+
+// Scale images on smaller viewports
+.gem-c-organisation-logo__image {
+  max-width: 100%;
+}
+
+.gem-c-organisation-logo__crest {
+  // Default brand colour
+  border-left: 2px solid $black;
+  padding-top: 20px;
+  padding-left: 6px;
+
+  @include media(tablet) {
+    padding-top: 25px;
+    padding-left: 7px;
+  }
+
+  .brand--executive-office & {
+    border-left-width: 0;
+    padding-left: 0;
+    background-position: 0 0;
+  }
+}
+
+.gem-c-organisation-logo__name {
+  position: relative;
+  top: 3px;
+}
+
+.gem-c-organisation-logo__link:link,
+.gem-c-organisation-logo__link:visited {
+  color: $black;
+}
+
+.gem-c-organisation-logo__link:hover,
+.gem-c-organisation-logo__link:focus {
+  text-decoration: underline;
+}
+
+// all crest images are currently in whitehall
+@mixin crest($crest) {
+  background: image-url('crests/#{$crest}_13px.png') no-repeat 5px 0;
+  background-size: auto 20px;
+
+  @include device-pixel-ratio() {
+    background-image: image-url('crests/#{$crest}_13px_x2.png');
+  }
+
+  @include media(tablet) {
+    background: image-url('crests/#{$crest}_18px.png') no-repeat 6px 0;
+    background-size: auto 26px;
+
+    @include device-pixel-ratio() {
+      background-image: image-url('crests/#{$crest}_18px_x2.png');
+    }
+  }
+}
+
+@mixin tall-crest {
+  padding-top: 25px;
+  background-size: auto 25px;
+
+  @include media(tablet) {
+    padding-top: 35px;
+    background-size: auto 34px;
+  }
+}
+
+.gem-c-organisation-logo__crest--dit {
+  @include crest('dit_crest');
+}
+
+.gem-c-organisation-logo__crest--bis {
+  @include crest('bis_crest');
+}
+
+.gem-c-organisation-logo__crest--hmrc {
+  @include crest('hmrc_crest');
+}
+
+.gem-c-organisation-logo__crest--ho {
+  @include crest('ho_crest');
+  @include tall-crest;
+}
+
+.gem-c-organisation-logo__crest--mod {
+  @include crest('mod_crest');
+  @include tall-crest;
+}
+
+.gem-c-organisation-logo__crest--single-identity,
+.gem-c-organisation-logo__crest--eo,
+.gem-c-organisation-logo__crest--org {
+  @include crest('org_crest');
+}
+
+.gem-c-organisation-logo__crest--portcullis {
+  @include crest('portcullis');
+}
+
+.gem-c-organisation-logo__crest--so {
+  @include crest('so_crest');
+}
+
+.gem-c-organisation-logo__crest--ukaea {
+  @include crest('ukaea_crest');
+}
+
+.gem-c-organisation-logo__crest--ukho {
+  @include crest('ukho');
+  @include tall-crest;
+}
+
+.gem-c-organisation-logo__crest--wales {
+  @include crest('wales_crest');
+  @include tall-crest;
+}

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

@@ -2,6 +2,7 @@
   items ||= []
   margin_top_class = " gem-c-document-list--top-margin" if local_assigns[:margin_top]
   margin_bottom_class = " gem-c-document-list--bottom-margin" if local_assigns[:margin_bottom]
+  title_with_context_class = " gem-c-document-list__item-title--context"
 
   brand ||= false
   brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(brand)
@@ -12,24 +13,17 @@
       <li class="gem-c-document-list__item">
         <% if item[:link][:description] || item[:metadata] %>
           <h3 class="gem-c-document-list__item-title">
-            <%=
-              link_to(
-                item[:link][:text],
-                item[:link][:path],
-                data: item[:link][:data_attributes],
-                class: brand_helper.color_class
-              )
-            %>
+        <% end %>
+        <%=
+          link_to(
+            item[:link][:text],
+            item[:link][:path],
+            data: item[:link][:data_attributes],
+            class: "gem-c-document-list__item-title #{brand_helper.color_class} #{title_with_context_class if item[:link][:context]}"
+          )
+        %>
+        <% if item[:link][:description] || item[:metadata] %>
           </h3>
-        <% else%>
-          <%=
-            link_to(
-              item[:link][:text],
-              item[:link][:path],
-              data: item[:link][:data_attributes],
-              class: "gem-c-document-list__item-title #{brand_helper.color_class}"
-            )
-          %>
         <% end %>
 
         <% if item[:link][:context] %>

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

@@ -0,0 +1,21 @@
+<%
+  logo_helper = GovukPublishingComponents::Presenters::OrganisationLogoHelper.new(local_assigns)
+  brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(organisation[:brand])
+  organisation ||= {}
+%>
+<div
+  class="gem-c-organisation-logo <%= brand_helper.brand_class %>"
+  <%= "data-module=track-click" if organisation[:data_attributes] %>
+>
+  <% if organisation[:url] %>
+    <%= link_to organisation[:url],
+      class: "#{logo_helper.logo_container_class} #{brand_helper.border_color_class}",
+      data: organisation[:data_attributes] do %>
+      <%= logo_helper.logo_content %>
+    <% end %>
+  <% else %>
+    <div class="<%= logo_helper.logo_container_class %> <%= brand_helper.border_color_class %>">
+      <%= logo_helper.logo_content %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,164 @@
+name: "Organisation logo"
+description: "Organisation text with crest and branded border colour"
+body: |
+  Organisation name must be provided with pre-formatted line breaks.
+  These cannot be inferred from the name alone.
+
+  Alternatively a custom organisation logo can be provided as an image.
+
+  Data tracking attributes can be provided to add tracking to each organisation logo.
+  This will only apply to organisations with a link. Example here: [with_data_attributes](/component-guide/organisation_logo/with_data_attributes)
+accessibility_criteria: |
+  The crest image itself must be presentational and ignored by screen readers.
+
+shared_accessibility_criteria:
+  - link
+examples:
+  default:
+    data:
+      organisation:
+        name: 'Organisation<br>Name'
+        url: 'http://www.gov.uk'
+  single_identity:
+    data:
+      organisation:
+        name: 'Single Identity'
+        url: 'http://www.gov.uk'
+        crest: 'single-identity'
+  attorney_generals_office:
+    data:
+      organisation:
+        name: 'Attorney <br>General’s <br>Office'
+        url: '/government/organisations/attorney-generals-office'
+        brand: 'attorney-generals-office'
+        crest: 'single-identity'
+  department_for_business_innovation_and_skills:
+    data:
+      organisation:
+        name: 'Department <br>for Business<br>Innovation &amp; Skills'
+        url: '/government/organisations/department-for-business-innovation-skills'
+        brand: 'department-for-business-innovation-skills'
+        crest: 'bis'
+  department_for_international_trade:
+    data:
+      organisation:
+        name: 'Department for<br>International Trade'
+        url: '/government/organisations/department-for-international-trade'
+        brand: 'department-for-international-trade'
+        crest: 'dit'
+  executive_office:
+    data:
+      organisation:
+        name: Prime Minister's Office, 10 Downing Street
+        url: '/government/organisations/prime-ministers-office-10-downing-street'
+        brand: 'executive-office'
+        crest: 'eo'
+  home_office:
+    data:
+      organisation:
+        name: 'Home Office'
+        url: '/government/organisations/home-office'
+        brand: 'home-office'
+        crest: 'ho'
+  ministry_of_defence:
+    data:
+      organisation:
+        name: 'Ministry<br>of Defence'
+        url: '/government/organisations/ministry-of-defence'
+        brand: 'ministry-of-defence'
+        crest: 'mod'
+  office_of_the_advocate_general_for_scotland:
+    data:
+      organisation:
+        name: 'Office of the<br>Advocate General<br>for Scotland'
+        url: '/government/organisations/office-of-the-advocate-general-for-scotland'
+        brand: 'office-of-the-advocate-general-for-scotland'
+        crest: 'so'
+  office_of_the_leader_of_the_house_of_commons:
+    data:
+      organisation:
+        name: 'Office of the <br>Leader of the <br>House of Commons'
+        url: '/government/organisations/the-office-of-the-leader-of-the-house-of-commons'
+        brand: 'the-office-of-the-leader-of-the-house-of-commons'
+        crest: 'portcullis'
+  wales_office:
+    data:
+      organisation:
+        name: 'Wales Office<br>Swyddfa Cymru'
+        url: '/government/organisations/wales-office'
+        brand: 'wales_office'
+        crest: 'wales'
+  uk_atomic_energy_authority:
+    data:
+      organisation:
+        name: 'UK Atomic <br>Energy <br>Authority'
+        url: '/government/organisations/uk-atomic-energy-authority'
+        brand: 'department-for-business-innovation-skills'
+        crest: 'ukaea'
+  wales_office:
+    data:
+      organisation:
+        name: 'Wales Office<br>Swyddfa Cymru'
+        url: '/government/organisations/wales-office'
+        brand: 'wales_office'
+        crest: 'wales'
+  hm_revenue_customs:
+    data:
+      organisation:
+        name: 'HM Revenue<br>&amp; Customs'
+        url: '/government/organisations/hm-revenue-customs'
+        brand: 'hm-revenue-customs'
+        crest: 'hmrc'
+  bona_vacantia:
+    data:
+      organisation:
+        name: 'Bona Vacantia'
+        url: '/government/organisations/bona-vacantia'
+        brand: 'attorney-generals-office'
+        crest: 'org'
+  treasury_solicitors_office:
+    data:
+      organisation:
+        name: 'Treasury <br>Solicitor’s <br>Department'
+        url: '/government/organisations/treasury-solicitor-s-department'
+        brand: 'attorney-generals-office'
+        crest: 'org'
+  land_registry:
+    data:
+      organisation:
+        name: 'Land Registry'
+        url: '/government/organisations/land-registry'
+        brand: 'department-for-business-innovation-skills'
+        crest: null
+        image:
+          url: 'https://assets.publishing.service.gov.uk/government/uploads/system/uploads/organisation/logo/69/HMLR_logo.png'
+          alt_text: 'Land Registry'
+  hm_prison_service:
+    data:
+      organisation:
+        name: 'HM Prison Service'
+        url: '/government/organisations/hm-prison-service'
+        brand: 'ministry-of-justice'
+        image:
+          url: 'https://assets.publishing.service.gov.uk/government/uploads/system/uploads/organisation/logo/321/HMPS.jpg'
+          alt_text: 'HM Prison Service'
+  with_data_attributes:
+    data:
+      organisation:
+        name: Cabinet Office
+        url: '/government/organisations/cabinet-office'
+        brand: cabinet-office
+        crest: 'single-identity'
+        data_attributes:
+          track_category: "navOrganisationLinkClicked"
+          track_action: 1
+          track_label: '/government/organisations/cabinet-office'
+          track_options:
+            dimension28: 2
+            dimension29: Cabinet Office
+  without_a_link:
+    data:
+      organisation:
+        name: Cabinet Office
+        brand: cabinet-office
+        crest: 'single-identity'

data/lib/govuk_publishing_components.rb

@@ -19,6 +19,7 @@ require "govuk_publishing_components/presenters/schema_org"
 require "govuk_publishing_components/presenters/heading_helper"
 require "govuk_publishing_components/presenters/contents_list_helper"
 require "govuk_publishing_components/presenters/image_card_helper"
+require "govuk_publishing_components/presenters/organisation_logo_helper"
 
 require "govuk_publishing_components/app_helpers/taxon_breadcrumbs"
 require "govuk_publishing_components/app_helpers/brand_helper"

data/lib/govuk_publishing_components/presenters/organisation_logo_helper.rb

@@ -0,0 +1,36 @@
+module GovukPublishingComponents
+  module Presenters
+    class OrganisationLogoHelper
+      include ActionView::Helpers
+      include ActionView::Context
+
+      attr_reader :name, :url, :crest, :image, :logo_image_src, :logo_image_alt
+
+      def initialize(local_assigns)
+        @name = local_assigns[:organisation][:name]
+        @url = local_assigns[:organisation][:url]
+        @crest = local_assigns[:organisation][:crest]
+        @image = local_assigns[:organisation][:image] || false
+        if @image
+          @logo_image_src = local_assigns[:organisation][:image][:url] || false
+          @logo_image_alt = local_assigns[:organisation][:image][:alt_text] || false
+        end
+      end
+
+      def logo_content
+        if image
+          image_tag(logo_image_src, alt: logo_image_alt, class: "gem-c-organisation-logo__image")
+        else
+          content_tag('span', name, class: "gem-c-organisation-logo__name")
+        end
+      end
+
+      def logo_container_class
+        logo_class = "gem-c-organisation-logo__container"
+        logo_class = "#{logo_class} gem-c-organisation-logo__link" if url
+        logo_class = "#{logo_class} gem-c-organisation-logo__crest gem-c-organisation-logo__crest--#{crest}" if crest
+        logo_class
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '9.1.1'.freeze
+  VERSION = '9.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -347,6 +347,7 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/_label.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_lead-paragraph.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_notice.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_organisation-logo.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_phase-banner.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_previous-and-next-navigation.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_radio.scss
@@ -436,6 +437,7 @@ files:
 - app/views/govuk_publishing_components/components/_machine_readable_metadata.html.erb
 - app/views/govuk_publishing_components/components/_meta_tags.html.erb
 - app/views/govuk_publishing_components/components/_notice.html.erb
+- app/views/govuk_publishing_components/components/_organisation_logo.html.erb
 - app/views/govuk_publishing_components/components/_phase_banner.html.erb
 - app/views/govuk_publishing_components/components/_previous_and_next_navigation.html.erb
 - app/views/govuk_publishing_components/components/_radio.html.erb
@@ -472,6 +474,7 @@ files:
 - app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
 - app/views/govuk_publishing_components/components/docs/meta_tags.yml
 - app/views/govuk_publishing_components/components/docs/notice.yml
+- app/views/govuk_publishing_components/components/docs/organisation_logo.yml
 - app/views/govuk_publishing_components/components/docs/phase_banner.yml
 - app/views/govuk_publishing_components/components/docs/previous_and_next_navigation.yml
 - app/views/govuk_publishing_components/components/docs/radio.yml
@@ -517,6 +520,7 @@ files:
 - lib/govuk_publishing_components/presenters/machine_readable/page.rb
 - lib/govuk_publishing_components/presenters/machine_readable/person_schema.rb
 - lib/govuk_publishing_components/presenters/meta_tags.rb
+- lib/govuk_publishing_components/presenters/organisation_logo_helper.rb
 - lib/govuk_publishing_components/presenters/page_with_step_by_step_navigation.rb
 - lib/govuk_publishing_components/presenters/related_navigation_helper.rb
 - lib/govuk_publishing_components/presenters/rummager_taxonomy_sidebar_links.rb