No description
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 22:43:50 +01:00
.changeset chore: version package 2026-11-09 21:41:14 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:25 +01:00
src feat: virtualPageHtmlPlugins hook and file.data.referencedBy (bases-page#11) 2026-11-09 04:32:20 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:50 +02:00
CHANGELOG.md chore: version package 2026-11-09 21:41:14 +00:00
globals.d.ts feat(globals): declare window.quartzStaticUrl and window.quartzPrefetch 2026-11-09 21:43:45 +01:00
LICENSE Initial commit 2026-02-07 20:31:27 +01:00
package-lock.json chore: version package 2026-11-09 21:41:14 +00:00
package.json chore: version package 2026-11-09 21:41:14 +00:00
README.md Initial implementation of @quartz-community/types package 2026-02-07 20:39:05 +01:00
tsconfig.json Consolidate all types into single index.ts with proper exports 2026-02-13 13:18:01 +01:00
tsup.config.ts Initial implementation of @quartz-community/types package 2026-02-07 20:39:05 +01:00

@quartz-community/types

Type definitions for Quartz community plugins. This package provides TypeScript interfaces and types that mirror the internal Quartz types, enabling external plugins to have full type safety without depending on the core Quartz package.

Installation

npm install @quartz-community/types

Usage

import {
  QuartzComponent,
  QuartzComponentProps,
  ExplorerOptions,
} from "@quartz-community/types";

const MyComponent: QuartzComponent = (props: QuartzComponentProps) => {
  // Component implementation
};

MyComponent.css = `
  .my-component { /* styles */ }
`;

MyComponent.afterDOMLoaded = `
  // Client-side script
`;

Included Types

  • Component Types: QuartzComponent, QuartzComponentProps, StringResource
  • Plugin Types: QuartzTransformerPlugin, QuartzFilterPlugin, QuartzEmitterPlugin
  • Data Types: FileTrieNode, ContentIndex, ContentIndexEntry
  • Component Options: ExplorerOptions, GraphOptions, SearchOptions, D3Config
  • Utility Types: HTMLAttributes, EventHandler, CleanupFunction, ClassValue

License

MIT