Repolode
jamiebuilds

jamiebuilds/tinykeys

Uma biblioteca pequena de atalhos de teclado para navegadores que associa combinações de teclas, incluindo sequências, a funções manipuladoras.

Estrelas
4,105
Forks
89
Issues abertas
7
Último commit
mês passado

O que é?

tinykeys é uma pequena biblioteca JavaScript para registrar atalhos de teclado em aplicações web. Você passa um alvo, como window, e um objeto que associa padrões de teclas, como "Shift+D" ou "$mod+b", a funções de callback. A biblioteca escuta eventos de teclado e chama a função correspondente. Ela também retorna uma função para cancelar a inscrição, facilitando a limpeza das associações quando um componente é desmontado.

A sintaxe inclui modificadores, modificadores opcionais entre colchetes, o alias multiplataforma $mod, que corresponde a Meta no Mac e a Control em outras plataformas, e grupos de expressões regulares para corresponder a conjuntos de teclas. Também são aceitas sequências como "g i", com um tempo limite configurável entre as teclas. As associações podem corresponder a KeyboardEvent.key ou KeyboardEvent.code, e a biblioteca inclui um helper parseKeybinding para exibir atalhos na interface.

A biblioteca pode ser instalada pelo npm ou carregada de uma CDN, e foi escrita em TypeScript.

Recursos principais

  • 01Associa teclas individuais, combinações com modificadores e sequências de várias teclas a funções manipuladoras.
  • 02Oferece o alias $mod, que corresponde a Meta no Mac e a Control em outras plataformas.
  • 03Aceita grupos de expressões regulares para corresponder a várias teclas com uma única associação.
  • 04Retorna uma função para cancelar a inscrição e limpar os listeners.
  • 05Pode corresponder a key ou code e lida com diferenças de layout de teclado, como AltGraph.
  • 06Oferece parseKeybinding para exibir atalhos na interface.

Casos de uso

  • Adicionar atalhos de teclado, como Cmd+B para negrito, a um editor de texto web.
  • Implementar sequências de navegação com várias teclas, no estilo do Gmail, como "g i", em uma aplicação web.
  • Registrar atalhos em componentes React e fazer a limpeza quando forem desmontados.

Início rápido

  1. 1

    Instale o pacote com npm

    npm install --save tinykeys
  2. 2

    Importe tinykeys e vincule os atalhos a window

Em coleções

Tópicos

Perguntas frequentes

O que é tinykeys?
Uma biblioteca pequena de atalhos de teclado para navegadores que associa combinações de teclas, incluindo sequências, a funções manipuladoras. tinykeys é uma pequena biblioteca JavaScript para registrar atalhos de teclado em aplicações web. Você passa um alvo, como window, e um objeto que associa padrões de teclas, como "Shift+D" ou "$mod+b", a funções de callback. A biblioteca escuta eventos de teclado e chama a função correspondente. Ela também retorna uma função para cancelar a inscrição, facilitando a limpeza das associações quando um componente é desmontado.
tinykeys é gratuito? Qual é a licença?
tinykeys é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
tinykeys ainda é mantido?
Atualizado nos últimos 6 meses. O último commit de tinykeys foi em 25 de set. de 2026.
Para que posso usar tinykeys?
Adicionar atalhos de teclado, como Cmd+B para negrito, a um editor de texto web. Implementar sequências de navegação com várias teclas, no estilo do Gmail, como "g i", em uma aplicação web. Registrar atalhos em componentes React e fazer a limpeza quando forem desmontados.
Como instalar tinykeys?
Instale o pacote com npm: npm install --save tinykeys Importe tinykeys e vincule os atalhos a window
Onde consigo tinykeys?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/jamiebuilds/tinykeys

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados