From c00089bd5728188ce554303b5b18754467c97c85 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 02 Feb 2024 05:19:51 +0000
Subject: [PATCH] chore: add window.addCleanup() for cleaning up handlers
---
quartz/components/scripts/search.inline.ts | 461 ++++++++++++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 400 insertions(+), 61 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index a607fe2..797685a 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -1,25 +1,38 @@
-import { Document } from "flexsearch"
+import FlexSearch from "flexsearch"
import { ContentDetails } from "../../plugins/emitters/contentIndex"
import { registerEscapeHandler, removeAllChildren } from "./util"
-import { CanonicalSlug, getClientSlug, resolveRelative } from "../../path"
+import { FullSlug, normalizeRelativeURLs, resolveRelative } from "../../util/path"
interface Item {
id: number
- slug: CanonicalSlug
+ slug: FullSlug
title: string
content: string
+ tags: string[]
}
-let index: Document<Item> | undefined = undefined
+// Can be expanded with things like "term" in the future
+type SearchType = "basic" | "tags"
+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
-function highlight(searchTerm: string, text: string, trim?: boolean) {
- // try to highlight longest tokens first
- const tokenizedTerms = searchTerm
+const numSearchResults = 8
+const numTagResults = 5
+
+const tokenizeTerm = (term: string) =>
+ term
.split(/\s+/)
.filter((t) => t !== "")
.sort((a, b) => b.length - a.length)
+
+function highlight(searchTerm: string, text: string, trim?: boolean) {
+ // try to highlight longest tokens first
+ const tokenizedTerms = tokenizeTerm(searchTerm)
let tokenizedText = text.split(/\s+/).filter((t) => t !== "")
let startIndex = 0
@@ -27,12 +40,12 @@
if (trim) {
const includesCheck = (tok: string) =>
tokenizedTerms.some((term) => tok.toLowerCase().startsWith(term.toLowerCase()))
- const occurencesIndices = tokenizedText.map(includesCheck)
+ const occurrencesIndices = tokenizedText.map(includesCheck)
let bestSum = 0
let bestIndex = 0
for (let i = 0; i < Math.max(tokenizedText.length - contextWindowWords, 0); i++) {
- const window = occurencesIndices.slice(i, i + contextWindowWords)
+ const window = occurrencesIndices.slice(i, i + contextWindowWords)
const windowSum = window.reduce((total, cur) => total + (cur ? 1 : 0), 0)
if (windowSum >= bestSum) {
bestSum = windowSum
@@ -56,6 +69,7 @@
}
return tok
})
+ .slice(startIndex, endIndex + 1)
.join(" ")
return `${startIndex === 0 ? "" : "..."}${slice}${
@@ -63,17 +77,75 @@
}`
}
-const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
-document.addEventListener("nav", async (e: unknown) => {
- const currentSlug = (e as CustomEventMap["nav"]).detail.url
+function highlightHTML(searchTerm: string, el: HTMLElement) {
+ const p = new DOMParser()
+ const tokenizedTerms = tokenizeTerm(searchTerm)
+ const html = p.parseFromString(el.innerHTML, "text/html")
+
+ const createHighlightSpan = (text: string) => {
+ const span = document.createElement("span")
+ span.className = "highlight"
+ span.textContent = text
+ return span
+ }
+
+ const highlightTextNodes = (node: Node) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ let nodeText = node.nodeValue || ""
+ tokenizedTerms.forEach((term) => {
+ const regex = new RegExp(term.toLowerCase(), "gi")
+ const matches = nodeText.match(regex)
+ const spanContainer = document.createElement("span")
+ let lastIndex = 0
+ matches?.forEach((match) => {
+ 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) {
+ Array.from(node.childNodes).forEach(highlightTextNodes)
+ }
+ }
+
+ highlightTextNodes(html.body)
+ 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 results = document.getElementById("results-container")
- const idDataMap = Object.keys(data) as CanonicalSlug[]
+ const searchLayout = document.getElementById("search-layout")
+ const idDataMap = Object.keys(data) as FullSlug[]
+
+ const appendLayout = (el: HTMLElement) => {
+ if (searchLayout?.querySelector(`#${el.id}`) === null) {
+ searchLayout?.appendChild(el)
+ }
+ }
+
+ 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%"
+ appendLayout(results)
+
+ if (enablePreview) {
+ preview = document.createElement("div")
+ preview.id = "preview-container"
+ preview.style.flexBasis = "70%"
+ appendLayout(preview)
+ }
function hideSearch() {
container?.classList.remove("active")
@@ -86,9 +158,18 @@
if (results) {
removeAllChildren(results)
}
+ if (preview) {
+ removeAllChildren(preview)
+ }
+ if (searchLayout) {
+ searchLayout.style.opacity = "0"
+ }
+
+ searchType = "basic" // reset search type after closing
}
- function showSearch() {
+ function showSearch(searchTypeNew: SearchType) {
+ searchType = searchTypeNew
if (sidebar) {
sidebar.style.zIndex = "1"
}
@@ -96,111 +177,369 @@
searchBar?.focus()
}
- function shortcutHandler(e: HTMLElementEventMap["keydown"]) {
- if (e.key === "k" && (e.ctrlKey || e.metaKey)) {
+ 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")
- searchBarOpen ? hideSearch() : showSearch()
- } else if (e.key === "Enter") {
- const anchor = document.getElementsByClassName("result-card")[0] as HTMLInputElement | null
- if (anchor) {
+ searchBarOpen ? hideSearch() : showSearch("basic")
+ } 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")
+ searchBarOpen ? hideSearch() : showSearch("tags")
+
+ // add "#" prefix for tag search
+ 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
+ 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 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 (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 = 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
+ }
}
}
+ function trimContent(content: string) {
+ // works without escaping html like in `description.ts`
+ const sentences = content.replace(/\s+/g, " ").split(".")
+ let finalDesc = ""
+ let sentenceIdx = 0
+
+ // Roughly estimate characters by (words * 5). Matches description length in `description.ts`.
+ const len = contextWindowWords * 5
+ while (finalDesc.length < len) {
+ const sentence = sentences[sentenceIdx]
+ if (!sentence) break
+ finalDesc += sentence + "."
+ sentenceIdx++
+ }
+
+ // If more content would be available, indicate it by finishing with "..."
+ if (finalDesc.length < content.length) {
+ finalDesc += ".."
+ }
+
+ return finalDesc
+ }
+
const formatForDisplay = (term: string, id: number) => {
const slug = idDataMap[id]
return {
id,
slug,
- title: highlight(term, data[slug].title ?? ""),
- content: highlight(term, data[slug].content ?? "", true),
+ title: searchType === "tags" ? data[slug].title : highlight(term, data[slug].title ?? ""),
+ // if searchType is tag, display context from start of file and trim, otherwise use regular highlight
+ content:
+ searchType === "tags"
+ ? trimContent(data[slug].content)
+ : highlight(term, data[slug].content ?? "", true),
+ tags: highlightTags(term, data[slug].tags),
}
}
- const resultToHTML = ({ slug, title, content }: Item) => {
- const button = document.createElement("button")
- button.classList.add("result-card")
- button.id = slug
- button.innerHTML = `<h3>${title}</h3><p>${content}</p>`
- button.addEventListener("click", () => {
- const targ = resolveRelative(currentSlug, slug)
- window.spaNavigate(new URL(targ, getClientSlug(window)))
- })
- return button
+ function highlightTags(term: string, tags: string[]) {
+ if (tags && searchType === "tags") {
+ // Find matching tags
+ const termLower = term.toLowerCase()
+ let matching = tags.filter((str) => str.includes(termLower))
+
+ // Subtract matching from original tags, then push difference
+ if (matching.length > 0) {
+ let difference = tags.filter((x) => !matching.includes(x))
+
+ // Convert to html (cant be done later as matches/term dont get passed to `resultToHTML`)
+ matching = matching.map((tag) => `<li><p class="match-tag">#${tag}</p></li>`)
+ difference = difference.map((tag) => `<li><p>#${tag}</p></li>`)
+ matching.push(...difference)
+ }
+
+ // Only allow max of `numTagResults` in preview
+ if (tags.length > numTagResults) {
+ matching.splice(numTagResults)
+ }
+
+ return matching
+ } else {
+ return []
+ }
}
- function displayResults(finalResults: Item[]) {
+ function resolveUrl(slug: FullSlug): URL {
+ return new URL(resolveRelative(currentSlug, slug), location.toString())
+ }
+
+ 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")
+ 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
+ }
+
+ async function displayResults(finalResults: Item[]) {
if (!results) return
removeAllChildren(results)
if (finalResults.length === 0) {
- results.innerHTML = `<button class="result-card">
+ results.innerHTML = `<a class="result-card no-match">
<h3>No results.</h3>
<p>Try another search term?</p>
- </button>`
+ </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")
+ currentHover = firstChild as HTMLInputElement
+ await displayPreview(firstChild)
+ }
+ }
+ }
+
+ async function fetchContent(slug: FullSlug): Promise<Element[]> {
+ if (fetchContentCache.has(slug)) {
+ return fetchContentCache.get(slug) as Element[]
+ }
+
+ const targetUrl = resolveUrl(slug).toString()
+ const contents = await fetch(targetUrl)
+ .then((res) => res.text())
+ .then((contents) => {
+ if (contents === undefined) {
+ throw new Error(`Could not fetch ${targetUrl}`)
+ }
+ const html = p.parseFromString(contents ?? "", "text/html")
+ normalizeRelativeURLs(html, targetUrl)
+ return [...html.getElementsByClassName("popover-hint")]
+ })
+
+ fetchContentCache.set(slug, contents)
+ return contents
+ }
+
+ 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)
+
+ previewInner = document.createElement("div")
+ previewInner.classList.add("preview-inner")
+ preview?.appendChild(previewInner)
+
+ const innerDiv = await fetchContent(slug).then((contents) =>
+ contents.map((el) => highlightHTML(currentSearchTerm, el as HTMLElement)),
+ )
+ previewInner.append(...innerDiv)
}
async function onType(e: HTMLElementEventMap["input"]) {
- const term = (e.target as HTMLInputElement).value
- const searchResults = (await index?.searchAsync(term, numSearchResults)) ?? []
- console.log(searchResults)
+ let term = (e.target as HTMLInputElement).value
+ let searchResults: FlexSearch.SimpleDocumentSearchResultSetUnit[]
+ currentSearchTerm = (e.target as HTMLInputElement).value
+
+ if (searchLayout) {
+ searchLayout.style.opacity = "1"
+ }
+
+ if (term === "" && searchLayout) {
+ searchLayout.style.opacity = "0"
+ }
+
+ if (term.toLowerCase().startsWith("#")) {
+ searchType = "tags"
+ } else {
+ searchType = "basic"
+ }
+
+ switch (searchType) {
+ case "tags": {
+ term = term.substring(1)
+ searchResults =
+ (await index?.searchAsync({ query: term, limit: numSearchResults, index: ["tags"] })) ??
+ []
+ break
+ }
+ case "basic":
+ default: {
+ searchResults =
+ (await index?.searchAsync({
+ query: term,
+ limit: numSearchResults,
+ index: ["title", "content"],
+ })) ?? []
+ }
+ }
+
const getByField = (field: string): number[] => {
const results = searchResults.filter((x) => x.field === field)
return results.length === 0 ? [] : ([...results[0].result] as number[])
}
// order titles ahead of content
- const allIds: Set<number> = new Set([...getByField("title"), ...getByField("content")])
+ const allIds: Set<number> = new Set([
+ ...getByField("title"),
+ ...getByField("content"),
+ ...getByField("tags"),
+ ])
const finalResults = [...allIds].map((id) => formatForDisplay(term, id))
- displayResults(finalResults)
+ await displayResults(finalResults)
}
- document.removeEventListener("keydown", shortcutHandler)
document.addEventListener("keydown", shortcutHandler)
- searchIcon?.removeEventListener("click", showSearch)
- searchIcon?.addEventListener("click", showSearch)
- searchBar?.removeEventListener("input", onType)
+ 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))
// setup index if it hasn't been already
if (!index) {
- index = new Document({
- cache: true,
+ index = new FlexSearch.Document({
charset: "latin:extra",
- optimize: true,
encode: encoder,
document: {
id: "id",
index: [
{
field: "title",
- tokenize: "reverse",
+ tokenize: "forward",
},
{
field: "content",
- tokenize: "reverse",
+ tokenize: "forward",
+ },
+ {
+ field: "tags",
+ tokenize: "forward",
},
],
},
})
- let id = 0
- for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
- await index.addAsync(id, {
- id,
- slug: slug as CanonicalSlug,
- title: fileData.title,
- content: fileData.content,
- })
- id++
- }
+ fillDocument(index, data)
}
// register handlers
registerEscapeHandler(container, hideSearch)
})
+
+/**
+ * Fills flexsearch document with data
+ * @param index index to fill
+ * @param data data to fill index with
+ */
+async function fillDocument(index: FlexSearch.Document<Item, false>, data: any) {
+ let id = 0
+ for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
+ await index.addAsync(id++, {
+ id,
+ slug: slug as FullSlug,
+ title: fileData.title,
+ content: fileData.content,
+ tags: fileData.tags,
+ })
+ }
+}
--
Gitblit v1.10.0