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

Sc3004 #135

Merged
merged 10 commits into from
Oct 19, 2023
Merged

Sc3004 #135

merged 10 commits into from
Oct 19, 2023

Conversation

jatindersingh93
Copy link
Contributor

@jatindersingh93 jatindersingh93 commented Oct 16, 2023

Description

https://apps.nrs.gov.bc.ca/int/jira/browse/SHOWCASE-3004

  • Added aria-label attributes to links/buttons that open in new tab or popup
  • Restructure Heading tags in template
  • Included alt text for images

Types of changes

Bug fix (non-breaking change which fixes an issue)

Checklist

  • I have read the CONTRIBUTING doc
  • I have checked that unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@github-actions
Copy link

Coverage Report (Application)

Totals Coverage
Statements: 75% ( 51 / 68 )
Methods: 62.5% ( 5 / 8 )
Lines: 82.61% ( 38 / 46 )
Branches: 57.14% ( 8 / 14 )

@github-actions
Copy link

github-actions bot commented Oct 16, 2023

Coverage Report (Frontend)

Totals Coverage
Statements: 36% ( 604 / 1678 )
Methods: 35.58% ( 132 / 371 )
Lines: 43.21% ( 423 / 979 )
Branches: 14.94% ( 49 / 328 )

@jatindersingh93 jatindersingh93 marked this pull request as ready for review October 16, 2023 22:56
@wilwong89
Copy link
Contributor

There's a whole bunch of linting warnings about aria-label and line length. I think it would be a good idea to resolve those. They show up in the "files changed" tab on this page. Otherwise it looks good.

@@ -48,7 +48,7 @@ onMounted(async () => {
<template>
<div>
<div>
<h1>Select a bucket</h1>
<h2>Select a bucket</h2>
Copy link
Contributor

Choose a reason for hiding this comment

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

As this is the main page header this should still be an h1 according to the requirements.

Requirement: An H1 title provides information to blind-users using screen-readers of what the main topic of the page is and each page should have exactly one H1 title.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

'BCBox' is already set to H1 in the Header, I am not sure what the intention was but looks like it serve the purpose and verify the statement. I didn't change the structure considering it has been verified and accepted during initial application acceptance or accessibility testing. suggestion?

Copy link
Contributor

Choose a reason for hiding this comment

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

i personally dont think the BCBox in the blue header should be h1.
I would probably change the header.vue be like this:
<div id="title-branding" class="justify-content-left" role="banner" > <span>BCBox</span> </div>
and do something in the main.scss like:
.title-branding > span { @extend h1 }

Copy link
Contributor

Choose a reason for hiding this comment

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

this would mean changing the main header in each view to h1.

Choose a reason for hiding this comment

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

Hi all. I see the conundrum because the Design System describes it as H1:
https://developer.gov.bc.ca/Design-System/Header-Basic
But if you go to any given gov.bc.ca page, they use an actual proper H1-level heading for unique page topics and the header is blank:
https://www2.gov.bc.ca/gov/content/health/health-drug-coverage/pharmacare-for-bc-residents/pharmacare-information-sheets

gov.bc.ca uses a single H1 as a unique page title (could be interpreted as a single main topic) then H2, H3, H4 as heading levels for topics. I think I should follow up with the Design System folks (even though it's being revamped) because it's inconsistent with standards set by gov.bc.ca and the intention of H1 as described by W3 and in accessibility standards.

With all of the above information, I would suggest that we style the first black-on-white unique heading on each page as H1, such as My Buckets. BCBox header should not be H1 because it's universal, it's redundant to force screen reader accessibility software to describe it as an H1 on each unique page view. I like Tim's idea of changing header.vue and then setting each "unique page title" to H1.

Copy link
Contributor

@TimCsaky TimCsaky left a comment

Choose a reason for hiding this comment

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

looking good

@@ -48,7 +48,7 @@ onMounted(async () => {
<template>
<div>
<div>
<h1>Select a bucket</h1>
<h2>Select a bucket</h2>
Copy link
Contributor

Choose a reason for hiding this comment

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

i personally dont think the BCBox in the blue header should be h1.
I would probably change the header.vue be like this:
<div id="title-branding" class="justify-content-left" role="banner" > <span>BCBox</span> </div>
and do something in the main.scss like:
.title-branding > span { @extend h1 }

My Buckets
</router-link>
</li>
<li class="mr-2">
<a
target="_blank"
href="https://github.com/bcgov/bcbox/wiki"
aria-label="BCBox Wiki"
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this should be 'BCBox Help' 🤷 but either is fine by me

Choose a reason for hiding this comment

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

I agree, we refer to it as "Help" in the interface so "BCBox Help" gets my vote

@@ -48,7 +48,7 @@ onMounted(async () => {
<template>
<div>
<div>
<h1>Select a bucket</h1>
<h2>Select a bucket</h2>
Copy link
Contributor

Choose a reason for hiding this comment

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

this would mean changing the main header in each view to h1.

@jujaga jujaga merged commit 72016d0 into master Oct 19, 2023
@jujaga jujaga deleted the sc3004 branch October 19, 2023 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants