mirror of
https://github.com/alrayyes/wiki.git
synced 2024-11-25 04:56:23 +00:00
81a4e20236
* feat: ability to hide tags in the recent notes component * docs: recent notes custom parameters in a table * docs: revert recent notes doc to bullet points * fix: linter issues * Update docs/features/recent notes.md --------- Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
93 lines
3.1 KiB
TypeScript
93 lines
3.1 KiB
TypeScript
import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
|
|
import { FullSlug, SimpleSlug, resolveRelative } from "../util/path"
|
|
import { QuartzPluginData } from "../plugins/vfile"
|
|
import { byDateAndAlphabetical } from "./PageList"
|
|
import style from "./styles/recentNotes.scss"
|
|
import { Date, getDate } from "./Date"
|
|
import { GlobalConfiguration } from "../cfg"
|
|
import { i18n } from "../i18n"
|
|
import { classNames } from "../util/lang"
|
|
|
|
interface Options {
|
|
title?: string
|
|
limit: number
|
|
linkToMore: SimpleSlug | false
|
|
showTags: boolean
|
|
filter: (f: QuartzPluginData) => boolean
|
|
sort: (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
|
}
|
|
|
|
const defaultOptions = (cfg: GlobalConfiguration): Options => ({
|
|
limit: 3,
|
|
linkToMore: false,
|
|
showTags: true,
|
|
filter: () => true,
|
|
sort: byDateAndAlphabetical(cfg),
|
|
})
|
|
|
|
export default ((userOpts?: Partial<Options>) => {
|
|
const RecentNotes: QuartzComponent = ({
|
|
allFiles,
|
|
fileData,
|
|
displayClass,
|
|
cfg,
|
|
}: QuartzComponentProps) => {
|
|
const opts = { ...defaultOptions(cfg), ...userOpts }
|
|
const pages = allFiles.filter(opts.filter).sort(opts.sort)
|
|
const remaining = Math.max(0, pages.length - opts.limit)
|
|
return (
|
|
<div class={classNames(displayClass, "recent-notes")}>
|
|
<h3>{opts.title ?? i18n(cfg.locale).components.recentNotes.title}</h3>
|
|
<ul class="recent-ul">
|
|
{pages.slice(0, opts.limit).map((page) => {
|
|
const title = page.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title
|
|
const tags = page.frontmatter?.tags ?? []
|
|
|
|
return (
|
|
<li class="recent-li">
|
|
<div class="section">
|
|
<div class="desc">
|
|
<h3>
|
|
<a href={resolveRelative(fileData.slug!, page.slug!)} class="internal">
|
|
{title}
|
|
</a>
|
|
</h3>
|
|
</div>
|
|
{page.dates && (
|
|
<p class="meta">
|
|
<Date date={getDate(cfg, page)!} locale={cfg.locale} />
|
|
</p>
|
|
)}
|
|
{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>
|
|
)
|
|
})}
|
|
</ul>
|
|
{opts.linkToMore && remaining > 0 && (
|
|
<p>
|
|
<a href={resolveRelative(fileData.slug!, opts.linkToMore)}>
|
|
{i18n(cfg.locale).components.recentNotes.seeRemainingMore({ remaining })}
|
|
</a>
|
|
</p>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|
|
|
|
RecentNotes.css = style
|
|
return RecentNotes
|
|
}) satisfies QuartzComponentConstructor
|