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

Jump to bottom

Throw ElementError when the menu of the header is missing but a toggle is present #4206

Merged
merged 3 commits into from
Sep 22, 2023
Merged

Throw ElementError when the menu of the header is missing but a toggle is present #4206

merged 3 commits into from
Sep 22, 2023

Conversation

romaricpascal
Copy link
Member

@romaricpascal romaricpascal commented Sep 12, 2023 •
edited
Loading

We need to keep the early return if the toggle is absent, as it's not mandatory for the header to have a navigation.

Closes #4130

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 12, 2023 11:18 Inactive
@github-actions
Copy link

github-actions bot commented Sep 12, 2023 •
edited
Loading

📋 Stats

File sizes

File Size
dist/govuk-frontend-4.6.0.min.css 118.07 KiB
dist/govuk-frontend-4.6.0.min.js 47.1 KiB
dist/govuk-frontend-ie8-4.6.0.min.css 79.27 KiB
packages/govuk-frontend/dist/govuk/all.bundle.js 76.96 KiB
packages/govuk-frontend/dist/govuk/all.bundle.mjs 72.29 KiB
packages/govuk-frontend/dist/govuk/all.mjs 3.84 KiB
packages/govuk-frontend/dist/govuk/govuk-frontend-component.mjs 359 B
packages/govuk-frontend/dist/govuk/govuk-frontend.min.js 37.41 KiB
packages/govuk-frontend/dist/govuk/i18n.mjs 5.83 KiB

Modules

File Size
all.mjs 68.39 KiB
components/accordion/accordion.mjs 21.9 KiB
components/button/button.mjs 4.71 KiB
components/character-count/character-count.mjs 21.64 KiB
components/checkboxes/checkboxes.mjs 5.69 KiB
components/error-summary/error-summary.mjs 6.01 KiB
components/exit-this-page/exit-this-page.mjs 16.6 KiB
components/header/header.mjs 3.83 KiB
components/notification-banner/notification-banner.mjs 4.54 KiB
components/radios/radios.mjs 4.68 KiB
components/skip-link/skip-link.mjs 3.73 KiB
components/tabs/tabs.mjs 9.07 KiB

View stats and visualisations on the review app

Action run for 827ba90

@colinrotherham colinrotherham mentioned this pull request Sep 12, 2023
Merged
@romaricpascal romaricpascal changed the title Throw an ElementError when the menu of the header is absent. Throw ElementError when the menu of the header is absent. Sep 12, 2023
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 9b0f02d to 05d7d97 Compare September 12, 2023 16:56
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 12, 2023 16:57 Inactive
This was referenced Sep 12, 2023
Closed
Closed
Closed
Closed
@romaricpascal romaricpascal linked an issue Sep 18, 2023 that may be closed by this pull request
Throw errors during Header initialisation if key HTML elements are missing #4130
Closed
1 task
@colinrotherham colinrotherham force-pushed the components-type-error branch 2 times, most recently from 090e1b6 to 655af8f Compare September 18, 2023 13:29
Base automatically changed from components-type-error to main September 18, 2023 14:27
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 05d7d97 to c50d078 Compare September 18, 2023 14:57
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 18, 2023 14:57 Inactive
@colinrotherham colinrotherham mentioned this pull request Sep 18, 2023
Closed
2 tasks
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from c50d078 to a166ded Compare September 19, 2023 09:39
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 19, 2023 09:39 Inactive
@colinrotherham colinrotherham force-pushed the header-missing-element-error branch from 6bbf0a4 to 9c4fa4d Compare September 19, 2023 13:22
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 19, 2023 13:25 Inactive
@colinrotherham colinrotherham force-pushed the header-missing-element-error branch 2 times, most recently from a166ded to 6bbf0a4 Compare September 19, 2023 13:37
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 7660f03 to 50b3772 Compare September 21, 2023 15:22
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 21, 2023 15:23 Inactive
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 50b3772 to 7388b1c Compare September 22, 2023 08:47
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 10:14 Inactive
@romaricpascal
Throw an ElementError when the menu of the header is absent.
9b7b370 
We need to keep the early return if the toggle is absent, as it's not mandatory for the header
to have a navigation.

It could be good useful to expand the validations a little there and verify:
- the presence of an `aria-controls` attribute on the `$menuButton`
- the case where a menu is present, but no toggle

This is outside of the scope of this PR, whose aim is to throw where v4 would return early.

Closes #4130
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 4ae36ea to d41d913 Compare September 22, 2023 10:38
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 10:38 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 10:51 Inactive
@romaricpascal romaricpascal mentioned this pull request Sep 22, 2023
Closed
3 tasks
colinrotherham
colinrotherham reviewed Sep 22, 2023
View reviewed changes
packages/govuk-frontend/src/govuk/components/header/header.mjs
this.$menu = $menu
this.$menuButton = $menuButton
Copy link
Contributor

@colinrotherham colinrotherham Sep 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this

Helps the compiler out a lot (narrows the types down) when adding to class fields after the checks

Strict mode will no longer warn that they might be null etc

colinrotherham
colinrotherham approved these changes Sep 22, 2023
View reviewed changes
Copy link
Contributor

@colinrotherham colinrotherham left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but can you fix my daft previous suggestion? Sorry

@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 155b05f to f4cbf73 Compare September 22, 2023 13:53
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 13:54 Inactive
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from f4cbf73 to 2241b64 Compare September 22, 2023 14:05
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 14:06 Inactive
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 2241b64 to 71c9f48 Compare September 22, 2023 14:18
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 14:19 Inactive
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from 71c9f48 to b3c970c Compare September 22, 2023 15:13
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 15:14 Inactive
@romaricpascal romaricpascal force-pushed the header-missing-element-error branch from b3c970c to 827ba90 Compare September 22, 2023 15:20
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-4206 September 22, 2023 15:20 Inactive
@romaricpascal romaricpascal merged commit fff4f70 into main Sep 22, 2023
43 checks passed
@romaricpascal romaricpascal deleted the header-missing-element-error branch September 22, 2023 15:44
colinrotherham pushed a commit that referenced this pull request Sep 27, 2023
@romaricpascal
Merge pull request #4206 from alphagov/header-missing-element-error
f00a831
@romaricpascal romaricpascal mentioned this pull request Dec 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colinrotherham colinrotherham colinrotherham approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Throw errors during Header initialisation if key HTML elements are missing
3 participants
@romaricpascal @colinrotherham @govuk-design-system-ci