From 16d33fb77193710bede887d6a177d2144b78fb67 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Wed, 20 Sep 2023 23:08:54 +0000
Subject: [PATCH] feat: display name for folders, expand explorer a little bit (#489)
---
docs/features/explorer.md | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/docs/features/explorer.md b/docs/features/explorer.md
index 6f941b8..b0eb12d 100644
--- a/docs/features/explorer.md
+++ b/docs/features/explorer.md
@@ -57,7 +57,8 @@
```ts title="quartz/components/ExplorerNode.tsx" {2-5}
export class FileNode {
children: FileNode[] // children of current node
- name: string // name of node (only useful for folders)
+ name: string // last part of slug
+ displayName: string // what actually should be displayed in the explorer
file: QuartzPluginData | null // set if node is a file, see `QuartzPluginData` for more detail
depth: number // depth of current node
@@ -72,7 +73,7 @@
Component.Explorer({
sortFn: (a, b) => {
if ((!a.file && !b.file) || (a.file && b.file)) {
- return a.name.localeCompare(b.name)
+ return a.displayName.localeCompare(b.displayName)
}
if (a.file && !b.file) {
return 1
@@ -120,7 +121,7 @@
Component.Explorer({
sortFn: (a, b) => {
if ((!a.file && !b.file) || (a.file && b.file)) {
- return a.name.localeCompare(b.name)
+ return a.displayName.localeCompare(b.displayName)
}
if (a.file && !b.file) {
return -1
@@ -138,7 +139,7 @@
```ts title="quartz.layout.ts"
Component.Explorer({
mapFn: (node) => {
- node.name = node.name.toUpperCase()
+ node.displayName = node.displayName.toUpperCase()
},
})
```
@@ -172,9 +173,9 @@
if (node.depth > 0) {
// set emoji for file/folder
if (node.file) {
- node.name = "📄 " + node.name
+ node.displayName = "📄 " + node.displayName
} else {
- node.name = "📁 " + node.name
+ node.displayName = "📁 " + node.displayName
}
}
},
--
Gitblit v1.10.0