UI5 / UI5/docs

`/sap.ui5/commands/shortcuts` description insufficient

Open
#20 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

In Process
Dominant language
No language data
Stars
74
Forks
59
PR merge metrics
No merged PRs in 30d

Description

In the topic Descriptor for Applications, Components, and Libraries section sap.ui5/commands, it says

Specifies provided commands with a unique key/alias. Contains:

  • shortcut: String that describes a key combination. When the user presses the key combination, the command is triggered.

Unfortunately it is not enough to understand how it can be achieved exactly.

  • Is the shortcut value space-sensitive or case-sensitive? (Yes and no, according to the current source code)
  • Are single key commands allowed? (Yes, according to the source code)
  • Are commands freely definable or is there a limited set of allowed commands?
  • Other limitations?
  • Brief documentation regarding the popup opened by the sap.ui.core.ShortcutHintsMixin and how the popup's behavior differs from the native tooltip. → There are cases where the native tooltip and the shortcut popup are both shown at the same time. According to some users, it's confusing since the popup and the native tooltip don't differ much in visual design (depending on the OS).

A link pointing to a dedicated topic would be nice so that readers can learn more if they intend to implement commands.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the sap.ui5/commands section in Descriptor_for_Applications, Components, and Libraries_be0cf40.md, then read sap/ui/core/util/ShortcutHelper.js and sap/ui/core/ShortcutHintsMixin.js alongside the linked shortcut documentation. Done means a dedicated topic explains shortcut syntax and limitations, focus requirements, command configuration, and the popup-versus-tooltip behavior, with a link from the descriptor section.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.