From b029eeadabe0877df6ec11443c68743f1494bc40 Mon Sep 17 00:00:00 2001
From: Ben Schlegel <31989404+benschlegel@users.noreply.github.com>
Date: Wed, 20 Sep 2023 20:55:29 +0000
Subject: [PATCH] feat(explorer): improve accessibility and consistency (+ bug fix) (#488)
---
quartz/components/ExplorerNode.tsx | 40 ++++++++++++++++++++++++++++++++--------
1 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/quartz/components/ExplorerNode.tsx b/quartz/components/ExplorerNode.tsx
index 4d00103..c55a7a0 100644
--- a/quartz/components/ExplorerNode.tsx
+++ b/quartz/components/ExplorerNode.tsx
@@ -1,13 +1,18 @@
// @ts-ignore
-import { QuartzPluginData } from "vfile"
+import { QuartzPluginData } from "../plugins/vfile"
import { resolveRelative } from "../util/path"
+type OrderEntries = "sort" | "filter" | "map"
+
export interface Options {
title: string
folderDefaultState: "collapsed" | "open"
folderClickBehavior: "collapse" | "link"
useSavedState: boolean
sortFn: (a: FileNode, b: FileNode) => number
+ filterFn?: (node: FileNode) => boolean
+ mapFn?: (node: FileNode) => void
+ order?: OrderEntries[]
}
type DataWrapper = {
@@ -30,7 +35,7 @@
constructor(name: string, file?: QuartzPluginData, depth?: number) {
this.children = []
this.name = name
- this.file = file ?? null
+ this.file = file ? structuredClone(file) : null
this.depth = depth ?? 0
}
@@ -67,6 +72,25 @@
}
/**
+ * Filter FileNode tree. Behaves similar to `Array.prototype.filter()`, but modifies tree in place
+ * @param filterFn function to filter tree with
+ */
+ filter(filterFn: (node: FileNode) => boolean) {
+ this.children = this.children.filter(filterFn)
+ this.children.forEach((child) => child.filter(filterFn))
+ }
+
+ /**
+ * Filter FileNode tree. Behaves similar to `Array.prototype.map()`, but modifies tree in place
+ * @param mapFn function to use for mapping over tree
+ */
+ map(mapFn: (node: FileNode) => void) {
+ mapFn(this)
+
+ this.children.forEach((child) => child.map(mapFn))
+ }
+
+ /**
* Get folder representation with state of tree.
* Intended to only be called on root node before changes to the tree are made
* @param collapsed default state of folders (collapsed by default or not)
@@ -121,12 +145,12 @@
}
return (
- <div>
+ <li>
{node.file ? (
// Single file node
<li key={node.file.slug}>
<a href={resolveRelative(fileData.slug!, node.file.slug!)} data-for={node.file.slug}>
- {node.file.frontmatter?.title}
+ {node.name}
</a>
</li>
) : (
@@ -150,17 +174,17 @@
<polyline points="6 9 12 15 18 9"></polyline>
</svg>
{/* render <a> tag if folderBehavior is "link", otherwise render <button> with collapse click event */}
- <li key={node.name} data-folderpath={folderPath}>
+ <div key={node.name} data-folderpath={folderPath}>
{folderBehavior === "link" ? (
<a href={`${folderPath}`} data-for={node.name} class="folder-title">
{node.name}
</a>
) : (
<button class="folder-button">
- <h3 class="folder-title">{node.name}</h3>
+ <p class="folder-title">{node.name}</p>
</button>
)}
- </li>
+ </div>
</div>
)}
{/* Recursively render children of folder */}
@@ -186,6 +210,6 @@
</div>
</div>
)}
- </div>
+ </li>
)
}
--
Gitblit v1.10.0