2023-06-12 06:46:38 +00:00
|
|
|
import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
|
2023-06-17 02:41:59 +00:00
|
|
|
import legacyStyle from "./styles/legacyToc.scss"
|
|
|
|
import modernStyle from "./styles/toc.scss"
|
2024-02-05 10:45:36 +00:00
|
|
|
import { classNames } from "../util/lang"
|
2023-06-10 06:06:02 +00:00
|
|
|
|
2023-06-17 19:07:40 +00:00
|
|
|
// @ts-ignore
|
|
|
|
import script from "./scripts/toc.inline"
|
2024-02-05 10:45:36 +00:00
|
|
|
import { i18n } from "../i18n"
|
2023-06-17 19:07:40 +00:00
|
|
|
|
2023-06-13 05:41:42 +00:00
|
|
|
interface Options {
|
2023-07-23 00:27:41 +00:00
|
|
|
layout: "modern" | "legacy"
|
2023-06-13 05:41:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const defaultOptions: Options = {
|
2023-07-23 00:27:41 +00:00
|
|
|
layout: "modern",
|
2023-06-10 06:06:02 +00:00
|
|
|
}
|
|
|
|
|
2024-02-05 10:45:36 +00:00
|
|
|
function TableOfContents({ fileData, displayClass, cfg }: QuartzComponentProps) {
|
2023-06-17 19:07:40 +00:00
|
|
|
if (!fileData.toc) {
|
|
|
|
return null
|
|
|
|
}
|
2023-06-12 06:46:38 +00:00
|
|
|
|
2023-07-23 00:27:41 +00:00
|
|
|
return (
|
2024-02-05 10:45:36 +00:00
|
|
|
<div class={classNames(displayClass, "toc")}>
|
2023-11-04 19:11:42 +00:00
|
|
|
<button type="button" id="toc" class={fileData.collapseToc ? "collapsed" : ""}>
|
2024-02-05 10:45:36 +00:00
|
|
|
<h3>{i18n(cfg.locale).components.tableOfContents.title}</h3>
|
2023-07-23 00:27:41 +00:00
|
|
|
<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>
|
|
|
|
<div id="toc-content">
|
|
|
|
<ul class="overflow">
|
|
|
|
{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>
|
|
|
|
</div>
|
2023-06-17 19:07:40 +00:00
|
|
|
</div>
|
2023-07-23 00:27:41 +00:00
|
|
|
)
|
2023-06-17 19:07:40 +00:00
|
|
|
}
|
|
|
|
TableOfContents.css = modernStyle
|
|
|
|
TableOfContents.afterDOMLoaded = script
|
2023-06-17 02:41:59 +00:00
|
|
|
|
2024-02-05 10:45:36 +00:00
|
|
|
function LegacyTableOfContents({ fileData, cfg }: QuartzComponentProps) {
|
2023-06-17 19:07:40 +00:00
|
|
|
if (!fileData.toc) {
|
|
|
|
return null
|
2023-06-17 02:41:59 +00:00
|
|
|
}
|
2023-07-23 00:27:41 +00:00
|
|
|
return (
|
2023-11-04 19:11:42 +00:00
|
|
|
<details id="toc" open={!fileData.collapseToc}>
|
2023-07-23 00:27:41 +00:00
|
|
|
<summary>
|
2024-02-05 10:45:36 +00:00
|
|
|
<h3>{i18n(cfg.locale).components.tableOfContents.title}</h3>
|
2023-07-23 00:27:41 +00:00
|
|
|
</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>
|
|
|
|
)
|
2023-06-17 02:41:59 +00:00
|
|
|
}
|
2023-06-17 19:07:40 +00:00
|
|
|
LegacyTableOfContents.css = legacyStyle
|
2023-06-17 02:41:59 +00:00
|
|
|
|
2023-06-17 19:07:40 +00:00
|
|
|
export default ((opts?: Partial<Options>) => {
|
|
|
|
const layout = opts?.layout ?? defaultOptions.layout
|
|
|
|
return layout === "modern" ? TableOfContents : LegacyTableOfContents
|
2023-06-13 05:41:42 +00:00
|
|
|
}) satisfies QuartzComponentConstructor
|