From 8a6ebd193933c2879c2a36e1b2f164889575d3bc Mon Sep 17 00:00:00 2001
From: Justin Fowler <justin.fowler@hey.com>
Date: Fri, 02 Feb 2024 04:17:21 +0000
Subject: [PATCH] docs: clarity for `RecentNotes` (#786)
---
quartz/components/scripts/search.inline.ts | 154 +++++++++++++++++++++++++++++++++++++++------------
1 files changed, 117 insertions(+), 37 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index 0124e1f..8ead5c9 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -11,23 +11,29 @@
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"
+// Current search term // TODO: exact match
+let currentSearchTerm: string = ""
+// index for search
+let index: FlexSearch.Document<Item> | undefined = undefined
const contextWindowWords = 30
-const numSearchResults = 5
-const numTagResults = 3
-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
@@ -64,6 +70,7 @@
}
return tok
})
+ .slice(startIndex, endIndex + 1)
.join(" ")
return `${startIndex === 0 ? "" : "..."}${slice}${
@@ -71,6 +78,45 @@
}`
}
+function highlightHTML(searchTerm: string, el: HTMLElement) {
+ // try to highlight longest tokens first
+ 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
+}
+
const p = new DOMParser()
const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
let prevShortcutHandler: ((e: HTMLElementEventMap["keydown"]) => void) | undefined = undefined
@@ -96,6 +142,7 @@
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%"
@@ -122,6 +169,9 @@
if (preview) {
removeAllChildren(preview)
}
+ if (searchLayout) {
+ searchLayout.style.opacity = "0"
+ }
searchType = "basic" // reset search type after closing
}
@@ -135,6 +185,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 +202,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 +343,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 +384,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 +393,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,22 +432,30 @@
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"
}
+ if (term === "" && searchLayout) {
+ searchLayout.style.opacity = "0"
+ }
+
if (term.toLowerCase().startsWith("#")) {
searchType = "tags"
} else {
--
Gitblit v1.10.0