[UXPROD-3156] Apply guidelines for the display of shortcut key combinations in an app's "Keyboard shortcuts" modal Created: 30/Jun/21  Updated: 09/Jan/24  Resolved: 09/Jan/24

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: TBD
Reporter: Gill Osguthorpe Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File image-2021-06-30-16-48-31-690.png    
Issue links:
Defines
is defined by ERM-1757 Agreements: Apply keyboard shortcuts ... Closed
Relates
relates to STCOM-865 Apply guidelines for the display of s... Closed
relates to ERM-1758 Licenses: Apply keyboard shortcuts mo... Closed
relates to ERM-1759 ERM Comparisons: Apply keyboard short... Closed
relates to ERM-1760 Local KB admin: Apply keyboard shortc... Closed
relates to ERM-1761 Dashboard: Apply keyboard shortcuts m... Closed
relates to UXPROD-2059 Keyboard Navigation & Shortcuts Suppo... Closed
Development Team: None
PO Rank: 0
Rank: Cornell (Full Sum 2021): R2

 Description   

Current situation or problem:

All apps will eventually include an option to display keyboard shortcuts in a modal, like the below example for eHoldings.

The order in which keyboard shortcuts are displayed in the modal should be consistent across applications and their presentation should also be consistent. Applying the three guidelines below will achieve this.

Guideline 1

Shortcut key combinations should be presented in Camel Case with spaces between the components.

Key combination  
Ctrl + Alt + E correct
Ctrl+alt+e incorrect
ctrl + alt + e incorrect

Guideline 2

Shortcuts should be described and ordered as per the below list of actions, to achieve consistency across applications.

If a shortcut is not relevant to an app it should be omitted.

A shortcut can be renamed to make it more relevant. For example in eHoldings "Create a new record" is renamed to "Create a new custom package or title record".

1. Create a new record
2. Edit a record
3. Save a record
4. Duplicate a record
6. Expand all accordions
7. Collapse all accordions
8. Expand or collapse an accordion
9. Go to Search & filter pane
10. Open keyboard shortcuts modal
11. Close a modal or pop-up
12. Copy
13. Cut
14. Paste
15. Find

Guideline 3

App specific shortcuts should be displayed at the top of the list, or inserted into the list at a point where they make most sense.

Links to additional info

Guidelines are described on the wiki: https://folio-org.atlassian.net/wiki/display/A11Y/Keyboard+Navigation

Interested parties

Khalilah Gambrell


Generated at Fri Feb 09 00:29:47 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.