README.md

Made with the best tools:

This library works on:

Documentation

All the documentation and demos are available here.

In this mono-repo

This mono-repo contains the following packages:

• @arrow-navigation/core: Light (~16kb) and zero-dependency module to navigate through elements using the arrow keys written in Typescript. You can view the npm package here.
• @arrow-navigation/react: A light and performant React implementation for the core package. You can view the npm package here.

All the documentation is available in the README of each package.

Live demos

• Core demo with Vanilla JS: A simple demo using the core package with Vanilla JS and Vite.
• React demo: A simple demo using the React package with Vite.

How to use this repo

1. Clone the repo
2. Install the dependencies with yarn install
3. Initialize the packages and demos with yarn dev

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Keep the coverage at +95% and run yarn test before commit.

License

MIT