From 91189dfd2f4cb32e205117b327e0ae7a0c2dd716 Mon Sep 17 00:00:00 2001
From: Emile Bangma <github@emilebangma.com>
Date: Mon, 03 Feb 2025 14:25:42 +0000
Subject: [PATCH] feat(explorer): collapsible mobile explorer (#1471)
---
quartz/components/Explorer.tsx | 120 +++++++++++++++++++++++++++++++++++++----------------------
1 files changed, 75 insertions(+), 45 deletions(-)
diff --git a/quartz/components/Explorer.tsx b/quartz/components/Explorer.tsx
index 79d8781..ac276a8 100644
--- a/quartz/components/Explorer.tsx
+++ b/quartz/components/Explorer.tsx
@@ -1,17 +1,21 @@
-import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
-import explorerStyle from "./styles/explorer.scss"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
+import style 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"
// Options interface defined in `ExplorerNode` to avoid circular dependency
const defaultOptions = {
- title: "Explorer",
folderClickBehavior: "collapse",
folderDefaultState: "collapsed",
useSavedState: true,
+ 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)) {
@@ -22,6 +26,7 @@
sensitivity: "base",
})
}
+
if (a.file && !b.file) {
return 1
} else {
@@ -39,63 +44,87 @@
// memoized
let fileTree: FileNode
let jsonTree: string
+ let lastBuildId: string = ""
function constructFileTree(allFiles: QuartzPluginData[]) {
- if (!fileTree) {
- // Construct tree from allFiles
- fileTree = new FileNode("")
- allFiles.forEach((file) => fileTree.add(file, 1))
+ // Construct tree from allFiles
+ fileTree = new FileNode("")
+ allFiles.forEach((file) => fileTree.add(file))
- /**
- * 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])
- }
+ // 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])
- jsonTree = JSON.stringify(folders)
}
+
+ // Get all folders of tree. Initialize with collapsed state
+ // Stringify to pass json tree as data attribute ([data-tree])
+ const folders = fileTree.getFolderPaths(opts.folderDefaultState === "collapsed")
+ jsonTree = JSON.stringify(folders)
}
- function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
- constructFileTree(allFiles)
+ const Explorer: QuartzComponent = ({
+ ctx,
+ cfg,
+ allFiles,
+ displayClass,
+ fileData,
+ }: QuartzComponentProps) => {
+ if (ctx.buildId !== lastBuildId) {
+ lastBuildId = ctx.buildId
+ constructFileTree(allFiles)
+ }
return (
- <div class={`explorer ${displayClass}`}>
+ <div class={classNames(displayClass, "explorer")}>
<button
type="button"
- id="explorer"
+ id="mobile-explorer"
+ class="collapsed hide-until-loaded"
data-behavior={opts.folderClickBehavior}
data-collapsed={opts.folderDefaultState}
data-savestate={opts.useSavedState}
data-tree={jsonTree}
+ data-mobile={true}
+ aria-controls="explorer-content"
+ aria-expanded={false}
>
- <h1>{opts.title}</h1>
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ stroke-width="2"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+ class="lucide lucide-menu"
+ >
+ <line x1="4" x2="20" y1="12" y2="12" />
+ <line x1="4" x2="20" y1="6" y2="6" />
+ <line x1="4" x2="20" y1="18" y2="18" />
+ </svg>
+ </button>
+ <button
+ type="button"
+ id="desktop-explorer"
+ class="title-button"
+ data-behavior={opts.folderClickBehavior}
+ data-collapsed={opts.folderDefaultState}
+ data-savestate={opts.useSavedState}
+ data-tree={jsonTree}
+ data-mobile={false}
+ aria-controls="explorer-content"
+ aria-expanded={true}
+ >
+ <h2>{opts.title ?? i18n(cfg.locale).components.explorer.title}</h2>
<svg
xmlns="http://www.w3.org/2000/svg"
width="14"
@@ -120,7 +149,8 @@
</div>
)
}
- Explorer.css = explorerStyle
+
+ Explorer.css = style
Explorer.afterDOMLoaded = script
return Explorer
}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0