-
Notifications
You must be signed in to change notification settings - Fork 328
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.
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
Update with edited version of v3.0.0 (unreleased) changelog #1492
Conversation
Add the edited version of the v3.0.0 release note to CHANGELOG.md.
govuk-frontend uses `.govuk-link:focus`. This fix makes govuk-frontend | ||
selector more specific `.govuk-link:link:focus` but only when compatibility | ||
mode is being used. | ||
If your page wrapper does not have components above the main section, you no longer need to use the [`govuk-main-wrapper--l` modifier class](https://design-system.service.gov.uk/styles/layout/#exploded-view-of-page-wrappers-without-a-back-link-breadcrumbs-or-phase-banner) to increase the vertical space above the content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be updated based on #1493
@@ -2,510 +2,321 @@ | |||
|
|||
## Unreleased 3.0.0 (Breaking release) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to do a link check...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good 🙌 I've left some minor comments
|
||
- Ensure GOV.UK Frontend component selectors cannot conflict when initialised | ||
If you're using HTML or custom JavaScript, change: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would be an example of using custom Javascript in this context?
|
||
Fixes issues with govuk-fronted javascript clashing with govuk-template/govuk-element and potentially other third-party javascript libraries using `js-` class names as hooks. | ||
#### If you’re using Sass |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we say "GOV.UK Frontend Sass".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added this to a list of potential post-release style changes.
|
||
- Spacing of tabs list updated to be more inline with similar lists on GOV.UK and the Design System | ||
#### If you’re using Javascript |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we say "GOV.UK Frontend Javascript"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added this to a list of potential post-release style changes.
CHANGELOG.md
Outdated
|
||
If you are using HTML, you will need to add the `govuk-` prefix to any `[data-module]` attributes. | ||
1. Change your `nunjucks.configure` property so it only includes the `node_modules/govuk-frontend/` directory: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess they might still want to configure the entire node_modules
for some other purpose 🤷♀
The meaning of "only" is a bit opaque here. The array could contain other values.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 - I think it's very likely that the user will be using nunjucks partials / layouts from elsewhere in their own application.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks both - so would it be more like this: "In your nunjucks.configure
property, change /frontend/
to /govuk-frontend/
"? (I've added this in 217e12a)
|
||
- Fix issue where link underlines sit too low in Firefox | ||
If you're using HTML, add the SVG code from the [start button example in the Design System](https://design-system.service.gov.uk/components/button/#start-buttons). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe "HTML <svg>
element"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added this to our list of potential post-release style questions.
CHANGELOG.md
Outdated
|
||
If you are using HTML, you will need to add the `govuk-` prefix to any `[data-module]` attributes. | ||
1. Change your `nunjucks.configure` property so it only includes the `node_modules/govuk-frontend/` directory: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 - I think it's very likely that the user will be using nunjucks partials / layouts from elsewhere in their own application.
CHANGELOG.md
Outdated
@@ -77,7 +77,7 @@ If you're using HTML or custom JavaScript, change: | |||
|
|||
#### If you’re using Nunjucks | |||
|
|||
1. Change your `nunjucks.configure` property so it only includes the `node_modules/govuk-frontend/` directory: | |||
1. In your `nunjucks.configure` property, change `/frontend/` to `/govuk-frontend/`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is no longer correct so I think we need to change this to something like:
When configuring Nunjucks views, remove any references to the node_modules/govuk-frontend/components
directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
People's configuration file will look like
nunjucks.configure([
'path/to/their/views',
'node_modules/govuk-frontend', // Used for the template.njk
'node_modules/govuk-frontend/components' // Used for components
])
And now need to be:
nunjucks.configure([
'path/to/their/views',
'node_modules/govuk-frontend' // Used for the everything
])
This is the edited version of the v3.0.0 release note in CHANGELOG.md. (The same content - with a summary and updating links - will be used in the GitHub release notes this time).
It's already been 2i'd for style by another technical writer.
Please review for:
Following review and before publication we need to: