[Bug 42165] New: OPAC main search should include role="search"
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Bug ID: 42165 Summary: OPAC main search should include role="search" Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Accessibility Assignee: koha-bugs@lists.koha-community.org Reporter: lucas@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org CC: martin.renvoize@openfifth.co.uk, matt.blenkinsop@openfifth.co.uk, oleonard@myacpl.org https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Ro...: "Landmark roles are intended to be used sparingly, to identify larger overall sections of the document. Using too many landmark roles can create "noise" in screen readers, making it difficult to understand the overall layout of the page." The search bar is a primary function of the catalog and should include the role="search" attribute. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Lucas Gass (lukeg) <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |Academy -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |Laura.escamilla@bywatersolu |ity.org |tions.com Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #1 from Laura Escamilla <Laura.escamilla@bywatersolutions.com> --- Created attachment 196063 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196063&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" and aria-label="Catalog search" are present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 ByWater Sandboxes <bws.sandboxes@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196063|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #2 from ByWater Sandboxes <bws.sandboxes@gmail.com> --- Created attachment 196065 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196065&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" and aria-label="Catalog search" are present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 ByWater Sandboxes <bws.sandboxes@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196065|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #3 from ByWater Sandboxes <bws.sandboxes@gmail.com> --- Created attachment 196066 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196066&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" and aria-label="Catalog search" are present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 ByWater Sandboxes <bws.sandboxes@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196066|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #4 from ByWater Sandboxes <bws.sandboxes@gmail.com> --- Created attachment 196067 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196067&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" and aria-label="Catalog search" are present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 ByWater Sandboxes <bws.sandboxes@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196067|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #5 from ByWater Sandboxes <bws.sandboxes@gmail.com> --- Created attachment 196068 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196068&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" and aria-label="Catalog search" are present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Brendan Lawlor <blawlor@clamsnet.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |blawlor@clamsnet.org QA Contact|testopia@bugs.koha-communit |blawlor@clamsnet.org |y.org | Status|Signed Off |Failed QA --- Comment #6 from Brendan Lawlor <blawlor@clamsnet.org> --- Thanks for working on this Laura! This might not be a blocker but before I Pass QA, I'm interested in hearing others thoughts. I tested this with NVDA screen reader and I think that we could remove the aria-label to reduce some of that screen reader "noise". With role="search" and aria-label="Catalog search" Upon entering the search form it says 'Catalog search, search landmark, search the catalog by, combo box Library catalog collapsed' which is heavy to process at once. W3C advises Avoid using the landmark role as part of the label. https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/general-principl... I think this is a common issue that screen reader users are used to dealing with, but we could possibly make their experience a little better. If there are no other search landmarks on the page, then it doesn't need to have an aria-label: https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/search.html git grep 'role="search"' only comes up in masthead.inc and one form in the staff interface, so I think this would be valid in this case. The only issue would be if another search landmark were introduced on a page that includes masthead.inc, then each one would need a unique label. Without the aria label the screen reader announces entering the form like 'Search landmark, search the catalog by, combo box Library catalog collapsed' which flows a little better. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #7 from Laura Escamilla <Laura.escamilla@bywatersolutions.com> --- (In reply to Brendan Lawlor from comment #6)
Thanks for working on this Laura! This might not be a blocker but before I Pass QA, I'm interested in hearing others thoughts.
I tested this with NVDA screen reader and I think that we could remove the aria-label to reduce some of that screen reader "noise".
With role="search" and aria-label="Catalog search"
Upon entering the search form it says 'Catalog search, search landmark, search the catalog by, combo box Library catalog collapsed' which is heavy to process at once.
W3C advises Avoid using the landmark role as part of the label. https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/general- principles.html
I think this is a common issue that screen reader users are used to dealing with, but we could possibly make their experience a little better.
If there are no other search landmarks on the page, then it doesn't need to have an aria-label: https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/search.html
git grep 'role="search"' only comes up in masthead.inc and one form in the staff interface, so I think this would be valid in this case.
The only issue would be if another search landmark were introduced on a page that includes masthead.inc, then each one would need a unique label.
Without the aria label the screen reader announces entering the form like 'Search landmark, search the catalog by, combo box Library catalog collapsed' which flows a little better.
Thanks for testing with NVDA and for the thoughtful feedback. I agree that in this case the aria-label may be adding unnecessary verbosity. Since masthead.inc appears to provide the only search landmark on these pages, role="search" should be sufficient without an additional label. I'll update the patch to remove the aria-label and leave the search landmark in place. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196068|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #8 from Laura Escamilla <Laura.escamilla@bywatersolutions.com> --- Created attachment 196686 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196686&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" is present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Brendan Lawlor <blawlor@clamsnet.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Brendan Lawlor <blawlor@clamsnet.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #196686|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #9 from Brendan Lawlor <blawlor@clamsnet.org> --- Created attachment 196688 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196688&action=edit Bug 42165: Add search landmark role to OPAC masthead search form Test plan: 1. Apply the patch 2. Load the OPAC main page (opac-main.pl) 3. Inspect the search form → Confirm role="search" is present 4. Use a screen reader (or browser accessibility tree) → Verify a "search" landmark is announced 5. Ensure only one search landmark is present on the page 6. Perform a catalog search → Confirm search functionality is unchanged Signed-off-by: Laura Woodward <lwoodard@artsbma.org> Signed-off-by: Brendan Lawlor <blawlor@clamsnet.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #10 from Brendan Lawlor <blawlor@clamsnet.org> --- Nice work! Passing QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Lucas Gass (lukeg) <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to main Version(s)| |26.05.00 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #11 from Lucas Gass (lukeg) <lucas@bywatersolutions.com> --- Nice work everyone! Pushed to main for 26.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Jacob O'Mara <jacob.omara@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to main |Pushed to stable Version(s)|26.05.00 |26.05.00,25.11.05 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 --- Comment #12 from Jacob O'Mara <jacob.omara@openfifth.co.uk> --- Thanks all, pushed to 25.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Wainui Witika-Park <wainuiwitikapark@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |wainuiwitikapark@catalyst.n | |et.nz Status|Pushed to stable |Needs documenting --- Comment #13 from Wainui Witika-Park <wainuiwitikapark@catalyst.net.nz> --- Enhancement - not backporting to 25.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42165 Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs documenting |RESOLVED Keywords|Academy | Resolution|--- |FIXED --- Comment #14 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- Nothing to add or edit in the Koha manual regarding this change. Please reopen and provide more information is this is not the case. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org