From 06e3f8b93d5fbe96e7a05e4eb6be97b6a2d7ead0 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sat, 17 Feb 2024 18:34:51 +0000
Subject: [PATCH] fix(style): introduce semiBoldWeight and various improvements to reduce CLS
---
quartz/components/Breadcrumbs.tsx | 48 +++++++++++++++++++++++++++++++-----------------
1 files changed, 31 insertions(+), 17 deletions(-)
diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx
index 29c73a8..b1a924a 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 { classNames } from "../util/lang"
type CrumbData = {
displayName: string
@@ -18,13 +19,17 @@
*/
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 breadcrumbs on root `index.md`
*/
hideOnRoot: boolean
+ /**
+ * Whether to display the current page in the breadcrumbs.
+ */
+ showCurrentPage: boolean
}
const defaultOptions: BreadcrumbOptions = {
@@ -32,6 +37,7 @@
rootName: "Home",
resolveFrontmatterTitle: true,
hideOnRoot: true,
+ showCurrentPage: true,
}
function formatCrumb(displayName: string, baseSlug: FullSlug, currentSlug: SimpleSlug): CrumbData {
@@ -48,7 +54,11 @@
// computed index of folder name to its associated file data
let folderIndex: Map<string, QuartzPluginData> | undefined
- function Breadcrumbs({ fileData, allFiles, displayClass }: QuartzComponentProps) {
+ const Breadcrumbs: QuartzComponent = ({
+ fileData,
+ allFiles,
+ displayClass,
+ }: QuartzComponentProps) => {
// Hide crumbs on root if enabled
if (options.hideOnRoot && fileData.slug === "index") {
return <></>
@@ -62,12 +72,9 @@
folderIndex = new Map()
// construct the index for the first time
for (const file of allFiles) {
- if (file.slug?.endsWith("index")) {
- const folderParts = file.filePath?.split("/")
- if (folderParts) {
- const folderName = folderParts[folderParts?.length - 2]
- folderIndex.set(folderName, file)
- }
+ const folderParts = file.slug?.split("/")
+ if (folderParts?.at(-1) === "index") {
+ folderIndex.set(folderParts.slice(0, -1).join("/"), file)
}
}
}
@@ -81,9 +88,12 @@
let curPathSegment = slugParts[i]
// Try to resolve frontmatter folder title
- const currentFile = folderIndex?.get(curPathSegment)
+ const currentFile = folderIndex?.get(slugParts.slice(0, i + 1).join("/"))
if (currentFile) {
- curPathSegment = currentFile.frontmatter!.title
+ const title = currentFile.frontmatter!.title
+ if (title !== "index") {
+ curPathSegment = title
+ }
}
// Add current slug to full path
@@ -95,13 +105,16 @@
}
// Add current file to crumb (can directly use frontmatter title)
- crumbs.push({
- displayName: fileData.frontmatter!.title,
- path: "",
- })
+ if (options.showCurrentPage && slugParts.at(-1) !== "index") {
+ crumbs.push({
+ displayName: fileData.frontmatter!.title,
+ path: "",
+ })
+ }
}
+
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>
@@ -112,5 +125,6 @@
)
}
Breadcrumbs.css = breadcrumbsStyle
+
return Breadcrumbs
}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0