kompendium
Version:
Documentation generator for Stencil components
425 lines (424 loc) • 14.6 kB
TypeScript
/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
import { PropsFactory } from "./components/playground/playground.types";
import { JsonDocs, JsonDocsComponent, JsonDocsTag } from "./stencil-public-runtime";
import { MatchResults } from "@stencil/router";
import { KompendiumData, MenuItem, TypeDescription } from "./types";
import { ProplistItem } from "./components/proplist/proplist";
export namespace Components {
interface KompendiumApp {
/**
* Factory for creating props for example components
*/
"examplePropsFactory"?: PropsFactory;
/**
* Path to `kompendium.json`
*/
"path": string;
}
interface KompendiumCode {
/**
* The language of the code
*/
"language": string;
}
interface KompendiumComponent {
/**
* The generated documentation data
*/
"docs": JsonDocs;
/**
* Factory for creating props for example components
*/
"examplePropsFactory": PropsFactory;
/**
* Matched route parameters
*/
"match": MatchResults;
/**
* Component schemas
*/
"schemas": Array<Record<string, any>>;
}
interface KompendiumDarkmodeSwitch {
}
interface KompendiumDebug {
/**
* The generated documentation data
*/
"docs": JsonDocs;
/**
* Factory for creating props for example components
* @returns props
*/
"examplePropsFactory"?: PropsFactory;
/**
* Matched route parameters
*/
"match": MatchResults;
/**
* Component schemas
*/
"schemas": Array<Record<string, any>>;
}
interface KompendiumExampleCode {
}
interface KompendiumExampleMarkdown {
}
interface KompendiumGuide {
"data": KompendiumData;
}
interface KompendiumMarkdown {
/**
* The text to render
*/
"text": string;
}
interface KompendiumNavigation {
/**
* Title to display at the top of the navigation
*/
"header": string;
/**
* Index containing searchable documents
*/
"index": any;
/**
* Optional logo to display instead of the header
*/
"logo": string;
/**
* The menu to display
*/
"menu": MenuItem[];
}
interface KompendiumPlayground {
/**
* The component to display
*/
"component": JsonDocsComponent;
/**
* Factory for creating props for example components
* @returns props
*/
"propsFactory"?: PropsFactory;
/**
* Schema for the component
*/
"schema": Record<string, any>;
}
interface KompendiumProplist {
/**
* List of properties
*/
"items": ProplistItem[];
}
interface KompendiumSearch {
/**
* Index containing searchable documents
*/
"index": any;
}
interface KompendiumTaglist {
/**
* Set to `true` if the list should be rendered in compact mode
*/
"compact": boolean;
/**
* List of tags to render
*/
"tags": JsonDocsTag[];
}
interface KompendiumType {
/**
* Matched route parameters
*/
"match": MatchResults;
"types": TypeDescription[];
}
}
declare global {
interface HTMLKompendiumAppElement extends Components.KompendiumApp, HTMLStencilElement {
}
var HTMLKompendiumAppElement: {
prototype: HTMLKompendiumAppElement;
new (): HTMLKompendiumAppElement;
};
interface HTMLKompendiumCodeElement extends Components.KompendiumCode, HTMLStencilElement {
}
var HTMLKompendiumCodeElement: {
prototype: HTMLKompendiumCodeElement;
new (): HTMLKompendiumCodeElement;
};
interface HTMLKompendiumComponentElement extends Components.KompendiumComponent, HTMLStencilElement {
}
var HTMLKompendiumComponentElement: {
prototype: HTMLKompendiumComponentElement;
new (): HTMLKompendiumComponentElement;
};
interface HTMLKompendiumDarkmodeSwitchElement extends Components.KompendiumDarkmodeSwitch, HTMLStencilElement {
}
var HTMLKompendiumDarkmodeSwitchElement: {
prototype: HTMLKompendiumDarkmodeSwitchElement;
new (): HTMLKompendiumDarkmodeSwitchElement;
};
interface HTMLKompendiumDebugElement extends Components.KompendiumDebug, HTMLStencilElement {
}
var HTMLKompendiumDebugElement: {
prototype: HTMLKompendiumDebugElement;
new (): HTMLKompendiumDebugElement;
};
interface HTMLKompendiumExampleCodeElement extends Components.KompendiumExampleCode, HTMLStencilElement {
}
var HTMLKompendiumExampleCodeElement: {
prototype: HTMLKompendiumExampleCodeElement;
new (): HTMLKompendiumExampleCodeElement;
};
interface HTMLKompendiumExampleMarkdownElement extends Components.KompendiumExampleMarkdown, HTMLStencilElement {
}
var HTMLKompendiumExampleMarkdownElement: {
prototype: HTMLKompendiumExampleMarkdownElement;
new (): HTMLKompendiumExampleMarkdownElement;
};
interface HTMLKompendiumGuideElement extends Components.KompendiumGuide, HTMLStencilElement {
}
var HTMLKompendiumGuideElement: {
prototype: HTMLKompendiumGuideElement;
new (): HTMLKompendiumGuideElement;
};
interface HTMLKompendiumMarkdownElement extends Components.KompendiumMarkdown, HTMLStencilElement {
}
var HTMLKompendiumMarkdownElement: {
prototype: HTMLKompendiumMarkdownElement;
new (): HTMLKompendiumMarkdownElement;
};
interface HTMLKompendiumNavigationElement extends Components.KompendiumNavigation, HTMLStencilElement {
}
var HTMLKompendiumNavigationElement: {
prototype: HTMLKompendiumNavigationElement;
new (): HTMLKompendiumNavigationElement;
};
interface HTMLKompendiumPlaygroundElement extends Components.KompendiumPlayground, HTMLStencilElement {
}
var HTMLKompendiumPlaygroundElement: {
prototype: HTMLKompendiumPlaygroundElement;
new (): HTMLKompendiumPlaygroundElement;
};
interface HTMLKompendiumProplistElement extends Components.KompendiumProplist, HTMLStencilElement {
}
var HTMLKompendiumProplistElement: {
prototype: HTMLKompendiumProplistElement;
new (): HTMLKompendiumProplistElement;
};
interface HTMLKompendiumSearchElement extends Components.KompendiumSearch, HTMLStencilElement {
}
var HTMLKompendiumSearchElement: {
prototype: HTMLKompendiumSearchElement;
new (): HTMLKompendiumSearchElement;
};
interface HTMLKompendiumTaglistElement extends Components.KompendiumTaglist, HTMLStencilElement {
}
var HTMLKompendiumTaglistElement: {
prototype: HTMLKompendiumTaglistElement;
new (): HTMLKompendiumTaglistElement;
};
interface HTMLKompendiumTypeElement extends Components.KompendiumType, HTMLStencilElement {
}
var HTMLKompendiumTypeElement: {
prototype: HTMLKompendiumTypeElement;
new (): HTMLKompendiumTypeElement;
};
interface HTMLElementTagNameMap {
"kompendium-app": HTMLKompendiumAppElement;
"kompendium-code": HTMLKompendiumCodeElement;
"kompendium-component": HTMLKompendiumComponentElement;
"kompendium-darkmode-switch": HTMLKompendiumDarkmodeSwitchElement;
"kompendium-debug": HTMLKompendiumDebugElement;
"kompendium-example-code": HTMLKompendiumExampleCodeElement;
"kompendium-example-markdown": HTMLKompendiumExampleMarkdownElement;
"kompendium-guide": HTMLKompendiumGuideElement;
"kompendium-markdown": HTMLKompendiumMarkdownElement;
"kompendium-navigation": HTMLKompendiumNavigationElement;
"kompendium-playground": HTMLKompendiumPlaygroundElement;
"kompendium-proplist": HTMLKompendiumProplistElement;
"kompendium-search": HTMLKompendiumSearchElement;
"kompendium-taglist": HTMLKompendiumTaglistElement;
"kompendium-type": HTMLKompendiumTypeElement;
}
}
declare namespace LocalJSX {
interface KompendiumApp {
/**
* Factory for creating props for example components
*/
"examplePropsFactory"?: PropsFactory;
/**
* Path to `kompendium.json`
*/
"path"?: string;
}
interface KompendiumCode {
/**
* The language of the code
*/
"language"?: string;
}
interface KompendiumComponent {
/**
* The generated documentation data
*/
"docs"?: JsonDocs;
/**
* Factory for creating props for example components
*/
"examplePropsFactory"?: PropsFactory;
/**
* Matched route parameters
*/
"match"?: MatchResults;
/**
* Component schemas
*/
"schemas"?: Array<Record<string, any>>;
}
interface KompendiumDarkmodeSwitch {
}
interface KompendiumDebug {
/**
* The generated documentation data
*/
"docs"?: JsonDocs;
/**
* Factory for creating props for example components
* @returns props
*/
"examplePropsFactory"?: PropsFactory;
/**
* Matched route parameters
*/
"match"?: MatchResults;
/**
* Component schemas
*/
"schemas"?: Array<Record<string, any>>;
}
interface KompendiumExampleCode {
}
interface KompendiumExampleMarkdown {
}
interface KompendiumGuide {
"data"?: KompendiumData;
}
interface KompendiumMarkdown {
/**
* The text to render
*/
"text"?: string;
}
interface KompendiumNavigation {
/**
* Title to display at the top of the navigation
*/
"header"?: string;
/**
* Index containing searchable documents
*/
"index"?: any;
/**
* Optional logo to display instead of the header
*/
"logo"?: string;
/**
* The menu to display
*/
"menu"?: MenuItem[];
}
interface KompendiumPlayground {
/**
* The component to display
*/
"component"?: JsonDocsComponent;
/**
* Factory for creating props for example components
* @returns props
*/
"propsFactory"?: PropsFactory;
/**
* Schema for the component
*/
"schema"?: Record<string, any>;
}
interface KompendiumProplist {
/**
* List of properties
*/
"items"?: ProplistItem[];
}
interface KompendiumSearch {
/**
* Index containing searchable documents
*/
"index"?: any;
}
interface KompendiumTaglist {
/**
* Set to `true` if the list should be rendered in compact mode
*/
"compact"?: boolean;
/**
* List of tags to render
*/
"tags"?: JsonDocsTag[];
}
interface KompendiumType {
/**
* Matched route parameters
*/
"match"?: MatchResults;
"types"?: TypeDescription[];
}
interface IntrinsicElements {
"kompendium-app": KompendiumApp;
"kompendium-code": KompendiumCode;
"kompendium-component": KompendiumComponent;
"kompendium-darkmode-switch": KompendiumDarkmodeSwitch;
"kompendium-debug": KompendiumDebug;
"kompendium-example-code": KompendiumExampleCode;
"kompendium-example-markdown": KompendiumExampleMarkdown;
"kompendium-guide": KompendiumGuide;
"kompendium-markdown": KompendiumMarkdown;
"kompendium-navigation": KompendiumNavigation;
"kompendium-playground": KompendiumPlayground;
"kompendium-proplist": KompendiumProplist;
"kompendium-search": KompendiumSearch;
"kompendium-taglist": KompendiumTaglist;
"kompendium-type": KompendiumType;
}
}
export { LocalJSX as JSX };
declare module "@stencil/core" {
export namespace JSX {
interface IntrinsicElements {
"kompendium-app": LocalJSX.KompendiumApp & JSXBase.HTMLAttributes<HTMLKompendiumAppElement>;
"kompendium-code": LocalJSX.KompendiumCode & JSXBase.HTMLAttributes<HTMLKompendiumCodeElement>;
"kompendium-component": LocalJSX.KompendiumComponent & JSXBase.HTMLAttributes<HTMLKompendiumComponentElement>;
"kompendium-darkmode-switch": LocalJSX.KompendiumDarkmodeSwitch & JSXBase.HTMLAttributes<HTMLKompendiumDarkmodeSwitchElement>;
"kompendium-debug": LocalJSX.KompendiumDebug & JSXBase.HTMLAttributes<HTMLKompendiumDebugElement>;
"kompendium-example-code": LocalJSX.KompendiumExampleCode & JSXBase.HTMLAttributes<HTMLKompendiumExampleCodeElement>;
"kompendium-example-markdown": LocalJSX.KompendiumExampleMarkdown & JSXBase.HTMLAttributes<HTMLKompendiumExampleMarkdownElement>;
"kompendium-guide": LocalJSX.KompendiumGuide & JSXBase.HTMLAttributes<HTMLKompendiumGuideElement>;
"kompendium-markdown": LocalJSX.KompendiumMarkdown & JSXBase.HTMLAttributes<HTMLKompendiumMarkdownElement>;
"kompendium-navigation": LocalJSX.KompendiumNavigation & JSXBase.HTMLAttributes<HTMLKompendiumNavigationElement>;
"kompendium-playground": LocalJSX.KompendiumPlayground & JSXBase.HTMLAttributes<HTMLKompendiumPlaygroundElement>;
"kompendium-proplist": LocalJSX.KompendiumProplist & JSXBase.HTMLAttributes<HTMLKompendiumProplistElement>;
"kompendium-search": LocalJSX.KompendiumSearch & JSXBase.HTMLAttributes<HTMLKompendiumSearchElement>;
"kompendium-taglist": LocalJSX.KompendiumTaglist & JSXBase.HTMLAttributes<HTMLKompendiumTaglistElement>;
"kompendium-type": LocalJSX.KompendiumType & JSXBase.HTMLAttributes<HTMLKompendiumTypeElement>;
}
}
}