From 9aa6a18be2eae0d84c7897470a46ede19d5ac191 Mon Sep 17 00:00:00 2001
From: Aaron Pham <29749331+aarnphm@users.noreply.github.com>
Date: Thu, 01 Feb 2024 20:56:42 +0000
Subject: [PATCH] fix(search): improve more general usability (closes #781) (#782)
---
quartz/components/scripts/search.inline.ts | 129 +++++++++++++++++++++++++++++++++---------
1 files changed, 100 insertions(+), 29 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index cbcc9ab..43332a6 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -20,8 +20,8 @@
let searchType: SearchType = "basic"
const contextWindowWords = 30
-const numSearchResults = 5
-const numTagResults = 3
+const numSearchResults = 8
+const numTagResults = 5
function highlight(searchTerm: string, text: string, trim?: boolean) {
// try to highlight longest tokens first
const tokenizedTerms = searchTerm
@@ -86,7 +86,6 @@
const searchIcon = document.getElementById("search-icon")
const searchBar = document.getElementById("search-bar") as HTMLInputElement | null
const searchLayout = document.getElementById("search-layout")
- const resultCards = document.getElementsByClassName("result-card")
const idDataMap = Object.keys(data) as FullSlug[]
const appendLayout = (el: HTMLElement) => {
@@ -123,6 +122,9 @@
if (preview) {
removeAllChildren(preview)
}
+ if (searchLayout) {
+ searchLayout.style.opacity = "0"
+ }
searchType = "basic" // reset search type after closing
}
@@ -136,6 +138,8 @@
searchBar?.focus()
}
+ let currentHover: HTMLInputElement | null = null
+
async function shortcutHandler(e: HTMLElementEventMap["keydown"]) {
if (e.key === "k" && (e.ctrlKey || e.metaKey) && !e.shiftKey) {
e.preventDefault()
@@ -151,42 +155,61 @@
if (searchBar) searchBar.value = "#"
}
+ if (currentHover) {
+ currentHover.classList.remove("focus")
+ }
+
+ // If search is active, then we will render the first result and display accordingly
if (!container?.classList.contains("active")) return
else if (e.key === "Enter") {
// If result has focus, navigate to that one, otherwise pick first result
if (results?.contains(document.activeElement)) {
const active = document.activeElement as HTMLInputElement
+ if (active.classList.contains("no-match")) return
+ await displayPreview(active)
active.click()
} else {
const anchor = document.getElementsByClassName("result-card")[0] as HTMLInputElement | null
- anchor?.click()
+ if (!anchor || anchor?.classList.contains("no-match")) return
+ await displayPreview(anchor)
+ anchor.click()
}
} else if (e.key === "ArrowUp" || (e.shiftKey && e.key === "Tab")) {
e.preventDefault()
if (results?.contains(document.activeElement)) {
// If an element in results-container already has focus, focus previous one
- const prevResult = document.activeElement?.previousElementSibling as HTMLInputElement | null
- if (enablePreview && prevResult?.id) {
- await displayPreview(prevResult?.id as FullSlug)
- }
+ const currentResult = currentHover
+ ? currentHover
+ : (document.activeElement as HTMLInputElement | null)
+ const prevResult = currentResult?.previousElementSibling as HTMLInputElement | null
+ currentResult?.classList.remove("focus")
+ await displayPreview(prevResult)
prevResult?.focus()
+ currentHover = prevResult
}
} else if (e.key === "ArrowDown" || e.key === "Tab") {
e.preventDefault()
- // When first pressing ArrowDown, results wont contain the active element, so focus first element
+ // The results should already been focused, so we need to find the next one.
+ // The activeElement is the search bar, so we need to find the first result and focus it.
if (!results?.contains(document.activeElement)) {
- const firstResult = resultCards[0] as HTMLInputElement | null
- if (enablePreview && firstResult?.id) {
- await displayPreview(firstResult?.id as FullSlug)
- }
- firstResult?.focus()
+ const firstResult = currentHover
+ ? currentHover
+ : (document.getElementsByClassName("result-card")[0] as HTMLInputElement | null)
+ const secondResult = firstResult?.nextElementSibling as HTMLInputElement | null
+ firstResult?.classList.remove("focus")
+ await displayPreview(secondResult)
+ secondResult?.focus()
+ currentHover = secondResult
} else {
// If an element in results-container already has focus, focus next one
- const nextResult = document.activeElement?.nextElementSibling as HTMLInputElement | null
- if (enablePreview && nextResult?.id) {
- await displayPreview(nextResult?.id as FullSlug)
- }
+ const active = currentHover
+ ? currentHover
+ : (document.activeElement as HTMLInputElement | null)
+ active?.classList.remove("focus")
+ const nextResult = active?.nextElementSibling as HTMLInputElement | null
+ await displayPreview(nextResult)
nextResult?.focus()
+ currentHover = nextResult
}
}
}
@@ -262,30 +285,75 @@
const resultToHTML = ({ slug, title, content, tags }: Item) => {
const htmlTags = tags.length > 0 ? `<ul>${tags.join("")}</ul>` : ``
+ const resultContent = enablePreview && window.innerWidth > 600 ? "" : `<p>${content}</p>`
+
const itemTile = document.createElement("a")
itemTile.classList.add("result-card")
- itemTile.id = slug
- itemTile.href = resolveUrl(slug).toString()
- itemTile.innerHTML = `<h3>${title}</h3>${htmlTags}${enablePreview && window.innerWidth > 600 ? "" : `<p>${content}</p>`}`
- itemTile.addEventListener("click", (event) => {
- if (event.altKey || event.ctrlKey || event.metaKey || event.shiftKey) return
- hideSearch()
+ Object.assign(itemTile, {
+ id: slug,
+ href: resolveUrl(slug).toString(),
+ innerHTML: `<h3>${title}</h3>${htmlTags}${resultContent}`,
})
+
+ async function onMouseEnter(ev: MouseEvent) {
+ // Actually when we hover, we need to clean all highlights within the result childs
+ if (!ev.target) return
+ for (const el of document.getElementsByClassName(
+ "result-card",
+ ) as HTMLCollectionOf<HTMLElement>) {
+ el.classList.remove("focus")
+ el.blur()
+ }
+ const target = ev.target as HTMLInputElement
+ await displayPreview(target)
+ currentHover = target
+ currentHover.classList.remove("focus")
+ }
+
+ async function onMouseLeave(ev: MouseEvent) {
+ const target = ev.target as HTMLAnchorElement
+ target.classList.remove("focus")
+ }
+
+ const events = [
+ ["mouseenter", onMouseEnter],
+ ["mouseleave", onMouseLeave],
+ [
+ "click",
+ (event: MouseEvent) => {
+ if (event.altKey || event.ctrlKey || event.metaKey || event.shiftKey) return
+ hideSearch()
+ },
+ ],
+ ] as [keyof HTMLElementEventMap, (this: HTMLElement) => void][]
+
+ events.forEach(([event, handler]) => itemTile.addEventListener(event, handler))
+
return itemTile
}
- function displayResults(finalResults: Item[]) {
+ async function displayResults(finalResults: Item[]) {
if (!results) return
removeAllChildren(results)
if (finalResults.length === 0) {
- results.innerHTML = `<a class="result-card">
+ results.innerHTML = `<a class="result-card no-match">
<h3>No results.</h3>
<p>Try another search term?</p>
</a>`
} else {
results.append(...finalResults.map(resultToHTML))
}
+ // focus on first result, then also dispatch preview immediately
+ if (results?.firstElementChild) {
+ const firstChild = results.firstElementChild as HTMLElement
+ if (firstChild.classList.contains("no-match")) {
+ removeAllChildren(preview as HTMLElement)
+ } else {
+ firstChild.classList.add("focus")
+ await displayPreview(firstChild)
+ }
+ }
}
async function fetchContent(slug: FullSlug): Promise<Element[]> {
@@ -309,8 +377,11 @@
return contents
}
- async function displayPreview(slug: FullSlug) {
- if (!searchLayout || !enablePreview) return
+ async function displayPreview(el: HTMLElement | null) {
+ if (!searchLayout || !enablePreview || !el) return
+
+ const slug = el.id as FullSlug
+ el.classList.add("focus")
removeAllChildren(preview as HTMLElement)
const contentDetails = await fetchContent(slug)
@@ -366,7 +437,7 @@
...getByField("tags"),
])
const finalResults = [...allIds].map((id) => formatForDisplay(term, id))
- displayResults(finalResults)
+ await displayResults(finalResults)
}
if (prevShortcutHandler) {
--
Gitblit v1.10.0