From 965425d54d801c29c65dac7f21f92485be8405f5 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Wed, 10 Jul 2024 00:55:19 +0000
Subject: [PATCH] docs + chore: cleanup custom sort ordering for folder + tag listings, add docs
---
quartz/components/pages/TagContent.tsx | 24 ++++++++++++++++++------
1 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/quartz/components/pages/TagContent.tsx b/quartz/components/pages/TagContent.tsx
index 7598b13..e41ab46 100644
--- a/quartz/components/pages/TagContent.tsx
+++ b/quartz/components/pages/TagContent.tsx
@@ -1,14 +1,24 @@
import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
import style from "../styles/listPage.scss"
-import { PageList } from "../PageList"
+import { PageList, SortFn } from "../PageList"
import { FullSlug, getAllSegmentPrefixes, simplifySlug } from "../../util/path"
import { QuartzPluginData } from "../../plugins/vfile"
import { Root } from "hast"
import { htmlToJsx } from "../../util/jsx"
import { i18n } from "../../i18n"
-export default ((opts?: { sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number }) => {
- const numPages = 10
+interface TagContentOptions {
+ sort?: SortFn
+ numPages: number
+}
+
+const defaultOptions: TagContentOptions = {
+ numPages: 10,
+}
+
+export default ((opts?: Partial<TagContentOptions>) => {
+ const options: TagContentOptions = { ...defaultOptions, ...opts }
+
const TagContent: QuartzComponent = (props: QuartzComponentProps) => {
const { tree, fileData, allFiles, cfg } = props
const slug = fileData.slug
@@ -72,16 +82,18 @@
<div class="page-listing">
<p>
{i18n(cfg.locale).pages.tagContent.itemsUnderTag({ count: pages.length })}
- {pages.length > numPages && (
+ {pages.length > options.numPages && (
<>
{" "}
<span>
- {i18n(cfg.locale).pages.tagContent.showingFirst({ count: numPages })}
+ {i18n(cfg.locale).pages.tagContent.showingFirst({
+ count: options.numPages,
+ })}
</span>
</>
)}
</p>
- <PageList limit={numPages} {...listProps} sort={opts?.sort} />
+ <PageList limit={options.numPages} {...listProps} sort={opts?.sort} />
</div>
</div>
)
--
Gitblit v1.10.0