Allow Kit specific patterns to be used with the unbranded template #842

NickColley · 2019-12-02T10:57:11Z

Updates the unbranded template to extend the main layout, which allows users to use Prototype Kit specific patterns such as the task list and step-by-step patterns.

Closes #841

This ensures the extensions and other aspects of the main layout, work as expected.

Ensures all the same features are avaliable, for example tasks lists and step by steps.

NickColley · 2019-12-02T11:03:44Z

app/assets/sass/unbranded.scss

-@import "node_modules/govuk-frontend/govuk/settings/colours-applied";
+// Import settings first so we can override them before importing all of GOV.UK Frontend
+// If you need to enable compatibility mode or the legacy palette, do that *before* this import.
+@import "node_modules/govuk-frontend/govuk/settings/all";


Since settings outputs no CSS it's safe to import the simpler 'all' entrypoint

NickColley · 2019-12-02T11:04:05Z

app/views/layout_unbranded.html


 {% block headIcons %}
  <link rel="shortcut icon" href="{{ asset_path }}images/unbranded.ico?0.18.3" type="image/x-icon" />
-  <link rel="mask-icon" href="{{ asset_path }}images/gov.uk_logotype_crown.svg?0.18.3" color="#0b0c0c">


Got rid of most of these icons since they're not needed and don't work anyway

The icons are added when using layout.html as they are used by GOV.UK Design System template. Could we use {{ super() }} to add them here too?

hannalaakso

Looks good. Should the same changes be applied to lib/v6/govuk_template_unbranded?

One thing is that this is quite a large breaking change. I wonder if there's any way we could do this without so many changes to the /app folder? This is probably something you've already considered but I thought I'd mention it anyway.

hannalaakso · 2019-12-03T09:46:06Z

app/assets/sass/unbranded.scss

-@import "node_modules/govuk-frontend/govuk/settings/colours-palette";
-@import "node_modules/govuk-frontend/govuk/settings/colours-applied";
+// Import settings first so we can override them before importing all of GOV.UK Frontend
+// If you need to enable compatibility mode or the legacy palette, do that *before* this import.


Non-blocking but it would be good to link to https://github.com/alphagov/govuk-frontend/blob/master/docs/installation/compatibility.md

hannalaakso · 2019-12-03T11:05:47Z

app/views/layout_unbranded.html


 {% block headIcons %}
  <link rel="shortcut icon" href="{{ asset_path }}images/unbranded.ico?0.18.3" type="image/x-icon" />
-  <link rel="mask-icon" href="{{ asset_path }}images/gov.uk_logotype_crown.svg?0.18.3" color="#0b0c0c">


The icons are added when using layout.html as they are used by GOV.UK Design System template. Could we use {{ super() }} to add them here too?

hannalaakso · 2019-12-03T11:06:17Z

docs/views/layout_unbranded.html


 {% block headIcons %}
  <link rel="shortcut icon" href="{{ asset_path }}images/unbranded.ico?0.18.3" type="image/x-icon" />
-  <link rel="mask-icon" href="{{ asset_path }}images/gov.uk_logotype_crown.svg?0.18.3" color="#0b0c0c">


The icons are still added when using layout.html as they are used by GOV.UK Design System template. Could we use {{ super() }} to add them here too?

For the unbranded template we want to intentionally avoid the default icons as they're branded, so I don't think we want to use super here.

Okay that makes sense 👍

NickColley · 2019-12-03T11:15:34Z

lib/v6/govuk_template_unbranded

I think... we should keep that the same for compatibility reasons, but could be wrong.

One thing is that this is quite a large breaking change.

What do you think this would break for users?

hannalaakso · 2019-12-03T11:34:08Z

I think... we should keep that the same for compatibility reasons, but could be wrong.

Happy to pair on this, the v6 stuff can be a bit weird.

What do you think this would break for users?

Okay the word "breaking" was a bit misleading, I meant it in the sense that users have to manually do something. When there are changes to /app they won't be automatically applied on kit update. Or did you think we'd mention the changes users have to make in the release notes but mark them as optional? Happy to chat about this.

NickColley · 2019-12-03T11:39:58Z

Happy to pair on this, the v6 stuff can be a bit weird.

I don't think V6 compatibility should expect to have features available in the current release, seems weird to me to update V6 so it works differently to how it used to work.

When there are changes to /app they won't be automatically applied on kit update.

I think if users don't make these changes when they update it wont break anything with their existing code, they just wont get the fixes for the unbranded stuff?

NickColley · 2019-12-03T14:04:16Z

Spoke with Hanna and we need to make sure the CHANGELOG explains how to upgrade

hannalaakso

