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.

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

Add current item indicator for header navigation #1067

Conversation

frankieroberto
Copy link
Contributor

@frankieroberto frankieroberto commented Nov 6, 2024

Add support for indicating the current section, using either current: true (if the user is currently on this exact page) or active: true (if the user is in that section but not necessarily that exact page). Both are styled the same but have different ARIA attributes.

When displayed in the regular view within the blue header, the active links have a light-grey border at the bottom, and no text underline:

Screenshot 2024-11-06 at 23 33 19

When displayed in the expanded menu view (eg on mobile), they have a blue border to their left instead, and are slightly indented:

Screenshot 2024-11-06 at 23 46 46

In addition, a <strong> tag wraps the current item text, to give some indication in any scenarios where CSS is unavailable - based on the GOVUK service navigation component.

Checklist

@frankieroberto
Copy link
Contributor Author

I think this is a non-breaking change, and there aren’t any cross-dependencies on the header breaking change PR, so we could choose to either merge it in with those or ship it earlier as a minor release, depending on how things go?

@frankieroberto frankieroberto changed the base branch from main to header-breaking-changes November 7, 2024 15:35
@frankieroberto
Copy link
Contributor Author

@paulrobertlloyd @anandamaryon1 I've updated this now so that it's merging into header-breaking-changes rather than main. @paulrobertlloyd looks like you've updated the header to use box-shadow instead of border-bottom for the black line on focus? I've updated the PR to set that to grey instead of the border now.

The 'current' item in the expanded menu is unchanged, using a blue box-shadow on the left. It does feel maybe a bit weird to use grey in one context and blue in the other, but then they're completely different designs so 🤷‍♂️? Possibly the expanded navigation would feel like more of a natural extension of the main navigation if it was also blue instead of white - but that'd be a much bigger change...

@davidhunter08
Copy link
Contributor

Hey @frankieroberto, loving this work. I was just wondering do we know why the underlines were added to the nav items? The original nav didn't have underlines, I think they got added when the header was updated last year?! It feels a bit odd to me, and makes it a little harder to read, but maybe that's just me?

Other websites don't tend do underline nav items.

GOV.UK Design system

Screenshot 2024-11-08 at 16 25 44

BBC

Screenshot 2024-11-08 at 16 45 46

DAC

Screenshot 2024-11-08 at 16 46 17

W3.org

While in-text links usually need an underline to help people with low vision or color blindness distinguish them from the surrounding text, this is not needed for links in menus if the menu can be clearly identified as such.
https://www.w3.org/WAI/EO/Drafts/tutorials/navigation/styling/

So it feels like if we have have evidence from users that underlines are needed on the main nav, then we should include them (and also feed that evidence back to gov.uk). But if we don't have any evidence, then maybe consider removing them again?

@frankieroberto
Copy link
Contributor Author

Hey @frankieroberto, loving this work. I was just wondering do we know why the underlines were added to the nav items? The original nav didn't have underlines, I think they got added when the header was updated last year?! It feels a bit odd to me, and makes it a little harder to read, but maybe that's just me?

Good question. I’d be up for removing the underlines on the links in the nav. Don't know if @anandamaryon1 has any history on this?

@anandamaryon1
Copy link
Collaborator

Good question. I’d be up for removing the underlines on the links in the nav. Don't know if @anandamaryon1 has any history on this?

Hmm I've had a look around and can't find anything definitive… I can see from some documentation that in June 2022 the header still had underlines. But in November 2020 the (nhs.uk website) header had no underlines. 🤔

I can try to do more digging and ask around.

@anandamaryon1
Copy link
Collaborator

@frankieroberto how were you expecting the focus style to work on a current link? Currently the styling for the indicator overrides the focus style:
image

Should it instead be overridden by the focus style, so it looks like this? i.e. same as other links.
image

Or some custom style? Not sure that it's important to see visually that you're focussed on the current link?

@frankieroberto
Copy link
Contributor Author

frankieroberto commented Nov 12, 2024

@anandamaryon1:

how were you expecting the focus style to work on a current link? Currently the styling for the indicator overrides the focus style:
image

Opps, thought I’d checked this. Might have got un-done when I updated from the header breaking changes branch and had to switch from border-bottom to the box-shadow. Fixed in 860df16. 👍

@anandamaryon1
Copy link
Collaborator

Wonder whether we should add some guidance around this in the service manual. I notice that the GOV service nav doesn't, but I think it could be useful to give an example to show it's an option and explain that there are two different aria labels. Anything else we'd wanna cover? Nunjucks macros may be enough if not.

@frankieroberto
Copy link
Contributor Author

@anandamaryon1 agree to having some good guidance around it - the Nunjucks macro options are often missed.

What do you think to the thickness of the line at the bottom? I did wonder if it was too subtle and should be increased, but maybe it’s ok as is.

Not quite sure how this PR also picked up the task list changes - will try and unpick that.

@anandamaryon1
Copy link
Collaborator

anandamaryon1 commented Nov 12, 2024

@frankieroberto hmmI thought it was showing task list stuff because the header-breaking-changes branch was out of date with main so I updated it, but it's still showing them. Maybe swapping the base branch out and back again will fix it?

I feel the underline thickness is enough as it is, since it's breaks up such a big strong shape (the blue header).

@frankieroberto
Copy link
Contributor Author

@anandamaryon1 @paulrobertlloyd mobile current item indicator bumped up to 8px in ae3aaba:

4px 8px
Screenshot 2024-11-27 at 22 17 09 Screenshot 2024-11-27 at 22 16 45

Possibly a bit too close to the text but maybe it’s just about passable?

@frankieroberto
Copy link
Contributor Author

Current item indicator on the white header navigation variation changed from grey to blue in 74b72c8:

Grey Blue
Screenshot 2024-11-27 at 22 20 46 Screenshot 2024-11-27 at 22 20 27

@frankieroberto
Copy link
Contributor Author

...and just for good measure, here’s how it currently looks in the variant with the white header but the blue nav (which I only just discovered was an option):

Screenshot 2024-11-27 at 22 23 06

@paulrobertlloyd
Copy link
Contributor

Possibly a bit too close to the text but maybe it’s just about passable?

@frankieroberto What about 6px?

@frankieroberto
Copy link
Contributor Author

@paulrobertlloyd @anandamaryon1 6px looks better to me. Means not being able to use the spacing scale but in this instance that seems ok? Changed in 3dc45ab

Screenshot 2024-12-18 at 17 58 23

Copy link
Collaborator

@anandamaryon1 anandamaryon1 left a comment

Choose a reason for hiding this comment

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

Nice work, thank you @frankieroberto

One tiny thing I spotted reviewing this:

Focus state's black underline is being overriden by the current status indicator's blue
image

@frankieroberto
Copy link
Contributor Author

@anandamaryon1 well spotted! Fixed in 6cd2e33. It was caused by the ordering of CSS and the _header-white.scss file being included after _header.scss one.

I think this should now be mergeable into the header breaking changes branch.

@anandamaryon1 anandamaryon1 merged commit 53a7e11 into header-breaking-changes Jan 9, 2025
5 checks passed
@anandamaryon1 anandamaryon1 deleted the add-header-navigation-current-item-indicator branch January 9, 2025 16:07
anandamaryon1 pushed a commit that referenced this pull request Jan 13, 2025
This adds the new current and active boolean options for primaryLinks in the header added in #1067 to the documentation in the component README.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants