From 5ccc2dcbba3bfeca2d9edc39209d43d217eb2a80 Mon Sep 17 00:00:00 2001
From: Sohum <31165513+ssmendon@users.noreply.github.com>
Date: Tue, 03 Dec 2024 09:52:51 +0000
Subject: [PATCH] fix(head): update open-graph width and height protocol per ogp (#1512)
---
quartz/components/Explorer.tsx | 94 ++++++++++++++++++++++++++++------------------
1 files changed, 57 insertions(+), 37 deletions(-)
diff --git a/quartz/components/Explorer.tsx b/quartz/components/Explorer.tsx
index 346bd75..ec7c48e 100644
--- a/quartz/components/Explorer.tsx
+++ b/quartz/components/Explorer.tsx
@@ -1,75 +1,91 @@
-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"
// 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 lastBuildId: string = ""
+
+ function constructFileTree(allFiles: QuartzPluginData[]) {
// Construct tree from allFiles
- const 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,
- }
+ fileTree = new FileNode("")
+ allFiles.forEach((file) => fileTree.add(file))
// 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])
+ 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)
+ 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)
+ }
return (
- <div class={`explorer ${displayClass}`}>
+ <div class={classNames(displayClass, "explorer")}>
<button
type="button"
id="explorer"
@@ -77,8 +93,10 @@
data-collapsed={opts.folderDefaultState}
data-savestate={opts.useSavedState}
data-tree={jsonTree}
+ aria-controls="explorer-content"
+ aria-expanded={opts.folderDefaultState === "open"}
>
- <h3>{opts.title}</h3>
+ <h2>{opts.title ?? i18n(cfg.locale).components.explorer.title}</h2>
<svg
xmlns="http://www.w3.org/2000/svg"
width="14"
@@ -95,13 +113,15 @@
</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>
)
}
+
Explorer.css = explorerStyle
Explorer.afterDOMLoaded = script
return Explorer
--
Gitblit v1.10.0