From 9c8fec06d2b58e4e3bbe280ddc665a99fcc4878c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 09 Mar 2025 22:33:15 +0000
Subject: [PATCH] feat: support non-singleton search
---
quartz/components/scripts/search.inline.ts | 213 +++++++++++++++++++++++++++--------------------------
1 files changed, 108 insertions(+), 105 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index 769483d..c9bbcce 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -21,6 +21,7 @@
encode: encoder,
document: {
id: "id",
+ tag: "tags",
index: [
{
field: "title",
@@ -142,83 +143,75 @@
return html.body
}
-document.addEventListener("nav", async (e: CustomEventMap["nav"]) => {
- const currentSlug = e.detail.url
- const data = await fetchData
- const container = document.getElementById("search-container")
- const sidebar = container?.closest(".sidebar") as HTMLElement
- const searchIcon = document.getElementById("search-icon")
- const searchBar = document.getElementById("search-bar") as HTMLInputElement | null
- const searchLayout = document.getElementById("search-layout")
- const idDataMap = Object.keys(data) as FullSlug[]
+async function setupSearch(searchElement: Element, currentSlug: FullSlug, data: ContentIndex) {
+ const container = searchElement.querySelector(".search-container") as HTMLElement
+ if (!container) return
+ const sidebar = container.closest(".sidebar") as HTMLElement
+ if (!sidebar) return
+
+ const searchButton = searchElement.querySelector(".search-button") as HTMLButtonElement
+ if (!searchButton) return
+
+ const searchBar = searchElement.querySelector(".search-bar") as HTMLInputElement
+ if (!searchBar) return
+
+ const searchLayout = searchElement.querySelector(".search-layout") as HTMLElement
+ if (!searchLayout) return
+
+ const idDataMap = Object.keys(data) as FullSlug[]
const appendLayout = (el: HTMLElement) => {
- if (searchLayout?.querySelector(`#${el.id}`) === null) {
- searchLayout?.appendChild(el)
- }
+ searchLayout.appendChild(el)
}
- const enablePreview = searchLayout?.dataset?.preview === "true"
+ const enablePreview = searchLayout.dataset.preview === "true"
let preview: HTMLDivElement | undefined = undefined
let previewInner: HTMLDivElement | undefined = undefined
const results = document.createElement("div")
- results.id = "results-container"
- results.style.flexBasis = enablePreview ? "min(30%, 450px)" : "100%"
+ results.className = "results-container"
appendLayout(results)
if (enablePreview) {
preview = document.createElement("div")
- preview.id = "preview-container"
- preview.style.flexBasis = "100%"
+ preview.className = "preview-container"
appendLayout(preview)
}
function hideSearch() {
- container?.classList.remove("active")
- if (searchBar) {
- searchBar.value = "" // clear the input when we dismiss the search
- }
- if (sidebar) {
- sidebar.style.zIndex = "unset"
- }
- if (results) {
- removeAllChildren(results)
- }
+ container.classList.remove("active")
+ searchBar.value = "" // clear the input when we dismiss the search
+ sidebar.style.zIndex = ""
+ removeAllChildren(results)
if (preview) {
removeAllChildren(preview)
}
- if (searchLayout) {
- searchLayout.style.visibility = "hidden"
- }
-
+ searchLayout.classList.remove("display-results")
searchType = "basic" // reset search type after closing
+ searchButton.focus()
}
function showSearch(searchTypeNew: SearchType) {
searchType = searchTypeNew
- if (sidebar) {
- sidebar.style.zIndex = "1"
- }
- container?.classList.add("active")
- searchBar?.focus()
+ sidebar.style.zIndex = "1"
+ container.classList.add("active")
+ 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()
- const searchBarOpen = container?.classList.contains("active")
+ const searchBarOpen = container.classList.contains("active")
searchBarOpen ? hideSearch() : showSearch("basic")
return
} else if (e.shiftKey && (e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "k") {
// Hotkey to open tag search
e.preventDefault()
- const searchBarOpen = container?.classList.contains("active")
+ const searchBarOpen = container.classList.contains("active")
searchBarOpen ? hideSearch() : showSearch("tags")
// add "#" prefix for tag search
- if (searchBar) searchBar.value = "#"
+ searchBar.value = "#"
return
}
@@ -227,32 +220,32 @@
}
// 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 (!container.classList.contains("active")) return
+ if (e.key === "Enter") {
// If result has focus, navigate to that one, otherwise pick first result
- if (results?.contains(document.activeElement)) {
+ 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
- if (!anchor || anchor?.classList.contains("no-match")) return
+ 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 (results.contains(document.activeElement)) {
// If an element in results-container already has focus, focus previous one
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
+ if (prevResult) currentHover = prevResult
+ await displayPreview(prevResult)
}
} else if (e.key === "ArrowDown" || e.key === "Tab") {
e.preventDefault()
@@ -264,19 +257,9 @@
: (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 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
+ if (secondResult) currentHover = secondResult
+ await displayPreview(secondResult)
}
}
}
@@ -318,47 +301,34 @@
itemTile.classList.add("result-card")
itemTile.id = slug
itemTile.href = resolveUrl(slug).toString()
- itemTile.innerHTML = `<h3>${title}</h3>${htmlTags}<p class="preview">${content}</p>`
+ 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()
+ })
+
+ const handler = (event: MouseEvent) => {
+ if (event.altKey || event.ctrlKey || event.metaKey || event.shiftKey) return
+ hideSearch()
+ }
async function onMouseEnter(ev: MouseEvent) {
if (!ev.target) return
- currentHover?.classList.remove("focus")
- currentHover?.blur()
const target = ev.target as HTMLInputElement
await displayPreview(target)
- currentHover = target
- currentHover.classList.add("focus")
}
- async function onMouseLeave(ev: MouseEvent) {
- if (!ev.target) return
- const target = ev.target as HTMLElement
- 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 const
-
- events.forEach(([event, handler]) => {
- itemTile.addEventListener(event, handler)
- window.addCleanup(() => itemTile.removeEventListener(event, handler))
- })
+ itemTile.addEventListener("mouseenter", onMouseEnter)
+ window.addCleanup(() => itemTile.removeEventListener("mouseenter", onMouseEnter))
+ itemTile.addEventListener("click", handler)
+ window.addCleanup(() => itemTile.removeEventListener("click", handler))
return itemTile
}
async function displayResults(finalResults: Item[]) {
- if (!results) return
-
removeAllChildren(results)
if (finalResults.length === 0) {
results.innerHTML = `<a class="result-card no-match">
@@ -405,12 +375,11 @@
async function displayPreview(el: HTMLElement | null) {
if (!searchLayout || !enablePreview || !el || !preview) return
const slug = el.id as FullSlug
- el.classList.add("focus")
- previewInner = document.createElement("div")
- previewInner.classList.add("preview-inner")
const innerDiv = await fetchContent(slug).then((contents) =>
contents.flatMap((el) => [...highlightHTML(currentSearchTerm, el as HTMLElement).children]),
)
+ previewInner = document.createElement("div")
+ previewInner.classList.add("preview-inner")
previewInner.append(...innerDiv)
preview.replaceChildren(previewInner)
@@ -418,22 +387,44 @@
const highlights = [...preview.querySelectorAll(".highlight")].sort(
(a, b) => b.innerHTML.length - a.innerHTML.length,
)
- highlights[0]?.scrollIntoView()
+ highlights[0]?.scrollIntoView({ block: "start" })
}
async function onType(e: HTMLElementEventMap["input"]) {
if (!searchLayout || !index) return
currentSearchTerm = (e.target as HTMLInputElement).value
- searchLayout.style.visibility = currentSearchTerm === "" ? "hidden" : "visible"
+ searchLayout.classList.toggle("display-results", currentSearchTerm !== "")
searchType = currentSearchTerm.startsWith("#") ? "tags" : "basic"
let searchResults: FlexSearch.SimpleDocumentSearchResultSetUnit[]
if (searchType === "tags") {
- searchResults = await index.searchAsync({
- query: currentSearchTerm.substring(1),
- limit: numSearchResults,
- index: ["tags"],
- })
+ currentSearchTerm = currentSearchTerm.substring(1).trim()
+ const separatorIndex = currentSearchTerm.indexOf(" ")
+ if (separatorIndex != -1) {
+ // search by title and content index and then filter by tag (implemented in flexsearch)
+ const tag = currentSearchTerm.substring(0, separatorIndex)
+ const query = currentSearchTerm.substring(separatorIndex + 1).trim()
+ searchResults = await index.searchAsync({
+ query: query,
+ // return at least 10000 documents, so it is enough to filter them by tag (implemented in flexsearch)
+ limit: Math.max(numSearchResults, 10000),
+ index: ["title", "content"],
+ tag: tag,
+ })
+ for (let searchResult of searchResults) {
+ searchResult.result = searchResult.result.slice(0, numSearchResults)
+ }
+ // set search type to basic and remove tag from term for proper highlightning and scroll
+ searchType = "basic"
+ currentSearchTerm = query
+ } else {
+ // default search by tags index
+ searchResults = await index.searchAsync({
+ query: currentSearchTerm,
+ limit: numSearchResults,
+ index: ["tags"],
+ })
+ }
} else if (searchType === "basic") {
searchResults = await index.searchAsync({
query: currentSearchTerm,
@@ -459,21 +450,23 @@
document.addEventListener("keydown", shortcutHandler)
window.addCleanup(() => document.removeEventListener("keydown", shortcutHandler))
- searchIcon?.addEventListener("click", () => showSearch("basic"))
- window.addCleanup(() => searchIcon?.removeEventListener("click", () => showSearch("basic")))
- searchBar?.addEventListener("input", onType)
- window.addCleanup(() => searchBar?.removeEventListener("input", onType))
+ searchButton.addEventListener("click", () => showSearch("basic"))
+ window.addCleanup(() => searchButton.removeEventListener("click", () => showSearch("basic")))
+ searchBar.addEventListener("input", onType)
+ window.addCleanup(() => searchBar.removeEventListener("input", onType))
registerEscapeHandler(container, hideSearch)
await fillDocument(data)
-})
+}
/**
* Fills flexsearch document with data
* @param index index to fill
* @param data data to fill index with
*/
-async function fillDocument(data: { [key: FullSlug]: ContentDetails }) {
+let indexPopulated = false
+async function fillDocument(data: ContentIndex) {
+ if (indexPopulated) return
let id = 0
const promises: Array<Promise<unknown>> = []
for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
@@ -488,5 +481,15 @@
)
}
- return await Promise.all(promises)
+ await Promise.all(promises)
+ indexPopulated = true
}
+
+document.addEventListener("nav", async (e: CustomEventMap["nav"]) => {
+ const currentSlug = e.detail.url
+ const data = await fetchData
+ const searchElement = document.querySelectorAll(".search")
+ for (const element of searchElement) {
+ await setupSearch(element, currentSlug, data)
+ }
+})
--
Gitblit v1.10.0