search-with-your-keyboard/readme.md

search-with-your-keyboard

Add keyboard navigation to your existing client-side search interface.

This module is designed to make Algolia InstantSearch results navigable with a keyboard. It's not Algolia-specific though, and should work with any search setup so long as it includes a search input and a list of client-side-updated results.

Behavior

Key	Action
/	Focuses the search input.
esc	Focuses the search input and clears it.
down	Adds an active class to the next result.
up	Adds an active class to the previous result. If already on the first search result, the search input is focused.
enter	Sets window.location to the href of the first <a> tag in the current .active result, if present.

Installation

npm install search-with-your-keyboard

Usage

const searchWithYourKeyboard = require('search-with-your-keyboard')

searchWithYourKeyboard('#search-input', '.ais-hits--item')  

Styles

You should specify styles for the .active class on your results, to make the currently active result visible to the user. You may want this to be the same style as :hovering on a result:

.ais-hits--item:hover, .ais-hits--item.active {
  background-color: #F0F0F0;
}

API

searchWithYourKeyboard(inputSelector, hitsSelector)

Arguments:

• inputSelector String (required) - A CSS selector used to find the search input, e.g. #search-input
• hitsSelector String (required) - A CSS selector used to find all results, e.g. .ais-hits--item

Tests

npm install
npm test

License

MIT