https://github.com/borisbelmar/arrow-navigation

Light and zero-dependency module to navigate through elements using the arrow keys written in Typescript.
https://github.com/borisbelmar/arrow-navigation

javascript spatial-navigation spatial-navigation-library tizen tv typescript webos

Last synced: about 1 month ago
JSON representation

Light and zero-dependency module to navigate through elements using the arrow keys written in Typescript.

• Host: GitHub
• URL: https://github.com/borisbelmar/arrow-navigation
• Owner: borisbelmar
• Created: 2023-02-28T00:20:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-16T16:04:35.000Z (over 1 year ago)
• Last Synced: 2025-09-28T02:32:44.875Z (8 months ago)
• Topics: javascript, spatial-navigation, spatial-navigation-library, tizen, tv, typescript, webos
• Language: TypeScript
• Homepage: https://arrow-navigation-docs.vercel.app/
• Size: 5.03 MB
• Stars: 20
• Watchers: 1
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![image](assets/logo.png)](https://arrow-navigation-docs.vercel.app/)

[![codecov](https://codecov.io/gh/borisbelmar/arrow-navigation/graph/badge.svg?token=6EEWATKTFX)](https://codecov.io/gh/borisbelmar/arrow-navigation)

### Made with the best tools:

![eslint](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)

![typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![react](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)

![jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)

![yarn](https://img.shields.io/badge/yarn-2C8EBB?style=for-the-badge&logo=yarn&logoColor=white)

### This library works on:

![tizen](https://img.shields.io/badge/tizen-00b6f0.svg?style=for-the-badge&logo=tizen&logoColor=white)

![webos](https://img.shields.io/badge/webos-CB3837.svg?style=for-the-badge&logo=webos&logoColor=white)

# Documentation

All the documentation and demos are available [here](https://arrow-navigation-docs.vercel.app/).

# In this mono-repo

This mono-repo contains the following packages:

- [**@arrow-navigation/core**](packages/an-core/README.md): Light (~16kb) and zero-dependency module to navigate through elements using the arrow keys written in Typescript. You can view the npm package [here](https://www.npmjs.com/package/@arrow-navigation/core).

- [**@arrow-navigation/react**](packages/an-react/README.md): A light and performant React implementation for the core package. You can view the npm package [here](https://www.npmjs.com/package/@arrow-navigation/react).

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

# Live demos

- [**Core demo with Vanilla JS**](https://arrow-navigation-core-demo.pages.dev/): A simple demo using the core package with Vanilla JS and Vite.

- [**React demo**](https://arrow-navigation-react-demo.pages.dev/): 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