Skip to content

Add keyboard navigation to search #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: stackable
Choose a base branch
from
Open

Add keyboard navigation to search #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 50 additions & 6 deletions src/js/07-search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,54 @@
function openSearchPopover () {
document.getElementById('search-background').style.display = 'block'
document.getElementById('search').style.display = 'block'

// focus the textbox after popover appears
focusSearchInput()
// add eventlisteners after popover appears
addNavigationToSearch()
}

function closeSearchPopover () {
document.getElementById('search-background').style.display = 'none'
document.getElementById('search').style.display = 'none'
}

function focusSearchInput () {
var searchInput = document.querySelector('.pagefind-modular-input')
if (searchInput) {
searchInput.focus()
}
}

function closeSearchPopover () {
document.getElementById('search-background').style.display = 'none'
document.getElementById('search').style.display = 'none'
function addNavigationToSearch () {
// focus the first search result when pressing enter in search input
document.getElementById('pfmod-input-0').addEventListener('keydown', goToSearchResultsOnEnter)
}

function goToSearchResultsOnEnter (event) {
var searchResults = document.getElementById('search-results')
if (event.key === 'Enter' && searchResults.childElementCount > 0) {
searchResults.firstChild.querySelector('a').focus()
searchResults.addEventListener('keydown', addNavigationInSearchResults)
}
}

function addNavigationInSearchResults (event) {
if (event.key === 'ArrowDown' && document.activeElement.classList.contains('pagefind-modular-list-link')) {
event.preventDefault() // prevent page scrolling
var nextSibling = document.activeElement.parentElement.parentElement.parentElement.nextElementSibling
if (nextSibling) {
nextSibling.querySelector('a').focus()
}
}

if (event.key === 'ArrowUp' && document.activeElement.classList.contains('pagefind-modular-list-link')) {
event.preventDefault() // prevent page scrolling
var previousSibling = document.activeElement.parentElement.parentElement.parentElement.previousElementSibling
if (previousSibling) {
previousSibling.querySelector('a').focus()
}
}
}

// open the popover when clicking the magnifying glass search icon
Expand All @@ -28,20 +66,26 @@
// close functionality when clicking the background
var searchBackground = document.getElementById('search-background')
if (searchBackground) {
searchBackground.addEventListener('click', function (e) {
e.stopPropagation() // trap event
searchBackground.addEventListener('click', function (event) {
event.stopPropagation() // trap event
closeSearchPopover()
})
}

// open/close with keyboard
document.addEventListener('keydown', function (event) {
// open search with keyboard
if (event.ctrlKey && event.key === 'k') {
event.preventDefault() // prevent focussing the URL bar in the browser
openSearchPopover()
}
// close search with keyboard
if (event.key === 'Escape') {
closeSearchPopover()
}
// focus the search input when pressing / while search popover is open
if (event.key === '/') {
event.preventDefault() // prevent opening the browser search dialog
focusSearchInput()
}
})
})()