https://github.com/danilowoz/spatial-keyboard-navigation

A visual hierarchy approach to navigate through selectable elements on a page.
https://github.com/danilowoz/spatial-keyboard-navigation

Last synced: 12 days ago
JSON representation

A visual hierarchy approach to navigate through selectable elements on a page.

• Host: GitHub
• URL: https://github.com/danilowoz/spatial-keyboard-navigation
• Owner: danilowoz
• Created: 2021-08-08T20:49:51.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-12T16:07:28.000Z (about 3 years ago)
• Last Synced: 2024-08-07T08:15:01.741Z (3 months ago)
• Language: TypeScript
• Homepage: https://spatial-keyboard-navigation.vercel.app/
• Size: 9.24 MB
• Stars: 211
• Watchers: 5
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
Spatial keyboard navigation

A visual hierarchy approach to navigate through selectable elements on a page.



  





  Example: Use the arrow keys to navigate. See full video bellow.



### Motivation

> The following project is an experiment and it's still under exploration.

The current way to navigate through selectable elements in a page hasn't changed much, and we are used to considering it the right way to navigate in a DOM document, but I'd like to bring a fresh perspective on this approach.

Human beings generally use visualization methods to memorize and understand the space they are surrounded by. Still, for some reason, the browsers don't use these methods in favor of user experience. The TAB key has been great for a long time and it solves many problems, so **what's wrong with using it to navigate in a DOM document?**

- It follows the order of the DOM elements and not the visual position of these elements on the page, which means that it uses the HTML structure (not user-friendly), but it should go after the layout position (spatial position);

- There is no easy way to jump long distances in the interface: TAB key navigation obligates you to go through all elements between your starting point and the target point;

- It's hard to memorize the path to select an element on the page because the DOM document doesn't follow a human-friendly order.

### Spatial sensitive keyboard navigation

Graphical User Interface has already been using analogies from the real world on the computer universe (e.g., floppy disk for saving files). Bringing a spatial navigation approach might also improve the navigation in a DOM document.

That said, putting all selectable elements in a visual hierarchy structure and using the arrow keys to navigate through them might be the easiest way to introduce this new concept, which would work just like a spreadsheet.

https://user-images.githubusercontent.com/4838076/136709247-42102aa2-6a3e-4e0c-9e4a-d6d65a1defd4.mp4

This approach makes it easier and faster to navigate through the selectable elements, plus it doesn't introduce any new aspects and it doesn't require any new learnings from the users.

**The memory journey**

However, to make navigation even faster and make it even easier to memorize the "paths" the users take on the page, we need to picture that these selectable items belong to a group of items, or that there are "paths" to get to them. These issues lead to the following concepts:

- Areas: in the real world, you'd expect to see a refrigerator in a kitchen. Just like in the kitchen, Areas gather the things that belong to the same place, putting them together in a big selectable element;

- Paths: storing and reproducing the finding the shortest path from one point to another, which is often unnoticed by us, is essential to make navigation snappier and more natural.

### Usage

To get started, install the package and wrap the whole application using the following Provider component:

```jsx

import { Provider } from "spatial-keyboard-navigation";

const App = ({ children }) => {children};

```

| Prop name       | Description                                                    | Type      | Default value   |

| --------------- | -------------------------------------------------------------- | --------- | --------------- |

| `areaClassName` | ClassName when the area is selected                            | `string`  | `area-selected` |

| `strictArea`    | It doesn't allow the user navigate beyond the area boundaries. | `boolean` | `false`         |

### Components

Spatial navigation introduces two main components to make the items selectable: `Anchor` and `Area`

```jsx

import { Area, Anchor } from "spatial-keyboard-navigation";

const Sidebar = () => {

  return (

    

      

        

          Item

        

        

          Item

        

        

          Item

        

      

    

  );

};

```

**Reference**

[Zeh Fernandes](https://twitter.com/zehf)

[https://en.wikipedia.org/wiki/Method_of_loci](https://en.wikipedia.org/wiki/Method_of_loci)