From 81a4e202362f42a82baa9df2b6b91a774098740b Mon Sep 17 00:00:00 2001
From: Yohann Bacha <github@cyberendroit.net>
Date: Tue, 21 May 2024 16:50:58 +0000
Subject: [PATCH] feat: ability to hide tags in the recent notes component (#1147)
---
quartz/components/RecentNotes.tsx | 28 ++++++++++++++++------------
docs/features/recent notes.md | 1 +
2 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/docs/features/recent notes.md b/docs/features/recent notes.md
index 9236b7c..75406e5 100644
--- a/docs/features/recent notes.md
+++ b/docs/features/recent notes.md
@@ -9,6 +9,7 @@
- Changing the title from "Recent notes": pass in an additional parameter to `Component.RecentNotes({ title: "Recent writing" })`
- Changing the number of recent notes: pass in an additional parameter to `Component.RecentNotes({ limit: 5 })`
+- Display the note's tags (defaults to true): `Component.RecentNotes({ showTags: false })`
- Show a 'see more' link: pass in an additional parameter to `Component.RecentNotes({ linkToMore: "tags/components" })`. This field should be a full slug to a page that exists.
- Customize filtering: pass in an additional parameter to `Component.RecentNotes({ filter: someFilterFunction })`. The filter function should be a function that has the signature `(f: QuartzPluginData) => boolean`.
- Customize sorting: pass in an additional parameter to `Component.RecentNotes({ sort: someSortFunction })`. By default, Quartz will sort by date and then tie break lexographically. The sort function should be a function that has the signature `(f1: QuartzPluginData, f2: QuartzPluginData) => number`. See `byDateAndAlphabetical` in `quartz/components/PageList.tsx` for an example.
diff --git a/quartz/components/RecentNotes.tsx b/quartz/components/RecentNotes.tsx
index d99878d..2c32fea 100644
--- a/quartz/components/RecentNotes.tsx
+++ b/quartz/components/RecentNotes.tsx
@@ -12,6 +12,7 @@
title?: string
limit: number
linkToMore: SimpleSlug | false
+ showTags: boolean
filter: (f: QuartzPluginData) => boolean
sort: (f1: QuartzPluginData, f2: QuartzPluginData) => number
}
@@ -19,6 +20,7 @@
const defaultOptions = (cfg: GlobalConfiguration): Options => ({
limit: 3,
linkToMore: false,
+ showTags: true,
filter: () => true,
sort: byDateAndAlphabetical(cfg),
})
@@ -56,18 +58,20 @@
<Date date={getDate(cfg, page)!} locale={cfg.locale} />
</p>
)}
- <ul class="tags">
- {tags.map((tag) => (
- <li>
- <a
- class="internal tag-link"
- href={resolveRelative(fileData.slug!, `tags/${tag}` as FullSlug)}
- >
- {tag}
- </a>
- </li>
- ))}
- </ul>
+ {opts.showTags && (
+ <ul class="tags">
+ {tags.map((tag) => (
+ <li>
+ <a
+ class="internal tag-link"
+ href={resolveRelative(fileData.slug!, `tags/${tag}` as FullSlug)}
+ >
+ {tag}
+ </a>
+ </li>
+ ))}
+ </ul>
+ )}
</div>
</li>
)
--
Gitblit v1.10.0