@miguellemos/key-nav v1.1.0

KeyNav.js

A pure functional keyboard navigation framework with mathematically sound foundations.

Features

• Arrow key navigation between UI elements
• Enter/Escape for parent-child navigation
• Built on monadic principles for state management
• Automatic handling of sidenav-viewport patterns
• Zero dependencies
• Just ~4KB minified

Installation

npm install @miguellemos/key-nav

Or include directly in your HTML:

<script src="https://unpkg.com/@miguellemos/key-nav@1.0.7/dist/key-nav.js"></script>

CDN

Include the library directly in your HTML using the following CDN link:

<script src="https://unpkg.com/@miguellemos/key-nav@1.0.7/dist/key-nav.js"></script>

Quick Start

Basic Navigation

<div id="root" class="section">
  <div id="section1" class="section">
    <div id="item1" class="item">Item 1</div>
    <div id="item2" class="item">Item 2</div>
  </div>
</div>

<script>
  // Initialize basic navigation
  KeyNav.create(document.getElementById("root"));
</script>

Sidenav with Viewports

<div id="nav-container" class="section">
  <div id="sidenav" class="section">
    <div id="vendor1" class="item" data-viewport="viewport1">Vendor 1</div>
    <div id="vendor2" class="item" data-viewport="viewport2">Vendor 2</div>
  </div>
  <div id="content" class="section">
    <div id="viewport1" class="viewport section">
      <div id="v1-section1" class="item">Section 1</div>
    </div>
    <div id="viewport2" class="viewport section">
      <div id="v2-section1" class="item">Section 1</div>
    </div>
  </div>
</div>

<script>
  // Initialize sidenav-viewport navigation
  KeyNav.createSidenavViewport(document.getElementById("nav-container"));
</script>

Usage

Key Controls

• Arrow Keys: Navigate between siblings (same level)
• Enter: Go deeper into a section (parent to child)
• Escape: Go back up to parent

Element Classes

• Add class="section" to container elements
• Add class="item" to leaf elements
• All elements must have unique id attributes

Dynamic Elements

KeyNav supports dynamic addition or removal of elements through automatic detection or manual refresh:

Automatic Refresh (Default)

By default, KeyNav will automatically detect when elements are added or removed from the DOM and update the navigation structure accordingly:

<div id="root" class="section">
  <div id="section1" class="section">
    <div id="item1" class="item">Item 1</div>
    <div id="item2" class="item">Item 2</div>
  </div>
</div>

<script>
  // Initialize navigation with auto-refresh (default)
  const nav = KeyNav.create(document.getElementById("root"));
  
  // Later, when elements are added dynamically, navigation will update automatically
  const newItem = document.createElement("div");
  newItem.id = "item3";
  newItem.className = "item";
  newItem.textContent = "Item 3";
  document.getElementById("section1").appendChild(newItem);
</script>

You can disable automatic refresh by passing autoRefresh: false in the options:

// Disable automatic refresh
const nav = KeyNav.create(document.getElementById("root"), { autoRefresh: false });

Manual Refresh

You can also manually refresh the navigation structure:

// Later, when elements are added dynamically:
const newItem = document.createElement("div");
newItem.id = "item3";
newItem.className = "item";
newItem.textContent = "Item 3";
document.getElementById("section1").appendChild(newItem);

// Manually refresh the navigation structure
nav.refresh();

When navigation refreshes:

• The DOM structure is re-parsed
• The current selection is maintained if possible
• If the selected element no longer exists, navigation falls back to the root

See the dynamic example for a complete implementation.

License

MIT