From 45b93a80f4538b43bf71993d05902308db786051 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 02 Feb 2024 06:22:06 +0000
Subject: [PATCH] fix: index setup, styling fixes
---
quartz/components/scripts/search.inline.ts | 246 +++++++++++++++++++++++++++++++-----------------
1 files changed, 159 insertions(+), 87 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index 0124e1f..55919cd 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -11,23 +11,34 @@
tags: string[]
}
-let index: FlexSearch.Document<Item> | undefined = undefined
-
// Can be expanded with things like "term" in the future
type SearchType = "basic" | "tags"
-
-// Current searchType
let searchType: SearchType = "basic"
+let currentSearchTerm: string = ""
+let index: FlexSearch.Document<Item> | undefined = undefined
+const p = new DOMParser()
+const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
+const fetchContentCache: Map<FullSlug, Element[]> = new Map()
const contextWindowWords = 30
-const numSearchResults = 5
-const numTagResults = 3
+const numSearchResults = 8
+const numTagResults = 5
+
+const tokenizeTerm = (term: string) => {
+ const tokens = term.split(/\s+/).filter((t) => t.trim() !== "")
+
+ const tokenLen = tokens.length
+ if (tokenLen > 1) {
+ for (let i = 1; i < tokenLen; i++) {
+ tokens.push(tokens.slice(0, i + 1).join(" "))
+ }
+ }
+
+ return tokens.sort((a, b) => b.length - a.length) // always highlight longest terms first
+}
+
function highlight(searchTerm: string, text: string, trim?: boolean) {
- // try to highlight longest tokens first
- const tokenizedTerms = searchTerm
- .split(/\s+/)
- .filter((t) => t !== "")
- .sort((a, b) => b.length - a.length)
+ const tokenizedTerms = tokenizeTerm(searchTerm)
let tokenizedText = text.split(/\s+/).filter((t) => t !== "")
let startIndex = 0
@@ -71,17 +82,53 @@
}`
}
-const p = new DOMParser()
-const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
-let prevShortcutHandler: ((e: HTMLElementEventMap["keydown"]) => void) | undefined = undefined
+function highlightHTML(searchTerm: string, el: HTMLElement) {
+ const p = new DOMParser()
+ const tokenizedTerms = tokenizeTerm(searchTerm)
+ const html = p.parseFromString(el.innerHTML, "text/html")
-const fetchContentCache: Map<FullSlug, Element[]> = new Map()
+ const createHighlightSpan = (text: string) => {
+ const span = document.createElement("span")
+ span.className = "highlight"
+ span.textContent = text
+ return span
+ }
+
+ const highlightTextNodes = (node: Node, term: string) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const nodeText = node.nodeValue ?? ""
+ const regex = new RegExp(term.toLowerCase(), "gi")
+ const matches = nodeText.match(regex)
+ if (!matches || matches.length === 0) return
+ const spanContainer = document.createElement("span")
+ let lastIndex = 0
+ for (const match of matches) {
+ const matchIndex = nodeText.indexOf(match, lastIndex)
+ spanContainer.appendChild(document.createTextNode(nodeText.slice(lastIndex, matchIndex)))
+ spanContainer.appendChild(createHighlightSpan(match))
+ lastIndex = matchIndex + match.length
+ }
+ spanContainer.appendChild(document.createTextNode(nodeText.slice(lastIndex)))
+ node.parentNode?.replaceChild(spanContainer, node)
+ } else if (node.nodeType === Node.ELEMENT_NODE) {
+ if ((node as HTMLElement).classList.contains("highlight")) return
+ Array.from(node.childNodes).forEach((child) => highlightTextNodes(child, term))
+ }
+ }
+
+ for (const term of tokenizedTerms) {
+ highlightTextNodes(html.body, term)
+ }
+
+ 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 searchSpace = document.getElementById("search-space")
const sidebar = container?.closest(".sidebar") as HTMLElement
const searchIcon = document.getElementById("search-icon")
const searchBar = document.getElementById("search-bar") as HTMLInputElement | null
@@ -96,15 +143,16 @@
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 ? "30%" : "100%"
+ results.style.flexBasis = enablePreview ? "min(30%, 450px)" : "100%"
appendLayout(results)
if (enablePreview) {
preview = document.createElement("div")
preview.id = "preview-container"
- preview.style.flexBasis = "70%"
+ preview.style.flexBasis = "100%"
appendLayout(preview)
}
@@ -122,6 +170,9 @@
if (preview) {
removeAllChildren(preview)
}
+ if (searchLayout) {
+ searchLayout.style.visibility = "hidden"
+ }
searchType = "basic" // reset search type after closing
}
@@ -135,6 +186,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()
@@ -150,51 +203,61 @@
if (searchBar) searchBar.value = "#"
}
- const resultCards = document.getElementsByClassName("result-card")
+ 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 (results?.contains(document.activeElement)) {
- const active = document.activeElement as HTMLInputElement
- await displayPreview(active)
- if (e.key === "Enter") {
+ 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
+ if (!anchor || anchor?.classList.contains("no-match")) return
+ await displayPreview(anchor)
+ anchor.click()
}
- } else {
- const anchor = resultCards[0] as HTMLInputElement | null
- await displayPreview(anchor)
- if (e.key === "Enter") {
- anchor?.click()
- }
- }
-
- if (e.key === "ArrowUp" || (e.shiftKey && e.key === "Tab")) {
+ } 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 currentResult = document.activeElement as HTMLInputElement | null
+ 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()
// 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 (document.activeElement === searchBar || currentHover !== null) {
+ 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 active = document.activeElement as HTMLInputElement | null
+ 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
}
}
}
@@ -281,14 +344,18 @@
})
async function onMouseEnter(ev: MouseEvent) {
- // When search is active, the first element is in focus, so we need to remove focus if given target is not the first element
- const firstEl = document.getElementsByClassName("result-card")[0] as HTMLAnchorElement | null
- const target = ev.target as HTMLAnchorElement
- if (firstEl !== target) {
- firstEl?.classList.remove("focus")
+ // 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()
}
- target.classList.add("focus")
+ const target = ev.target as HTMLInputElement
await displayPreview(target)
+ currentHover = target
+ currentHover.classList.remove("focus")
}
async function onMouseLeave(ev: MouseEvent) {
@@ -318,7 +385,7 @@
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>`
@@ -327,8 +394,14 @@
}
// focus on first result, then also dispatch preview immediately
if (results?.firstElementChild) {
- results?.firstElementChild?.classList.add("focus")
- await displayPreview(results?.firstElementChild as HTMLElement)
+ const firstChild = results.firstElementChild as HTMLElement
+ if (firstChild.classList.contains("no-match")) {
+ removeAllChildren(preview as HTMLElement)
+ } else {
+ firstChild.classList.add("focus")
+ currentHover = firstChild as HTMLInputElement
+ await displayPreview(firstChild)
+ }
}
}
@@ -360,20 +433,28 @@
el.classList.add("focus")
removeAllChildren(preview as HTMLElement)
- const contentDetails = await fetchContent(slug)
- const previewInner = document.createElement("div")
+ previewInner = document.createElement("div")
previewInner.classList.add("preview-inner")
preview?.appendChild(previewInner)
- contentDetails?.forEach((elt) => previewInner.appendChild(elt))
+
+ const innerDiv = await fetchContent(slug).then((contents) =>
+ contents.map((el) => highlightHTML(currentSearchTerm, el as HTMLElement)),
+ )
+ previewInner.append(...innerDiv)
}
async function onType(e: HTMLElementEventMap["input"]) {
let term = (e.target as HTMLInputElement).value
let searchResults: FlexSearch.SimpleDocumentSearchResultSetUnit[]
+ currentSearchTerm = (e.target as HTMLInputElement).value
if (searchLayout) {
- searchLayout.style.opacity = "1"
+ searchLayout.style.visibility = "visible"
+ }
+
+ if (term === "" && searchLayout) {
+ searchLayout.style.visibility = "hidden"
}
if (term.toLowerCase().startsWith("#")) {
@@ -416,46 +497,15 @@
await displayResults(finalResults)
}
- if (prevShortcutHandler) {
- document.removeEventListener("keydown", prevShortcutHandler)
- }
-
document.addEventListener("keydown", shortcutHandler)
- prevShortcutHandler = shortcutHandler
- searchIcon?.removeEventListener("click", () => showSearch("basic"))
+ window.addCleanup(() => document.removeEventListener("keydown", shortcutHandler))
searchIcon?.addEventListener("click", () => showSearch("basic"))
- searchBar?.removeEventListener("input", onType)
+ window.addCleanup(() => searchIcon?.removeEventListener("click", () => showSearch("basic")))
searchBar?.addEventListener("input", onType)
+ window.addCleanup(() => searchBar?.removeEventListener("input", onType))
- // setup index if it hasn't been already
- if (!index) {
- index = new FlexSearch.Document({
- charset: "latin:extra",
- encode: encoder,
- document: {
- id: "id",
- index: [
- {
- field: "title",
- tokenize: "forward",
- },
- {
- field: "content",
- tokenize: "forward",
- },
- {
- field: "tags",
- tokenize: "forward",
- },
- ],
- },
- })
-
- fillDocument(index, data)
- }
-
- // register handlers
- registerEscapeHandler(container, hideSearch)
+ index ??= await fillDocument(data)
+ registerEscapeHandler(searchSpace, hideSearch)
})
/**
@@ -463,16 +513,38 @@
* @param index index to fill
* @param data data to fill index with
*/
-async function fillDocument(index: FlexSearch.Document<Item, false>, data: any) {
+async function fillDocument(data: { [key: FullSlug]: ContentDetails }) {
+ const index = new FlexSearch.Document<Item>({
+ charset: "latin:extra",
+ encode: encoder,
+ document: {
+ id: "id",
+ index: [
+ {
+ field: "title",
+ tokenize: "forward",
+ },
+ {
+ field: "content",
+ tokenize: "forward",
+ },
+ {
+ field: "tags",
+ tokenize: "forward",
+ },
+ ],
+ },
+ })
let id = 0
for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
- await index.addAsync(id, {
+ await index.addAsync(id++, {
id,
slug: slug as FullSlug,
title: fileData.title,
content: fileData.content,
tags: fileData.tags,
})
- id++
}
+
+ return index
}
--
Gitblit v1.10.0