Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use component wrapper in published dates component #3486

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Use component wrapper in published dates component #3486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88d116a
Use component wrapper helper on published dates
andysellick Dec 18, 2024
1dd5045
Fix unrelated Sass warning
andysellick Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions app/assets/stylesheets/helpers/_parts.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@
margin-top: govuk-spacing(6);
margin-bottom: govuk-spacing(6);
padding-bottom: govuk-spacing(3);
border-bottom: 1px solid govuk-colour("mid-grey");

@include govuk-media-query($from: tablet) {
margin-top: 0;
margin-bottom: 0;
}

border-bottom: 1px solid govuk-colour("mid-grey");
}

.part-navigation {
Expand Down
74 changes: 39 additions & 35 deletions app/views/components/_published_dates.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,50 @@
<% add_app_component_stylesheet("published-dates") %>
<%
add_app_component_stylesheet("published-dates")

published ||= false
history ||= []
history = Array(history)
last_updated ||= false
link_to_history ||= false
shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
classes = %w(app-c-published-dates)
classes << "app-c-published-dates--history" if history.any?
classes << shared_helper.get_margin_bottom if local_assigns[:margin_bottom]

component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
component_helper.add_class("app-c-published-dates")
component_helper.add_class("app-c-published-dates--history") if history.any?
component_helper.set_id("full-publication-update-history") if history.any?
component_helper.add_data_attribute({ module: "gem-toggle" }) if history.any?
component_helper.set_lang("en")
%>
<% if published || last_updated %>
<h2 class="govuk-visually-hidden"><%= t('components.published_dates.hidden_heading') %></h2>
<div class="<%= classes.join(' ') %>" <% if history.any? %>id="full-publication-update-history" data-module="gem-toggle"<% end %> lang="en">
<% if published %>
<%= t('components.published_dates.published', date: published) %>
<% end %>
<% if last_updated %>
<% if published %><br /><% end %><%= t('components.published_dates.last_updated', date: last_updated) %>
<% if link_to_history && history.empty? %>
&mdash; <a href="#history" class="app-c-published-dates__history-link govuk-link"><%= t('components.published_dates.see_all_updates', locale: :en) %></a>
<% elsif history.any? %>
<a href="#full-history"
class="app-c-published-dates__toggle govuk-link"
data-controls="full-history"
data-expanded="false"
data-toggled-text="&#45;&nbsp;<%= t('components.published_dates.hide_all_updates', locale: :en) %>"
data-module="ga4-event-tracker"
data-ga4-event="<%= {event_name: "select_content", type: "content history", section: "Footer"}.to_json %>"
data-ga4-expandable
>&#43;&nbsp;<%= t('components.published_dates.show_all_updates', locale: :en) %></a>
<div class="app-c-published-dates__change-history js-hidden" id="full-history">
<ol class="app-c-published-dates__list">
<% history.each do |change| %>
<li class="app-c-published-dates__change-item">
<time class="app-c-published-dates__change-date timestamp" datetime="<%= change[:timestamp] %>"><%= change[:display_time] %></time>
<p class="app-c-published-dates__change-note"><%= change[:note].strip %></p>
</li>
<% end %>
</ol>
</div>
<%= tag.div(**component_helper.all_attributes) do %>
<h2 class="govuk-visually-hidden"><%= t('components.published_dates.hidden_heading') %></h2>
<% if published %>
<%= t('components.published_dates.published', date: published) %>
<% end %>
<% if last_updated %>
<% if published %><br /><% end %><%= t('components.published_dates.last_updated', date: last_updated) %>
<% if link_to_history && history.empty? %>
&mdash; <a href="#history" class="app-c-published-dates__history-link govuk-link"><%= t('components.published_dates.see_all_updates', locale: :en) %></a>
<% elsif history.any? %>
<a href="#full-history"
class="app-c-published-dates__toggle govuk-link"
data-controls="full-history"
data-expanded="false"
data-toggled-text="&#45;&nbsp;<%= t('components.published_dates.hide_all_updates', locale: :en) %>"
data-module="ga4-event-tracker"
data-ga4-event="<%= {event_name: "select_content", type: "content history", section: "Footer"}.to_json %>"
data-ga4-expandable
>&#43;&nbsp;<%= t('components.published_dates.show_all_updates', locale: :en) %></a>
<div class="app-c-published-dates__change-history js-hidden" id="full-history">
<ol class="app-c-published-dates__list">
<% history.each do |change| %>
<li class="app-c-published-dates__change-item">
<time class="app-c-published-dates__change-date timestamp" datetime="<%= change[:timestamp] %>"><%= change[:display_time] %></time>
<p class="app-c-published-dates__change-note"><%= change[:note].strip %></p>
</li>
<% end %>
</ol>
</div>
<% end %>
<% end %>
<% end %>
</div>
<% end %>
7 changes: 1 addition & 6 deletions app/views/components/docs/published_dates.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ accessibility_criteria: |
- be usable with a keyboard
shared_accessibility_criteria:
- link
uses_component_wrapper_helper: true
examples:
default:
data:
Expand Down Expand Up @@ -40,9 +41,3 @@ examples:
- display_time: 14th October 2000
note: Updated information on pupil premium reviews and what information schools need to publish on their websites.
timestamp: 2000-10-14T15:42:37.000+00:00
with_custom_margin_bottom:
description: |
The component accepts a number for margin bottom from 0 to 9 (0px to 60px) using the [GOV.UK Frontend spacing scale](https://design-system.service.gov.uk/styles/spacing/#the-responsive-spacing-scale). By default, the component does not have a bottom margin.
data:
published: 1st January 1990
margin_bottom: 8
9 changes: 5 additions & 4 deletions test/components/published_dates_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ def component_name

test "renders published date" do
render_component(published: "1st November 2000")
assert_select ".app-c-published-dates", text: "Published 1st November 2000"
assert_select ".app-c-published-dates", text: "Updates to this page
Published 1st November 2000"
end

test "renders published date and last updated date" do
render_component(published: "1st November 2000", last_updated: "15th July 2015")
assert_select ".app-c-published-dates",
text: "Published 1st November 2000
Last updated 15th July 2015"
assert_select ".app-c-published-dates", text: "Updates to this page
Published 1st November 2000
Last updated 15th July 2015"
end

test "links to full page history" do
Expand Down
Loading