add "(opens in new tab)" suffix to links

Links should have `(opens in new tab)` suffix so that users can expect the link to open in a new tab. see https://design-system.service.gov.uk/styles/links/#external-links
alphagov · Dec 18, 2023 · ba363ac · ba363ac
1 parent ef476d0
commit ba363ac
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/lib/govuk-forms-markdown/renderer.rb b/lib/govuk-forms-markdown/renderer.rb
@@ -69,7 +69,7 @@ def triple_emphasis(text)
 
     def link(link, title, content)
       title_attribute = title.nil? ? "" : " title=\"#{title}\""
-      %(<a href="#{link}" class="govuk-link"#{title_attribute} rel="noreferrer noopener" target="_blank">#{content}</a>)
+      %(<a href="#{link}" class="govuk-link"#{title_attribute} rel="noreferrer noopener" target="_blank">#{content} (opens in new tab)</a>)
     end
 
     def list(contents, list_type)

diff --git a/spec/govuk-forms-markdown/renderer/link_spec.rb b/spec/govuk-forms-markdown/renderer/link_spec.rb
@@ -6,13 +6,13 @@
 
   context "when there is no title" do
     it "renders a link" do
-      expect(renderer.link("https://example.com", nil, "Link content").strip).to eq "<a href=\"https://example.com\" class=\"govuk-link\" rel=\"noreferrer noopener\" target=\"_blank\">Link content</a>"
+      expect(renderer.link("https://example.com", nil, "Link content").strip).to eq "<a href=\"https://example.com\" class=\"govuk-link\" rel=\"noreferrer noopener\" target=\"_blank\">Link content (opens in new tab)</a>"
     end
   end
 
   context "when there is a title" do
     it "renders a link" do
-      expect(renderer.link("https://example.com", "Link title", "Link content").strip).to eq "<a href=\"https://example.com\" class=\"govuk-link\" title=\"Link title\" rel=\"noreferrer noopener\" target=\"_blank\">Link content</a>"
+      expect(renderer.link("https://example.com", "Link title", "Link content").strip).to eq "<a href=\"https://example.com\" class=\"govuk-link\" title=\"Link title\" rel=\"noreferrer noopener\" target=\"_blank\">Link content (opens in new tab)</a>"
     end
   end
 end