roadmap/quartz/components/types.ts

28 lines
838 B
TypeScript
Raw Normal View History

2023-06-08 05:27:32 +00:00
import { ComponentType, JSX } from "preact"
2023-08-17 05:09:11 +00:00
import { StaticResources } from "../util/resources"
2023-06-08 05:27:32 +00:00
import { QuartzPluginData } from "../plugins/vfile"
import { GlobalConfiguration } from "../cfg"
2023-06-10 06:06:02 +00:00
import { Node } from "hast"
2023-06-03 19:07:19 +00:00
2023-06-08 05:27:32 +00:00
export type QuartzComponentProps = {
externalResources: StaticResources
fileData: QuartzPluginData
cfg: GlobalConfiguration
2023-07-02 20:08:29 +00:00
children: (QuartzComponent | JSX.Element)[]
2023-06-10 06:06:02 +00:00
tree: Node<QuartzPluginData>
2023-06-20 03:37:45 +00:00
allFiles: QuartzPluginData[]
2023-07-23 00:27:41 +00:00
displayClass?: "mobile-only" | "desktop-only"
} & JSX.IntrinsicAttributes & {
2023-07-23 00:27:41 +00:00
[key: string]: any
}
2023-06-08 05:27:32 +00:00
export type QuartzComponent = ComponentType<QuartzComponentProps> & {
2023-07-23 00:27:41 +00:00
css?: string
beforeDOMLoaded?: string
afterDOMLoaded?: string
2023-06-03 19:07:19 +00:00
}
2023-07-23 00:27:41 +00:00
export type QuartzComponentConstructor<Options extends object | undefined = undefined> = (
opts: Options,
) => QuartzComponent