Thanks for the IRL @NickColley 👍 Yeah CHANGELOG should have step-by-step instructions for updating /app with the least number of changes needed.

Re: the v6 stuff, we're not going to change the template there as we don't have a lot of information about how people use it so we could end up breaking someone's template. Users should ideally be looking to move to the new version of the kit to get the latest improvements.

NickColley · 2019-12-03T16:59:15Z

CHANGELOG.md

@@ -2,6 +2,20 @@

 ## Fixes

+### Allow Kit specific patterns to be used with the unbranded template


@hannalaakso if you get time could you check these steps for factual accuracy please.

I've assigned @m-green to review this when he has time.

Looks good, thanks @NickColley 👍 I'm not sure we need to mention step 3 as they'll get this change if they follow the kit update instructions.

NickColley · 2019-12-03T16:59:54Z

Assigned this blocked as will need a review from Mark.

Add missing changelog entry for #849, and fix a typo in the entry for #842.

govuk-design-system-ci temporarily deployed to govuk-prototype-kit-pr-842 December 2, 2019 10:57 Inactive

NickColley force-pushed the fix-unbranded-template branch from 86d7357 to 87ad4b7 Compare December 2, 2019 11:00

govuk-design-system-ci temporarily deployed to govuk-prototype-kit-pr-842 December 2, 2019 11:00 Inactive

NickColley added 2 commits December 2, 2019 11:02

Extend main layout for unbranded layout

3a68b58

This ensures the extensions and other aspects of the main layout, work as expected.

Extend application Sass for unbranded Sass

541e232

Ensures all the same features are avaliable, for example tasks lists and step by steps.

NickColley force-pushed the fix-unbranded-template branch from 87ad4b7 to 541e232 Compare December 2, 2019 11:02

govuk-design-system-ci temporarily deployed to govuk-prototype-kit-pr-842 December 2, 2019 11:02 Inactive

NickColley mentioned this pull request Dec 2, 2019

The step by step pattern does not work with the unbranded template #841

Closed

NickColley commented Dec 2, 2019

View reviewed changes

hannalaakso reviewed Dec 3, 2019

View reviewed changes

hannalaakso approved these changes Dec 3, 2019

View reviewed changes

NickColley changed the title ~~Fix unbranded template~~ Allow Kit specific patterns to be used with the unbranded template Dec 3, 2019

govuk-design-system-ci deployed to govuk-prototype-kit-pr-842 December 3, 2019 16:58 View deployment

NickColley requested a review from m-green December 3, 2019 16:58

NickColley added the blocked label Dec 3, 2019

NickColley commented Dec 3, 2019

View reviewed changes

Add CHANGELOG entry

34eafb4

NickColley force-pushed the fix-unbranded-template branch from c137234 to 34eafb4 Compare December 10, 2019 10:47

NickColley merged commit f2c62ce into master Dec 10, 2019

NickColley deleted the fix-unbranded-template branch December 10, 2019 10:56

36degrees added a commit that referenced this pull request Jan 22, 2020

Update changelog

79ebca8

Add missing changelog entry for #849, and fix a typo in the entry for #842.

36degrees mentioned this pull request Jan 22, 2020

Update changelog #853

Merged

hannalaakso mentioned this pull request Jan 22, 2020

Release v9.5.0 #854

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow Kit specific patterns to be used with the unbranded template #842

Allow Kit specific patterns to be used with the unbranded template #842

NickColley commented Dec 2, 2019

NickColley Dec 2, 2019

NickColley Dec 2, 2019

hannalaakso Dec 3, 2019

hannalaakso left a comment

hannalaakso Dec 3, 2019

hannalaakso Dec 3, 2019

hannalaakso Dec 3, 2019

NickColley Dec 3, 2019

hannalaakso Dec 3, 2019

NickColley commented Dec 3, 2019

hannalaakso commented Dec 3, 2019

NickColley commented Dec 3, 2019

NickColley commented Dec 3, 2019

hannalaakso left a comment

NickColley Dec 3, 2019 •

edited

Loading

hannalaakso Dec 6, 2019

NickColley commented Dec 3, 2019

		@@ -2,6 +2,20 @@

		## Fixes

		### Allow Kit specific patterns to be used with the unbranded template

Allow Kit specific patterns to be used with the unbranded template #842

Allow Kit specific patterns to be used with the unbranded template #842

Conversation

NickColley commented Dec 2, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hannalaakso left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NickColley commented Dec 3, 2019

hannalaakso commented Dec 3, 2019

NickColley commented Dec 3, 2019

NickColley commented Dec 3, 2019

hannalaakso left a comment

Choose a reason for hiding this comment

NickColley Dec 3, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NickColley commented Dec 3, 2019

NickColley Dec 3, 2019 •

edited

Loading