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

Accessibility in vocabulary treeview #3367

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Andrea-Guevara
Copy link
Contributor

References

Description

In the “ds-vocabulary-treeview” component, the following implementations have been made: setting the focus on the search bar when the reset button is clicked. Using aria-live=“polite” so that the message “There were no items to show” is announced to users who use a screen reader and adding the aria-label attribute to the buttons.

Instructions for Reviewers

List of changes in this PR:

  • For the focus, the “@ViewChild” decorator and the “ElementRef” class were used to access and manipulate the search bar.
  • The aria-live=“polite” attribute has been used to announce the “There were no items to show” message.
  • And finally, the aria-label attribute has been added to some buttons.

To reproduce:

  1. Using a screen reader and navigating DSpace via keyboard, go to the controlled vocabulary page https://demo.dspace.org/browse/srsc
  2. Run accessibility tests.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@tdonohue tdonohue added bug accessibility component: controlled vocabulary related to controlled vocabulary or value-pairs dropdowns 1 APPROVAL pull request only requires a single approval to merge port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 APPROVAL pull request only requires a single approval to merge accessibility bug component: controlled vocabulary related to controlled vocabulary or value-pairs dropdowns port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release
Projects
Status: 🙋 Needs Reviewers Assigned
2 participants