From b33f13ccaf4ec14a94ee0ee467dda04cf4981d00 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 01 Jan 2024 22:20:34 +0000
Subject: [PATCH] fix: dont show last page if folder
---
quartz/components/Breadcrumbs.tsx | 91 +++++++++++++++++++++++++--------------------
1 files changed, 50 insertions(+), 41 deletions(-)
diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx
index fb2f0c6..175f6f3 100644
--- a/quartz/components/Breadcrumbs.tsx
+++ b/quartz/components/Breadcrumbs.tsx
@@ -1,7 +1,6 @@
import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
import breadcrumbsStyle from "./styles/breadcrumbs.scss"
import { FullSlug, SimpleSlug, resolveRelative } from "../util/path"
-import { capitalize } from "../util/lang"
import { QuartzPluginData } from "../plugins/vfile"
type CrumbData = {
@@ -26,38 +25,34 @@
* Wether to display breadcrumbs on root `index.md`
*/
hideOnRoot: boolean
+ /**
+ * Wether to display the current page in the breadcrumbs.
+ */
+ showCurrentPage: boolean
}
const defaultOptions: BreadcrumbOptions = {
- spacerSymbol: ">",
+ spacerSymbol: "❯",
rootName: "Home",
- resolveFrontmatterTitle: false,
+ resolveFrontmatterTitle: true,
hideOnRoot: true,
+ showCurrentPage: true,
}
function formatCrumb(displayName: string, baseSlug: FullSlug, currentSlug: SimpleSlug): CrumbData {
- return { displayName, path: resolveRelative(baseSlug, currentSlug) }
-}
-
-// given a folderName (e.g. "features"), search for the corresponding `index.md` file
-function findCurrentFile(allFiles: QuartzPluginData[], folderName: string) {
- return allFiles.find((file) => {
- if (file.slug?.endsWith("index")) {
- const folderParts = file.filePath?.split("/")
- if (folderParts) {
- const name = folderParts[folderParts?.length - 2]
- if (name === folderName) {
- return true
- }
- }
- }
- })
+ return {
+ displayName: displayName.replaceAll("-", " "),
+ path: resolveRelative(baseSlug, currentSlug),
+ }
}
export default ((opts?: Partial<BreadcrumbOptions>) => {
// Merge options with defaults
const options: BreadcrumbOptions = { ...defaultOptions, ...opts }
+ // computed index of folder name to its associated file data
+ let folderIndex: Map<string, QuartzPluginData> | undefined
+
function Breadcrumbs({ fileData, allFiles, displayClass }: QuartzComponentProps) {
// Hide crumbs on root if enabled
if (options.hideOnRoot && fileData.slug === "index") {
@@ -65,39 +60,53 @@
}
// Format entry for root element
- const firstEntry = formatCrumb(capitalize(options.rootName), fileData.slug!, "/" as SimpleSlug)
+ const firstEntry = formatCrumb(options.rootName, fileData.slug!, "/" as SimpleSlug)
const crumbs: CrumbData[] = [firstEntry]
- // Get parts of filePath (every folder)
- const parts = fileData.filePath?.split("/")?.splice(1)
- if (parts) {
- // full path until current part
- let current = ""
- for (let i = 0; i < parts.length - 1; i++) {
- const folderName = parts[i]
- let currentTitle = folderName
-
- // TODO: performance optimizations/memoizing
- // Try to resolve frontmatter folder title
- if (options?.resolveFrontmatterTitle) {
- // try to find file for current path
- const currentFile = findCurrentFile(allFiles, folderName)
- if (currentFile) {
- currentTitle = currentFile.frontmatter!.title
+ if (!folderIndex && options.resolveFrontmatterTitle) {
+ folderIndex = new Map()
+ // construct the index for the first time
+ for (const file of allFiles) {
+ if (file.slug?.endsWith("index")) {
+ const folderParts = file.slug?.split("/")
+ if (folderParts) {
+ // 2nd last to exclude the /index
+ const folderName = folderParts[folderParts?.length - 2]
+ folderIndex.set(folderName, file)
}
}
- // Add current path to full path
- current += folderName + "/"
+ }
+ }
+
+ // Split slug into hierarchy/parts
+ const slugParts = fileData.slug?.split("/")
+ if (slugParts) {
+ // full path until current part
+ let currentPath = ""
+ for (let i = 0; i < slugParts.length - 1; i++) {
+ let curPathSegment = slugParts[i]
+
+ // Try to resolve frontmatter folder title
+ const currentFile = folderIndex?.get(curPathSegment)
+ if (currentFile) {
+ const title = currentFile.frontmatter!.title
+ if (title !== "index") {
+ curPathSegment = title
+ }
+ }
+
+ // Add current slug to full path
+ currentPath += slugParts[i] + "/"
// Format and add current crumb
- const crumb = formatCrumb(capitalize(currentTitle), fileData.slug!, current as SimpleSlug)
+ const crumb = formatCrumb(curPathSegment, fileData.slug!, currentPath as SimpleSlug)
crumbs.push(crumb)
}
// Add current file to crumb (can directly use frontmatter title)
- if (parts.length > 0) {
+ if (options.showCurrentPage && slugParts.at(-1) === "") {
crumbs.push({
- displayName: capitalize(fileData.frontmatter!.title),
+ displayName: fileData.frontmatter!.title,
path: "",
})
}
--
Gitblit v1.10.0