Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
borisbelmar authored May 8, 2023
1 parent 2dc0bf9 commit 750d1d4
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

Light (~13kb) and zero-dependency module to navigate through elements using the arrow keys written in Typescript.

For live demo, [visit this url](https://arrow-navigation-demo.vercel.app/). For ReactJS implementation, check [@arrow-navigation/react](https://www.npmjs.com/package/@arrow-navigation/react).

## Installation

```bash
Expand All @@ -16,10 +18,6 @@ npm install --save @arrow-navigation/core
yarn add @arrow-navigation/core
```

## What is new?

- **v1.2.8**: Add the `byOrder` option on groups. Now you can navigate by order setted on elements. Can be 'horizontal', 'vertical' or 'grid'. You can also set the number of columns to navigate when the byOrder is 'grid' using the `cols` option.

## Usage

At the top of your application, you need to initialize the module. This will add the event listeners to the document and store the navigation state in a singleton instance.
Expand Down

0 comments on commit 750d1d4

Please sign in to comment.