Skip to content

Changed Shortcut format for better accessibility #2465

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

Merged
merged 4 commits into from
Jun 5, 2024

Conversation

Sheikh-JamirAlam
Copy link
Contributor

Fixes #2355

Changes:
Removed the symbols used in shortcuts for windows users to "Ctrl + Shift" format so that every user can understand.

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123

@welcome
Copy link

welcome bot commented Sep 20, 2023

🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already.

@lindapaiste lindapaiste self-assigned this Sep 20, 2023
@lindapaiste
Copy link
Collaborator

Here's some before and after screenshots

image

image

image

image

image

image

lindapaiste
lindapaiste previously approved these changes Sep 22, 2023
Copy link
Collaborator

@lindapaiste lindapaiste left a comment

Choose a reason for hiding this comment

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

I definitely think that this is better for accessibility! My only concern is how some of the longer shortcuts look in the dropdown menus. I wonder if we want to decrease the font size of the shortcut and/or increase the width of the dropdown to better accommodate it.

image
image

@lindapaiste
Copy link
Collaborator

You will need to run the command npm test -- -u and then commit and push the changes to the Nav testing snapshot in order for it to pass the tests.

@Sheikh-JamirAlam
Copy link
Contributor Author

Sheikh-JamirAlam commented Sep 23, 2023

@lindapaiste Decresing the font size might be not be a good idea as on a bigger screen its hard to see unless u look closely, in my opinion. Here are some screenshots where I decresed it to 0.85rem, which was 1rem originally.
Screenshot 2023-09-23 103921
Screenshot 2023-09-23 103929

So I went with the increase in width of the dropdown option. But if we increase it just by value then there's too much whitespace in the "Help" menu.
Screenshot 2023-09-23 103427
Screenshot 2023-09-23 103555

So instead I utilized the flex property so that the dropdown menu size is now dynamically set according to the options.
Screenshot 2023-09-23 104956
Screenshot 2023-09-23 105003

I would like to hear your opinion about this.

@mkmori
Copy link

mkmori commented May 31, 2024

This is exactly what I came here looking for. The screenshots look good---I hope it's caught up and makes it to production!

Whenever I need to refamiliarize myself with a shortcut, I just guess at what the carat vs fat arrow mean...and the fat arrow is on the keyboard I'm using right now! 😅 (Good example of a momentary/transient accessibility issue....)

I did follow the link to Sublime Text, only to find even more mysterious symbols, (rather than a legend for those used in the web editor)....

If the length of shortcuts were a concern, just spelling out "Ctrl" would probably be sufficiently disambiguating for me, personally. A legend might also suffice, (e.g., on hover and/or on the Keyboard Shortcuts pop-up)---it's only for occasional reference after all--but @Sheikh-JamirAlam 's solution above seems the most direct and helpful, (esp. the later versions, ensuring both legible font size and adequate space between the menu option and the shortcut).

Copy link
Collaborator

@raclim raclim left a comment

Choose a reason for hiding this comment

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

Thanks so much for your work on this! I think a few more UI adjustments could probably be made, but I think it's overall good for now and can be made down the line, so I'm going to get this in!

@raclim raclim merged commit 9ffeb3c into processing:develop Jun 5, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:Accessibility Category for accessibility related features and bugs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discussion: do users understand the symbols in keyboard shortcuts?
4 participants