[MGNLUI-4044] Make keyboard shortcuts discoverable in the UI Created: 21/Oct/16  Updated: 21/Jan/21

Status: Accepted
Project: Magnolia UI
Component/s: admincentral, applauncher, dialogs
Affects Version/s: 5.4.9
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Antti Hietala Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: WAI-ARIA, accessibility
Remaining Estimate: 2d
Time Spent: Not Specified
Original Estimate: 2d

Attachments: PNG File keyboard shortcuts help.png     PNG File twitter-shortcuts.png    
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Epic Link: Keyboard shortcuts

 Description   

Build a shortcut help into Magnolia UI so that users can learn the shortcuts with a screen reader. Today Magnolia does not give any hints that shortcuts are available. You have to learn them by reading documentation.

Example: Twitter (see screenshot) has a shortcut reference built into the page that screen readers can "see" but is visually hidden for other users.

 

Acceptance criteria:

  • hit keyboard "?" (shift +"?") to open Magnolia shortcut help
  • open dialog with a grid + filterable columns
  • make first column searchable
  • list all keyboard shortcuts to the grid according to this list https://wiki.magnolia-cms.com/display/UX/M6+Keyboard+navigation
  • group shortcuts into collapsable folders in grid
  • add "cancel button" to close dialog
  • add "open doc page" button to open keyboard shortcuts page in docs

 

Developer notes: 

  • Look for lacking i18n in construction of ShortcutListeners.

 

 


Generated at Mon Feb 12 09:12:41 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.