Add keyboard navigation to repository overview list (#2146)

A new api is introduced to allow focus-based list iteration through keyboard shortcuts. The api is initially considered closed and only used in the repository overview.

Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
This commit is contained in:
Konstantin Schaper
2022-11-04 18:05:16 +01:00
committed by GitHub
parent 7b933c6821
commit e74d0c9c8b
12 changed files with 469 additions and 27 deletions

View File

@@ -5,7 +5,8 @@ Der SCM-Manager unterstützt Tastaturinteraktion und -navigation durch zusätzli
### Übersicht
Während sie den SCM-Manager verwenden, können sie eine Übersicht aller dem aktiven Benutzer auf der aktuellen Seite verfügbaren Tastenkürzel mittels der `?`-Taste aufrufen.
Während Sie den SCM-Manager verwenden, können Sie eine Übersicht aller
verfügbaren Tastenkürzel mittels der `?`-Taste aufrufen.
### Globale Tastenkürzel
@@ -18,20 +19,31 @@ Während sie den SCM-Manager verwenden, können sie eine Übersicht aller dem ak
| alt g | Navigiere zur Gruppenübersicht |
| alt a | Navigiere zur Administration |
### Navigation von Listen
Einige Seiten mit Listen erlauben die Navigation per Tastatur.
Wenn die Seite dieses unterstützt, tauchen die Tastaturkürzel in der Übersicht im SCM-Manager
auf (`?`).
| Key Combination | Description |
|-----------------|---------------------------------------------------|
| j | Bewege den Fokus auf den nächsten Listeneintrag |
| k | Bewege den Fokus auf den vorherigen Listeneintrag |
### Repositoryspezifische Tastenkürzel
| Key Combination | Description |
|-----------------|---------------|
| g i | Info |
| g b | Branches |
| g t | Tags |
| g c | Code |
| g s | Einstellungen |
| Key Combination | Description |
|-----------------|------------------------------|
| g i | Wechsel zur Repository-Info |
| g b | Wechsel zu den Branches |
| g t | Wechsel zu den Tags |
| g c | Wechsel zum Code |
| g s | Wechsel zu den Einstellungen |
### Tastenkürzel aus Plugin
Plugins können selbst neue Tastenkürzel definieren.
Diese können global oder repository-spezifisch sein oder in einem komplett anderen Kontext angewandt werden.
Sie werden automatisch in der Übersicht im SCM-Manager mit aufgelistet.
Um die Tastenkürzel eines Plugins innerhalb der Benutzerdokumentation zu finden, verweisen wir hier auf die Dokumentation
des jeweiligen Plugins.
Um die Tastenkürzel eines Plugins innerhalb der Benutzerdokumentation zu finden, verweisen wir hier auf die
Dokumentation des jeweiligen Plugins.

View File

@@ -19,15 +19,25 @@ from anywhere by pressing the `?` key.
| alt g | Navigate to Groups |
| alt a | Navigate to Administration |
### List Navigation
Some pages with lists on them support keyboard navigation.
If the page supports this feature, the shortcuts show up in the shortcut overview dialog (`?`).
| Key Combination | Description |
|-----------------|--------------------------|
| j | Focus next list item |
| k | Focus previous list item |
### Repository-specific Shortcuts
| Key Combination | Description |
|-----------------|-------------|
| g i | Info |
| g b | Branches |
| g t | Tags |
| g c | Code |
| g s | Settings |
| Key Combination | Description |
|-----------------|---------------------------|
| g i | Switch to repository info |
| g b | Switch to branches |
| g t | Switch to tags |
| g c | Switch to code |
| g s | Switch to settings |
### Plugin Shortcuts