hot-nav
v1.0.10
Published
intuitive accessibility hot keys
Downloads
151
Readme
HOT NAV
Hot-Nav is an accessibility library for adding hotkey functionality to Next.js applications.
Instructions
Install the hot-nav package in the body of your application:
npm install hot-navImport the HotNavProvider component in the root file of your Next.js application and wrap the root of your application in this component:
import { HotNavigationProvider } from 'hot-nav';
export const metadata = {
title: 'My NextJS App',
description: 'This app is accessible and amazing thanks to HotNav!',
};
export default function RootLayout({ children }) {
return (
<html lang="en">
<HotNavigationProvider>
<body>{children}</body>
</HotNavigationProvider>
</html>
);
}Wrap any clickable component you wish in the HotLink component. As you can see, onClick functionality is also supported:
import { HotLink } from "hot-nav";
const SomeReactComponent = () => {
return (
<>
<HotLink>
<a href="/infinity">TO INFINITY</a>
</HotLink>
<HotLink>
<button onClick={() => alert('HOTNAV IS BEYOND AWESOME!!')}>AND BEYOND</button>
</HotLink>
</>
)
}The HotLink component can also function independently as a standalone clickable component:
const SomeReactComponent = () => {
return (
<>
<HotLink href="/infinity">TO INFINITY</HotLink>
<HotLink onClick={() => alert('HOTNAV IS BEYOND AWESOME!!')}>AND BEYOND</HotLink>
</>
)
}Class components are also supported!:
'use client'
import React from 'react';
import { HotLink } from 'hot-nav';
class ClassyLink extends React.Component {
render() {
return <a href='/stayClassy'>{this.props.children}</a>;
}
}
export default class SomeMythicalComponent extends React.Component {
render() {
return (
<HotLink>
<ClassyLink>BACK TO THE FUTURE</ClassyLink>
</HotLink>
)
}
}As you can see, the HotLink component is able to access a nested href attribute. This will work for any level of nesting, both for elements that are returned by wrapper components like ClassyLink, and for elements that are children of a component HotLink is wrapping, as you can see in this extreme example here:
<HotLink>
<div>
<div>
<div>
<div>
<button onClick={() => alert('peep')}>
<div>
<div>
<div>
<a href='/extreme'>This Seems Unreasonable...</a>
</div>
</div>
</div>
</button>
</div>
</div>
</div>
</div>
</HotLink>Now that was extreme! And what in the heck was that button element doing there? Well, as it turns out, HotLink will register both the onClick event, and the nested route to '/extreme'. Pretty cool! However, let's say these elements were to both have 'href' attributes. In this case, the 'href' of the most senior element will take precedence, and the more nested 'href' will be ignored, as is demonstrated below:
//the user will be redirected to '/darthbutton', rather than '/noooooo'
<HotLink>
<button href='/darthbutton' onClick={() => alert("ANCHOR, I AM YOUR FATHER!")}>
<a href='/noooooo'>NOOOOOOOOOO!!!!!!</a>
</button>
</HotLink>User Experience
The hotkey implementation is simple: a unique number is placed directly to the left of each HotLink-wrapped component on the page. These numbers are in incrementing order, so if there are 5 HotLink components, the numbers 1 through 5 will be used as hotkeys. When the user presses and releases a number that is a hotkey, the corresponding component is 'clicked'.
But what if there are more than 9 components? In this case, multi-digit hotkeys are implemented: 12, 13, 14, 15, etc. In these cases, the user must hold down the '1' key, then press the respective 2nd key. In the case of multi-digit hotkeys, simply pressing down the 2nd key will trigger the 'click' (as opposed to the release of the key triggering the 'click'). A concern here might be that lifting the 2 keys that are still pressed might trigger additional hotkeys, but debouncing has been implemented to disable all hotkeys after a click event until all keys have been lifted.
Demo
