From 906f91f8eed5e91a7afae95c7002a3e4553d6aae Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 13 Jul 2023 07:19:35 +0000
Subject: [PATCH] base path refactor, more docs
---
quartz/components/scripts/search.inline.ts | 99 ++++++++++++++++++++++++-------------------------
1 files changed, 49 insertions(+), 50 deletions(-)
diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts
index b1c6265..d92edb1 100644
--- a/quartz/components/scripts/search.inline.ts
+++ b/quartz/components/scripts/search.inline.ts
@@ -1,27 +1,20 @@
import { Document } from "flexsearch"
import { ContentDetails } from "../../plugins/emitters/contentIndex"
-import { registerEscapeHandler } from "./handler"
+import { registerEscapeHandler, clientSideRelativePath, removeAllChildren } from "./util"
+import { CanonicalSlug } from "../../path"
interface Item {
- slug: string,
+ slug: CanonicalSlug,
title: string,
content: string,
}
let index: Document<Item> | undefined = undefined
-function relative(from: string, to: string) {
- const pieces = [location.protocol, '//', location.host, location.pathname]
- const url = pieces.join('').slice(0, -from.length) + to
- return url
-}
-
-function removeAllChildren(node: HTMLElement) {
- node.innerHTML = ``
-}
-
const contextWindowWords = 30
+const numSearchResults = 5
function highlight(searchTerm: string, text: string, trim?: boolean) {
- const tokenizedTerms = searchTerm.split(/\s+/).filter(t => t !== "")
+ // try to highlight longest tokens first
+ const tokenizedTerms = searchTerm.split(/\s+/).filter(t => t !== "").sort((a, b) => b.length - a.length)
let tokenizedText = text
.split(/\s+/)
.filter(t => t !== "")
@@ -52,7 +45,7 @@
// see if this tok is prefixed by any search terms
for (const searchTok of tokenizedTerms) {
if (tok.toLowerCase().includes(searchTok.toLowerCase())) {
- const regex = new RegExp(searchTok, "gi")
+ const regex = new RegExp(searchTok.toLowerCase(), "gi")
return tok.replace(regex, `<span class="highlight">$&</span>`)
}
}
@@ -67,39 +60,9 @@
document.addEventListener("nav", async (e: unknown) => {
const currentSlug = (e as CustomEventMap["nav"]).detail.url
- // setup index if it hasn't been already
const data = await fetchData
- if (!index) {
- index = new Document({
- cache: true,
- charset: 'latin:extra',
- optimize: true,
- encode: encoder,
- document: {
- id: "slug",
- index: [
- {
- field: "title",
- tokenize: "forward",
- },
- {
- field: "content",
- tokenize: "reverse",
- },
- ]
- },
- })
-
- for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
- index.add({
- slug,
- title: fileData.title,
- content: fileData.content
- })
- }
- }
-
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")
@@ -109,12 +72,18 @@
if (searchBar) {
searchBar.value = "" // clear the input when we dismiss the search
}
+ if (sidebar) {
+ sidebar.style.zIndex = "unset"
+ }
if (results) {
removeAllChildren(results)
}
}
function showSearch() {
+ if (sidebar) {
+ sidebar.style.zIndex = "1"
+ }
container?.classList.add("active")
searchBar?.focus()
}
@@ -132,7 +101,7 @@
}
}
- const formatForDisplay = (term: string, slug: string) => ({
+ const formatForDisplay = (term: string, slug: CanonicalSlug) => ({
slug,
title: highlight(term, data[slug].title ?? ""),
content: highlight(term, data[slug].content ?? "", true),
@@ -144,7 +113,7 @@
button.id = slug
button.innerHTML = `<h3>${title}</h3><p>${content}</p>`
button.addEventListener('click', () => {
- const targ = relative(currentSlug, slug)
+ const targ = clientSideRelativePath(currentSlug, slug)
window.spaNavigate(new URL(targ))
})
return button
@@ -167,19 +136,18 @@
function onType(e: HTMLElementEventMap["input"]) {
const term = (e.target as HTMLInputElement).value
- const searchResults = index?.search(term, 5) ?? []
+ const searchResults = index?.search(term, numSearchResults) ?? []
const getByField = (field: string): string[] => {
const results = searchResults.filter((x) => x.field === field)
return results.length === 0 ? [] : [...results[0].result] as string[]
}
// order titles ahead of content
- const allIds: Set<string> = new Set([...getByField("title"), ...getByField("content")])
+ const allIds: Set<CanonicalSlug> = new Set([...getByField("title"), ...getByField("content")])
const finalResults = [...allIds].map(id => formatForDisplay(term, id))
displayResults(finalResults)
}
-
document.removeEventListener("keydown", shortcutHandler)
document.addEventListener("keydown", shortcutHandler)
searchIcon?.removeEventListener("click", showSearch)
@@ -187,6 +155,37 @@
searchBar?.removeEventListener("input", onType)
searchBar?.addEventListener("input", onType)
+ // setup index if it hasn't been already
+ if (!index) {
+ index = new Document({
+ cache: true,
+ charset: 'latin:extra',
+ optimize: true,
+ encode: encoder,
+ document: {
+ id: "slug",
+ index: [
+ {
+ field: "title",
+ tokenize: "forward",
+ },
+ {
+ field: "content",
+ tokenize: "reverse",
+ },
+ ]
+ },
+ })
+
+ for (const [slug, fileData] of Object.entries<ContentDetails>(data)) {
+ await index.addAsync(slug, {
+ slug: slug as CanonicalSlug,
+ title: fileData.title,
+ content: fileData.content
+ })
+ }
+ }
+
// register handlers
registerEscapeHandler(container, hideSearch)
})
--
Gitblit v1.10.0