From b44a79eebaf1664512ef5ff4e3246b3a6a416ff4 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Tue, 19 Dec 2023 19:40:59 +0000
Subject: [PATCH] fix: wikilinks should allow external links (closes #639)
---
quartz/components/Explorer.tsx | 98 ++++++++++++++++++++++++++++++++++++++----------
1 files changed, 77 insertions(+), 21 deletions(-)
diff --git a/quartz/components/Explorer.tsx b/quartz/components/Explorer.tsx
index ce69491..95eac43 100644
--- a/quartz/components/Explorer.tsx
+++ b/quartz/components/Explorer.tsx
@@ -4,34 +4,89 @@
// @ts-ignore
import script from "./scripts/explorer.inline"
import { ExplorerNode, FileNode, Options } from "./ExplorerNode"
+import { QuartzPluginData } from "../plugins/vfile"
// Options interface defined in `ExplorerNode` to avoid circular dependency
-const defaultOptions = (): Options => ({
+const defaultOptions = {
title: "Explorer",
folderClickBehavior: "collapse",
folderDefaultState: "collapsed",
useSavedState: true,
-})
+ sortFn: (a, b) => {
+ // Sort order: folders first, then files. Sort folders and files alphabetically
+ if ((!a.file && !b.file) || (a.file && b.file)) {
+ // numeric: true: Whether numeric collation should be used, such that "1" < "2" < "10"
+ // sensitivity: "base": Only strings that differ in base letters compare as unequal. Examples: a ≠ b, a = á, a = A
+ return a.displayName.localeCompare(b.displayName, undefined, {
+ numeric: true,
+ sensitivity: "base",
+ })
+ }
+ if (a.file && !b.file) {
+ return 1
+ } else {
+ return -1
+ }
+ },
+ filterFn: (node) => node.name !== "tags",
+ order: ["filter", "map", "sort"],
+} satisfies Options
+
export default ((userOpts?: Partial<Options>) => {
+ // Parse config
+ const opts: Options = { ...defaultOptions, ...userOpts }
+
+ // memoized
+ let fileTree: FileNode
+ let jsonTree: string
+
+ function constructFileTree(allFiles: QuartzPluginData[]) {
+ if (!fileTree) {
+ // Construct tree from allFiles
+ fileTree = new FileNode("")
+ allFiles.forEach((file) => fileTree.add(file, 1))
+
+ /**
+ * Keys of this object must match corresponding function name of `FileNode`,
+ * while values must be the argument that will be passed to the function.
+ *
+ * e.g. entry for FileNode.sort: `sort: opts.sortFn` (value is sort function from options)
+ */
+ const functions = {
+ map: opts.mapFn,
+ sort: opts.sortFn,
+ filter: opts.filterFn,
+ }
+
+ // Execute all functions (sort, filter, map) that were provided (if none were provided, only default "sort" is applied)
+ if (opts.order) {
+ // Order is important, use loop with index instead of order.map()
+ for (let i = 0; i < opts.order.length; i++) {
+ const functionName = opts.order[i]
+ if (functions[functionName]) {
+ // for every entry in order, call matching function in FileNode and pass matching argument
+ // e.g. i = 0; functionName = "filter"
+ // converted to: (if opts.filterFn) => fileTree.filter(opts.filterFn)
+
+ // @ts-ignore
+ // typescript cant statically check these dynamic references, so manually make sure reference is valid and ignore warning
+ fileTree[functionName].call(fileTree, functions[functionName])
+ }
+ }
+ }
+
+ // Get all folders of tree. Initialize with collapsed state
+ const folders = fileTree.getFolderPaths(opts.folderDefaultState === "collapsed")
+
+ // Stringify to pass json tree as data attribute ([data-tree])
+ jsonTree = JSON.stringify(folders)
+ }
+ }
+
function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
- // Parse config
- const opts: Options = { ...defaultOptions(), ...userOpts }
-
- // Construct tree from allFiles
- const fileTree = new FileNode("")
- allFiles.forEach((file) => fileTree.add(file, 1))
-
- // Sort tree (folders first, then files (alphabetic))
- fileTree.sort()
-
- // Get all folders of tree. Initialize with collapsed state
- const folders = fileTree.getFolderPaths(opts.folderDefaultState === "collapsed")
-
- // Stringify to pass json tree as data attribute ([data-tree])
- const jsonTree = JSON.stringify(folders)
-
+ constructFileTree(allFiles)
return (
- <div class={`explorer ${displayClass}`}>
+ <div class={`explorer ${displayClass ?? ""}`}>
<button
type="button"
id="explorer"
@@ -40,7 +95,7 @@
data-savestate={opts.useSavedState}
data-tree={jsonTree}
>
- <h3>{opts.title}</h3>
+ <h1>{opts.title}</h1>
<svg
xmlns="http://www.w3.org/2000/svg"
width="14"
@@ -57,8 +112,9 @@
</svg>
</button>
<div id="explorer-content">
- <ul class="overflow">
+ <ul class="overflow" id="explorer-ul">
<ExplorerNode node={fileTree} opts={opts} fileData={fileData} />
+ <li id="explorer-end" />
</ul>
</div>
</div>
--
Gitblit v1.10.0