@glyphjs/types
v0.6.0
Published
Shared TypeScript type definitions for Glyph JS
Maintainers
Readme
@glyphjs/types
Shared TypeScript type definitions for the Glyph JS ecosystem.
Install
pnpm add @glyphjs/typesUsage
import type { GlyphIR, Block, CompilationResult } from '@glyphjs/types';
const doc: GlyphIR = {
version: '0.1',
documentId: 'doc-1',
metadata: { title: 'Hello' },
blocks: [],
references: [],
};What's included
- IR types --
GlyphIR,Block,Reference,CompilationResult, and related interfaces - AST types --
GlyphRoot,GlyphUIBlock,RawReffor the parsed markdown AST - Block data types --
HeadingData,ParagraphData,CodeData,ListData, and more - Patch types --
GlyphPatch,GlyphPatchOperationfor IR diffing/patching - Runtime types --
GlyphRuntime,GlyphTheme,BlockProps,GlyphRuntimeConfig - Plugin types --
GlyphComponentDefinition,GlyphComponentProps
Docs
https://github.com/VledicFranco/glyphjs
