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/TableOfContents.tsx | 117 ++++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 97 insertions(+), 20 deletions(-)
diff --git a/quartz/components/TableOfContents.tsx b/quartz/components/TableOfContents.tsx
index 8192da4..bbccf82 100644
--- a/quartz/components/TableOfContents.tsx
+++ b/quartz/components/TableOfContents.tsx
@@ -1,24 +1,101 @@
-import { QuartzComponentProps } from "./types"
-import style from "./styles/toc.scss"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
+import legacyStyle from "./styles/legacyToc.scss"
+import modernStyle from "./styles/toc.scss"
+import { classNames } from "../util/lang"
-export default function TableOfContents({ fileData, position }: QuartzComponentProps) {
- if (!fileData.toc) {
- return null
- }
+// @ts-ignore
+import script from "./scripts/toc.inline"
+import { i18n } from "../i18n"
+import OverflowListFactory from "./OverflowList"
+import { concatenateResources } from "../util/resources"
- if (position === 'body') {
- // TODO: animate this
- return <details className="toc" open>
- <summary><h3>Table of Contents</h3></summary>
- <ul>
- {fileData.toc.map(tocEntry => <li key={tocEntry.slug} className={`depth-${tocEntry.depth}`}>
- <a href={`#${tocEntry.slug}`}>{tocEntry.text}</a>
- </li>)}
- </ul>
- </details>
- } else if (position === 'sidebar') {
- // TODO
- }
+interface Options {
+ layout: "modern" | "legacy"
}
-TableOfContents.css = style
+const defaultOptions: Options = {
+ layout: "modern",
+}
+
+let numTocs = 0
+export default ((opts?: Partial<Options>) => {
+ const layout = opts?.layout ?? defaultOptions.layout
+ const { OverflowList, overflowListAfterDOMLoaded } = OverflowListFactory()
+ const TableOfContents: QuartzComponent = ({
+ fileData,
+ displayClass,
+ cfg,
+ }: QuartzComponentProps) => {
+ if (!fileData.toc) {
+ return null
+ }
+
+ const id = `toc-${numTocs++}`
+ return (
+ <div class={classNames(displayClass, "toc")}>
+ <button
+ type="button"
+ class={fileData.collapseToc ? "collapsed toc-header" : "toc-header"}
+ aria-controls={id}
+ aria-expanded={!fileData.collapseToc}
+ >
+ <h3>{i18n(cfg.locale).components.tableOfContents.title}</h3>
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ fill="none"
+ stroke="currentColor"
+ stroke-width="2"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+ class="fold"
+ >
+ <polyline points="6 9 12 15 18 9"></polyline>
+ </svg>
+ </button>
+ <OverflowList
+ id={id}
+ class={fileData.collapseToc ? "collapsed toc-content" : "toc-content"}
+ >
+ {fileData.toc.map((tocEntry) => (
+ <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
+ <a href={`#${tocEntry.slug}`} data-for={tocEntry.slug}>
+ {tocEntry.text}
+ </a>
+ </li>
+ ))}
+ </OverflowList>
+ </div>
+ )
+ }
+
+ TableOfContents.css = modernStyle
+ TableOfContents.afterDOMLoaded = concatenateResources(script, overflowListAfterDOMLoaded)
+
+ const LegacyTableOfContents: QuartzComponent = ({ fileData, cfg }: QuartzComponentProps) => {
+ if (!fileData.toc) {
+ return null
+ }
+ return (
+ <details class="toc" open={!fileData.collapseToc}>
+ <summary>
+ <h3>{i18n(cfg.locale).components.tableOfContents.title}</h3>
+ </summary>
+ <ul>
+ {fileData.toc.map((tocEntry) => (
+ <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
+ <a href={`#${tocEntry.slug}`} data-for={tocEntry.slug}>
+ {tocEntry.text}
+ </a>
+ </li>
+ ))}
+ </ul>
+ </details>
+ )
+ }
+ LegacyTableOfContents.css = legacyStyle
+
+ return layout === "modern" ? TableOfContents : LegacyTableOfContents
+}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0