Repolode
jamiebuilds

jamiebuilds/tinykeys

Una pequeña biblioteca de atajos de teclado para navegadores que asigna combinaciones, incluidas secuencias de varias teclas, a funciones de manejo.

Estrellas
4,104
Forks
89
Issues abiertos
7
Último commit
el mes pasado

¿Qué es?

tinykeys es una pequeña biblioteca de JavaScript para registrar atajos de teclado en aplicaciones web. Se le pasa un destino, como window, y un objeto que asigna patrones de teclas como "Shift+D" o "$mod+b" a funciones callback. La biblioteca escucha los eventos de teclado y llama al manejador correspondiente. También devuelve una función para cancelar la suscripción, lo que facilita limpiar las asignaciones cuando se desmonta un componente.

La sintaxis incluye modificadores, modificadores opcionales entre corchetes, el alias multiplataforma $mod (que corresponde a Meta en Mac y a Control en el resto de plataformas) y grupos de expresiones regulares para coincidir con conjuntos de teclas. También admite secuencias como "g i", con un tiempo de espera configurable entre pulsaciones. Las asignaciones pueden coincidir con KeyboardEvent.key o KeyboardEvent.code, y la biblioteca incluye un helper llamado parseKeybinding para mostrar atajos en una interfaz de usuario.

La biblioteca se puede instalar desde npm o cargar desde una CDN, y está escrita en TypeScript.

Funciones clave

  • 01Asigna teclas individuales, combinaciones con modificadores y secuencias de varias teclas a funciones de manejo.
  • 02Ofrece un alias $mod que corresponde a Meta en Mac y a Control en otras plataformas.
  • 03Admite grupos de expresiones regulares para que una asignación coincida con varias teclas.
  • 04Devuelve una función para cancelar la suscripción y limpiar los listeners.
  • 05Puede coincidir con key o code y contempla diferencias en la distribución del teclado, como AltGraph.
  • 06Ofrece parseKeybinding para mostrar atajos en una interfaz de usuario.

Casos de uso

  • Añadir atajos de teclado, como Cmd+B para aplicar negrita, a un editor de texto web.
  • Implementar secuencias de navegación de varias teclas al estilo de Gmail, como "g i", en una aplicación web.
  • Registrar atajos dentro de componentes de React y limpiarlos cuando se desmontan.

Inicio rápido

  1. 1

    Instala el paquete con npm

    npm install --save tinykeys
  2. 2

    Importa tinykeys y vincula los atajos a window

En colecciones

Temas

Preguntas frecuentes

¿Qué es tinykeys?
Una pequeña biblioteca de atajos de teclado para navegadores que asigna combinaciones, incluidas secuencias de varias teclas, a funciones de manejo. tinykeys es una pequeña biblioteca de JavaScript para registrar atajos de teclado en aplicaciones web. Se le pasa un destino, como window, y un objeto que asigna patrones de teclas como "Shift+D" o "$mod+b" a funciones callback. La biblioteca escucha los eventos de teclado y llama al manejador correspondiente. También devuelve una función para cancelar la suscripción, lo que facilita limpiar las asignaciones cuando se desmonta un componente.
¿tinykeys es gratuito? ¿Qué licencia tiene?
tinykeys es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿tinykeys sigue mantenido?
Actualizado en los últimos 6 meses. El último commit de tinykeys fue el 25 sept 2026.
¿Para qué puedo usar tinykeys?
Añadir atajos de teclado, como Cmd+B para aplicar negrita, a un editor de texto web. Implementar secuencias de navegación de varias teclas al estilo de Gmail, como "g i", en una aplicación web. Registrar atajos dentro de componentes de React y limpiarlos cuando se desmontan.
¿Cómo se instala tinykeys?
Instala el paquete con npm: npm install --save tinykeys Importa tinykeys y vincula los atajos a window
¿Dónde consigo tinykeys?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/jamiebuilds/tinykeys

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados