From cb68069d455cf513da4eefeab7868062085b4064 Mon Sep 17 00:00:00 2001
From: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 15 Aug 2024 08:24:48 +0000
Subject: [PATCH] chore(deps-dev): bump typescript from 5.5.3 to 5.5.4 (#1343)
---
quartz/components/Breadcrumbs.tsx | 96 +++++++++++++++++++++++++++++------------------
1 files changed, 59 insertions(+), 37 deletions(-)
diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx
index 467b5a5..9ccfb9a 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 { FullSlug, SimpleSlug, joinSegments, resolveRelative } from "../util/path"
import { QuartzPluginData } from "../plugins/vfile"
+import { classNames } from "../util/lang"
type CrumbData = {
displayName: string
@@ -18,20 +19,25 @@
*/
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 = {
- spacerSymbol: ">",
+ spacerSymbol: "❯",
rootName: "Home",
- resolveFrontmatterTitle: false,
+ resolveFrontmatterTitle: true,
hideOnRoot: true,
+ showCurrentPage: true,
}
function formatCrumb(displayName: string, baseSlug: FullSlug, currentSlug: SimpleSlug): CrumbData {
@@ -41,26 +47,18 @@
}
}
-// 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 }
- function Breadcrumbs({ fileData, allFiles, displayClass }: QuartzComponentProps) {
+ // computed index of folder name to its associated file data
+ let folderIndex: Map<string, QuartzPluginData> | undefined
+
+ const Breadcrumbs: QuartzComponent = ({
+ fileData,
+ allFiles,
+ displayClass,
+ }: QuartzComponentProps) => {
// Hide crumbs on root if enabled
if (options.hideOnRoot && fileData.slug === "index") {
return <></>
@@ -70,39 +68,62 @@
const firstEntry = formatCrumb(options.rootName, fileData.slug!, "/" as SimpleSlug)
const crumbs: CrumbData[] = [firstEntry]
+ if (!folderIndex && options.resolveFrontmatterTitle) {
+ folderIndex = new Map()
+ // construct the index for the first time
+ for (const file of allFiles) {
+ const folderParts = file.slug?.split("/")
+ if (folderParts?.at(-1) === "index") {
+ folderIndex.set(folderParts.slice(0, -1).join("/"), file)
+ }
+ }
+ }
+
// Split slug into hierarchy/parts
const slugParts = fileData.slug?.split("/")
if (slugParts) {
+ // is tag breadcrumb?
+ const isTagPath = slugParts[0] === "tags"
+
// full path until current part
let currentPath = ""
- for (let i = 0; i < slugParts.length - 1; i++) {
- let currentTitle = slugParts[i]
- // TODO: performance optimizations/memoizing
+ for (let i = 0; i < slugParts.length - 1; i++) {
+ let curPathSegment = slugParts[i]
+
// 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
+ const currentFile = folderIndex?.get(slugParts.slice(0, i + 1).join("/"))
+ if (currentFile) {
+ const title = currentFile.frontmatter!.title
+ if (title !== "index") {
+ curPathSegment = title
}
}
+
// Add current slug to full path
- currentPath += slugParts[i] + "/"
+ currentPath = joinSegments(currentPath, slugParts[i])
+ const includeTrailingSlash = !isTagPath || i < 1
// Format and add current crumb
- const crumb = formatCrumb(currentTitle, fileData.slug!, currentPath as SimpleSlug)
+ const crumb = formatCrumb(
+ curPathSegment,
+ fileData.slug!,
+ (currentPath + (includeTrailingSlash ? "/" : "")) as SimpleSlug,
+ )
crumbs.push(crumb)
}
// 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>
@@ -113,5 +134,6 @@
)
}
Breadcrumbs.css = breadcrumbsStyle
+
return Breadcrumbs
}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0