vaadin/framework

Shortcut documentation is bit outdated and could be clearer

Offen

#10.672 geöffnet am 02.03.2018

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (715 Forks)auto 404
Help wantedStaledocumentation

Repository-Metriken

Stars
 (1.806 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Website feedback:advanced-shortcuts.html page is unclear about role of Panel and Window. It says that these either "accept" or "can attach" shortcuts actions. But shortcut actions are added to some component. Documentation could clearly say that shortcut actions should be added to Panel or Window. "Currently, the only classes that accept ShortcutActions are Window and Panel." "Notice that the keyboard actions can currently be attached only to Panels and Windows.

The feedback is not 100% correct, but the documentation could indeed get some clarifications.

Contributor Guide

Research-Richtung
Aktualisieren Sie die Seite advanced shortcuts.html, um klarzustellen, dass ShortcutActions nur zu den Komponenten Panel und Window hinzugefügt werden können, wie im Issue beschrieben. Überprüfen Sie die aktuelle Dokumentation und nehmen Sie die erforderlichen Änderungen vor.
Tech Stack
java
Domain
frontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJava
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85