From 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 10 Jul 2023 02:32:24 +0000
Subject: [PATCH] docs + various polish
---
quartz/components/types.ts | 10 +++++++++-
1 files changed, 9 insertions(+), 1 deletions(-)
diff --git a/quartz/components/types.ts b/quartz/components/types.ts
index 8d7a79c..b37ccee 100644
--- a/quartz/components/types.ts
+++ b/quartz/components/types.ts
@@ -2,12 +2,18 @@
import { StaticResources } from "../resources"
import { QuartzPluginData } from "../plugins/vfile"
import { GlobalConfiguration } from "../cfg"
+import { Node } from "hast"
export type QuartzComponentProps = {
externalResources: StaticResources
fileData: QuartzPluginData
cfg: GlobalConfiguration
- children: QuartzComponent[] | JSX.Element[]
+ children: (QuartzComponent | JSX.Element)[]
+ tree: Node<QuartzPluginData>
+ allFiles: QuartzPluginData[]
+ displayClass?: 'mobile-only' | 'desktop-only'
+} & JSX.IntrinsicAttributes & {
+ [key: string]: any
}
export type QuartzComponent = ComponentType<QuartzComponentProps> & {
@@ -15,3 +21,5 @@
beforeDOMLoaded?: string,
afterDOMLoaded?: string,
}
+
+export type QuartzComponentConstructor<Options extends object | undefined = undefined> = (opts: Options) => QuartzComponent
--
Gitblit v1.10.0