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

Improve the sidebars and Close buttons labelling #49613

Closed
afercia opened this issue Apr 5, 2023 · 0 comments · Fixed by #49614
Closed

Improve the sidebars and Close buttons labelling #49613

afercia opened this issue Apr 5, 2023 · 0 comments · Fixed by #49614
Assignees
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.

Comments

@afercia
Copy link
Contributor

afercia commented Apr 5, 2023

Description

Follow-up to #49555

Some labels / names related to 'sidebars' and 'Close' buttons have room for improvements.

1

  • The term 'sidebar' should be avoided for a few reasons:
    • The whole concept of 'sidebar' is extraneous to blind screen reader users. The term 'sidebar' is mostly used in various aria-label attributes and in some tooltips. Text that is mainly provided for blind screen reader users should avoid spatial terminology such as 'sidebar': as a blind user, I wouldn't mind whether this region is visually placed on the side, top, bottom or in any other spot of the screen.
    • Ideally, UI sections should be named based on their functionality rather than on their visual aspect. Same applies for components.
    • When translated, the term 'sidebar' is generally way longer than in English. For example, 'Close Document Overview Sidebar' becomes:
      • 'Chiudi la barra laterale di riepilogo del documento'
      • 'Cerrar barra lateral de resumen del documento'
      • 'Fermer la colonne latérale de vue d’ensemble du document'

That's way too long when shown in the UI. Screenshot:

sidebar translation it

2
Sometimes the 'Close' button text contains redundant context. For example: Close List View Sidebar. In this case, this button is within an ARIA region labelled List View. There's no need to specify what the button is supposed to close, as the context sufficiently clarifies the button action.
In other cases, where the context isn't enough, it's worth keeping some contextual info in the button text.

A shorter text is better anyways, as long as the context is clear.

3
Lastly, there's a few inconsistencies across various labels / banes worth fixing.

Step-by-step reproduction instructions

  • Go to the Post editor, open the Help modal.
  • Observe the toggle sidebar shortcut is referenced as: Show or hide the settings sidebar.
  • Go to the Site editor, open the Help modal.
  • Observe the toggle sidebar shortcut is referenced as: Show or hide the block settings sidebar.

sidebar term 01

  • In the Site editor, theck the save panel is labelled Save sidebar, while the button to open it is labelled Open save panel.
  • In the Site editor, open the List View.
  • Observe the List View close button is labelled: Close List View Sidebar, which is way too long. Also notice Sidebar is title case.
  • Open the Styles panel.
  • Observe its close button is labelled: Close Styles sidebar. A bit too long. Also notice sidebar is lowercase.
  • In the Site Editor, check the Navigation ARIA region is labelle Navigation sidebar.

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants