From c538c151c7462ad0395ff2c15c5e11e89e362aa8 Mon Sep 17 00:00:00 2001
From: Striven <sg.striven@cutecat.club>
Date: Sat, 04 Apr 2026 19:47:16 +0000
Subject: [PATCH] Initial commit
---
quartz/components/Breadcrumbs.tsx | 100 +++++++++++++++++++-------------------------------
1 files changed, 38 insertions(+), 62 deletions(-)
diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx
index 467b5a5..5144a31 100644
--- a/quartz/components/Breadcrumbs.tsx
+++ b/quartz/components/Breadcrumbs.tsx
@@ -1,7 +1,8 @@
-import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
import breadcrumbsStyle from "./styles/breadcrumbs.scss"
-import { FullSlug, SimpleSlug, resolveRelative } from "../util/path"
-import { QuartzPluginData } from "../plugins/vfile"
+import { FullSlug, SimpleSlug, resolveRelative, simplifySlug } from "../util/path"
+import { classNames } from "../util/lang"
+import { trieFromAllFiles } from "../util/ctx"
type CrumbData = {
displayName: string
@@ -18,20 +19,20 @@
*/
rootName: string
/**
- * wether to look up frontmatter title for folders (could cause performance problems with big vaults)
+ * Whether to look up frontmatter title for folders (could cause performance problems with big vaults)
*/
resolveFrontmatterTitle: boolean
/**
- * Wether to display breadcrumbs on root `index.md`
+ * Whether to display the current page in the breadcrumbs.
*/
- hideOnRoot: boolean
+ showCurrentPage: boolean
}
const defaultOptions: BreadcrumbOptions = {
- spacerSymbol: ">",
+ spacerSymbol: "❯",
rootName: "Home",
- resolveFrontmatterTitle: false,
- hideOnRoot: true,
+ resolveFrontmatterTitle: true,
+ showCurrentPage: true,
}
function formatCrumb(displayName: string, baseSlug: FullSlug, currentSlug: SimpleSlug): CrumbData {
@@ -41,68 +42,42 @@
}
}
-// 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
- }
- }
- }
- })
-}
-
export default ((opts?: Partial<BreadcrumbOptions>) => {
- // Merge options with defaults
const options: BreadcrumbOptions = { ...defaultOptions, ...opts }
+ const Breadcrumbs: QuartzComponent = ({
+ fileData,
+ allFiles,
+ displayClass,
+ ctx,
+ }: QuartzComponentProps) => {
+ const trie = (ctx.trie ??= trieFromAllFiles(allFiles))
+ const slugParts = fileData.slug!.split("/")
+ const pathNodes = trie.ancestryChain(slugParts)
- function Breadcrumbs({ fileData, allFiles, displayClass }: QuartzComponentProps) {
- // Hide crumbs on root if enabled
- if (options.hideOnRoot && fileData.slug === "index") {
- return <></>
+ if (!pathNodes) {
+ return null
}
- // Format entry for root element
- const firstEntry = formatCrumb(options.rootName, fileData.slug!, "/" as SimpleSlug)
- const crumbs: CrumbData[] = [firstEntry]
-
- // 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 currentTitle = slugParts[i]
-
- // TODO: performance optimizations/memoizing
- // Try to resolve frontmatter folder title
- if (options?.resolveFrontmatterTitle) {
- // try to find file for current path
- const currentFile = findCurrentFile(allFiles, currentTitle)
- if (currentFile) {
- currentTitle = currentFile.frontmatter!.title
- }
- }
- // Add current slug to full path
- currentPath += slugParts[i] + "/"
-
- // Format and add current crumb
- const crumb = formatCrumb(currentTitle, fileData.slug!, currentPath as SimpleSlug)
- crumbs.push(crumb)
+ const crumbs: CrumbData[] = pathNodes.map((node, idx) => {
+ const crumb = formatCrumb(node.displayName, fileData.slug!, simplifySlug(node.slug))
+ if (idx === 0) {
+ crumb.displayName = options.rootName
}
- // Add current file to crumb (can directly use frontmatter title)
- crumbs.push({
- displayName: fileData.frontmatter!.title,
- path: "",
- })
+ // For last node (current page), set empty path
+ if (idx === pathNodes.length - 1) {
+ crumb.path = ""
+ }
+
+ return crumb
+ })
+
+ if (!options.showCurrentPage) {
+ crumbs.pop()
}
+
return (
- <nav class={`breadcrumb-container ${displayClass ?? ""}`} aria-label="breadcrumbs">
+ <nav class={classNames(displayClass, "breadcrumb-container")} aria-label="breadcrumbs">
{crumbs.map((crumb, index) => (
<div class="breadcrumb-element">
<a href={crumb.path}>{crumb.displayName}</a>
@@ -113,5 +88,6 @@
)
}
Breadcrumbs.css = breadcrumbsStyle
+
return Breadcrumbs
}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0