From 16a9caa555a2d63b7ff8af0731fbfd3231d6225c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 16 Sep 2024 01:05:17 +0000
Subject: [PATCH] perf: eagerly compute explorer nodes to avoid re-render in memoized value
---
quartz/components/Explorer.tsx | 154 +++++++++++++++++++++++++++++++++------------------
1 files changed, 100 insertions(+), 54 deletions(-)
diff --git a/quartz/components/Explorer.tsx b/quartz/components/Explorer.tsx
index efc9f6a..df876ab 100644
--- a/quartz/components/Explorer.tsx
+++ b/quartz/components/Explorer.tsx
@@ -1,85 +1,131 @@
-import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
import explorerStyle from "./styles/explorer.scss"
// @ts-ignore
import script from "./scripts/explorer.inline"
import { ExplorerNode, FileNode, Options } from "./ExplorerNode"
+import { QuartzPluginData } from "../plugins/vfile"
+import { classNames } from "../util/lang"
+import { i18n } from "../i18n"
+import { VNode } from "preact"
// Options interface defined in `ExplorerNode` to avoid circular dependency
-const defaultOptions = (): Options => ({
- title: "Explorer",
+const defaultOptions = {
folderClickBehavior: "collapse",
folderDefaultState: "collapsed",
useSavedState: true,
- // Sort order: folders first, then files. Sort folders and files alphabetically
+ mapFn: (node) => {
+ return node
+ },
sortFn: (a, b) => {
+ // Sort order: folders first, then files. Sort folders and files alphabetically
if ((!a.file && !b.file) || (a.file && b.file)) {
- return a.name.localeCompare(b.name)
+ // 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>) => {
- function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
- // Parse config
- const opts: Options = { ...defaultOptions(), ...userOpts }
+ // Parse config
+ const opts: Options = { ...defaultOptions, ...userOpts }
+ // memoized
+ let fileTree: FileNode
+ let jsonTree: string
+ let component: VNode
+ let lastBuildId: string = ""
+
+ function constructFileTree(allFiles: QuartzPluginData[]) {
// Construct tree from allFiles
- const fileTree = new FileNode("")
- allFiles.forEach((file) => fileTree.add(file, 1))
+ fileTree = new FileNode("")
+ allFiles.forEach((file) => fileTree.add(file))
- // Sort tree (folders first, then files (alphabetic))
- fileTree.sort(opts.sortFn!)
-
- // If provided, apply filter function to fileTree
- if (opts.filterFn) {
- fileTree.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 (functionName === "map") {
+ fileTree.map(opts.mapFn)
+ } else if (functionName === "sort") {
+ fileTree.sort(opts.sortFn)
+ } else if (functionName === "filter") {
+ fileTree.filter(opts.filterFn)
+ }
+ }
}
// 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)
-
- return (
- <div class={`explorer ${displayClass}`}>
- <button
- type="button"
- id="explorer"
- data-behavior={opts.folderClickBehavior}
- data-collapsed={opts.folderDefaultState}
- data-savestate={opts.useSavedState}
- data-tree={jsonTree}
- >
- <h3>{opts.title}</h3>
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="14"
- height="14"
- viewBox="5 8 14 8"
- fill="none"
- stroke="currentColor"
- stroke-width="2"
- stroke-linecap="round"
- stroke-linejoin="round"
- class="fold"
- >
- <polyline points="6 9 12 15 18 9"></polyline>
- </svg>
- </button>
- <div id="explorer-content">
- <ul class="overflow">
- <ExplorerNode node={fileTree} opts={opts} fileData={fileData} />
- </ul>
- </div>
- </div>
- )
+ const folders = fileTree.getFolderPaths(opts.folderDefaultState === "collapsed")
+ jsonTree = JSON.stringify(folders)
}
+
+ const Explorer: QuartzComponent = ({
+ ctx,
+ cfg,
+ allFiles,
+ displayClass,
+ fileData,
+ }: QuartzComponentProps) => {
+ if (ctx.buildId !== lastBuildId) {
+ lastBuildId = ctx.buildId
+ constructFileTree(allFiles)
+ const tree = ExplorerNode({ node: fileTree, opts, fileData })
+ component = (
+ <div class={classNames(displayClass, "explorer")}>
+ <button
+ type="button"
+ id="explorer"
+ data-behavior={opts.folderClickBehavior}
+ data-collapsed={opts.folderDefaultState}
+ data-savestate={opts.useSavedState}
+ data-tree={jsonTree}
+ aria-controls="explorer-content"
+ aria-expanded={opts.folderDefaultState === "open"}
+ >
+ <h2>{opts.title ?? i18n(cfg.locale).components.explorer.title}</h2>
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="14"
+ height="14"
+ viewBox="5 8 14 8"
+ fill="none"
+ stroke="currentColor"
+ stroke-width="2"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+ class="fold"
+ >
+ <polyline points="6 9 12 15 18 9"></polyline>
+ </svg>
+ </button>
+ <div id="explorer-content">
+ <ul class="overflow" id="explorer-ul">
+ {tree}
+ <li id="explorer-end" />
+ </ul>
+ </div>
+ </div>
+ )
+ }
+
+ return component
+ }
+
Explorer.css = explorerStyle
Explorer.afterDOMLoaded = script
return Explorer
--
Gitblit v1.10.0