harshulvijay / keyboard-navigation

Keyboard navigation library

keyboard-navigation

A lightweight library to add keyboard navigation to your project.

Features

• 📦 Tiny: 1.4KB min+gzip
• ⚛️ Reactive: Change key combinations on-the-fly
• 😀 Simple: Easy-to-use API
• 🧙‍♂️ Framework-agnostic: Doesn't depend on any framework, but has wrappers for some frameworks

Installing

Currently, only a Svelte action is available on npm for installation.

Usage

For usage with frameworks, see Wrappers

Demos

Note: You'll need pnpm installed to run the demo.

Run a live demo on your local machine. Run the following commands:

git clone https://github.com/harshulvijay/keyboard-navigation
cd keyboard-navigation/demo
pnpm lib:install # installs the library
pnpm dev # starts the default demo

Open the URL that you see in the terminal to see the demo.

Wrappers

Svelte

See the Svelte action's README.md

Contributing

Feel free to open an issue with feature requests/bug reports.

Note: Please create an issue before opening a PR.

License

License