Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Keep it Simple 
  2. Avoid using the following characters for shortcut keys: @ {} [] \ ~ | ^ ' < >
  3. Avoid case-sensitive letters 
  4. Ask SIG(s) to document (or provide links) what keyboard shortcuts are used in current system. If possible, try to implement a similar/same shortcut to support a familiar user experience. 
  5. Think of the user workflow when defining keys. For example, if a user takes an action and it is typically followed by another action then the shortcuts should have a similar keyboard shortcut pattern.  
  6. You must define keyboard shortcuts for MacOS and Windows. For MacOS - use  Command + [] and avoid Control. 
  7. Keyboard shortcut pattern: 
    1. Primary actions keyboard shortcut pattern:  cmd / crtl + [letter, if possible the first character in the action name, for example cmd /ctrl+s = Save record]
    2. Secondary actions keyboard shortcut pattern:  cmd / ctrl + alt + [letter, if possible the first character in the action name, for example cmd/ctrl + alt + h = Go to Search & Filter pane 

...

FRONTEND Developer Information: Keyboard shortcuts modal implementation

There is an API! https://github.com/folio-org/stripes-components/tree/master/lib/Commander

...

About this document:  Outline FOLIO keyboard shortcuts and process for app POs/Devs to implement keyboard shortcuts.

Table of Contents
indenth2

Platform-wide keyboard shortcuts (if using standard stripes-components) 

...

Enter (To be implemented move focus to the Results once user hits Enter key STRIPES-652

...

Create/Edit Record: Add a service point, Assign permission/proxy/sponsor, Add address,

and Reset password email. In general any action/button on the Edit record. 

...

Platform-wide keyboard shortcuts (each app must implement) 

...

App specific keyboard shortcut Implementation 

What POs need to know

...

Also

...

Questions to ask SIGs when considering app-specific keyboard shortcuts 

  •  Ask SIG members to describe repeated actions/workflows. Then ask yourself - can a keyboard shortcut streamline the described action/workflow? 
  •  Is there an action that is cumbersome that a keyboard shortcut can address? 

Keyboard shortcut requirements

...

,

...

Defining keyboard shortcuts  - Best practices 

...

keyboard

...

  1. Primary actions keyboard shortcut pattern:  cmd / crtl + [letter, if possible the first character in the action name, for example cmd /ctrl+s = Save record]
  2. Secondary actions keyboard shortcut pattern:  cmd / ctrl + alt + [letter, if possible the first character in the action name, for example cmd/ctrl + alt + h = Go to Search & Filter pane 

What developers need to know

  1. There is an API! https://github.com/folio-org/stripes-components/tree/master/lib/Commander

Keyboard shortcuts modal implementation

Keyboard shortcuts will be displayed for each app in a modal, accessed from the app menu or via the shortcut key combination cmd/ctrl + alt + k. The below guidelines should be applied to achieve consistency across apps. 

...