vaadin/framework

Shortcut documentation is bit outdated and could be clearer

Aberta

#10.672 aberto em 2 de mar. de 2018

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Java (715 forks)auto 404
Help wantedStaledocumentation

Métricas do repositório

Stars
 (1.806 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador

Direção de pesquisa
Atualize a página advanced shortcuts.html para esclarecer que ShortcutActions só pode ser adicionado aos componentes Panel e Window, conforme mencionado na issue. Revise a documentação atual e faça as edições necessárias.
Pilha de tecnologia
java
Domain
frontend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJava
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85