/* 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 "@limetech/stencil-router"; import { KompendiumData, MenuItem, TypeDescription } from "./types"; import { ProplistItem } from "./components/proplist/proplist"; import { TocEntry } from "./components/toc/toc.types"; export { PropsFactory } from "./components/playground/playground.types"; export { JsonDocs, JsonDocsComponent, JsonDocsTag } from "./stencil-public-runtime"; export { MatchResults } from "@limetech/stencil-router"; export { KompendiumData, MenuItem, TypeDescription } from "./types"; export { ProplistItem } from "./components/proplist/proplist"; export { TocEntry } from "./components/toc/toc.types"; export namespace Components { /** * Inline paragraph-link (¶) placed next to a heading. Picks up the parent * heading's font-size, stays hidden until the heading is hovered, and * highlights persistently when its slug matches the current URL anchor. * @private */ interface KompendiumAnchor { /** * Human-readable label for the target, used for the aria-label. */ "label": string; /** * Slug used as the URL anchor fragment and scroll target. */ "slug": string; } interface KompendiumApp { /** * Factory for creating props for example components */ "examplePropsFactory"?: PropsFactory; /** * Path to `kompendium.json` * @default '/kompendium.json' */ "path": string; } /** * @exampleComponent kompendium-example-code */ 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>; } /** * @private */ interface KompendiumDarkmodeSwitch { } interface KompendiumDebug { /** * The generated documentation data */ "docs": JsonDocs; /** * Factory for creating props for example components * @returns props * @default () => ({}) */ "examplePropsFactory"?: PropsFactory; /** * Matched route parameters */ "match": MatchResults; /** * Component schemas */ "schemas": Array>; } interface KompendiumExampleCode { } /** * Inline `@link` references * Demonstrates how inline `{@link Target }` references in markdown are * turned into clickable links. * @sourceFile inline-links-example.ts */ interface KompendiumExampleInlineLinks { } /** * This is a simple example of how the `kompendium-markdown` component is used * @sourceFile markdown-example.ts */ interface KompendiumExampleMarkdown { } interface KompendiumGuide { "data": KompendiumData; } /** * This component renders markdown * @exampleComponent kompendium-example-markdown * @exampleComponent kompendium-example-inline-links */ interface KompendiumMarkdown { /** * The text to render */ "text": string; } /** * @private */ 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 { /** * Slug used as the URL anchor for linking to this example. */ "anchorSlug"?: string; /** * The component to display */ "component": JsonDocsComponent; /** * Factory for creating props for example components * @returns props * @default () => ({}) */ "propsFactory"?: PropsFactory; /** * Schema for the component */ "schema": Record; } interface KompendiumProplist { /** * List of properties */ "items": ProplistItem[]; } interface KompendiumSearch { /** * Index containing searchable documents */ "index": any; } /** * asd */ interface KompendiumTaglist { /** * Set to `true` if the list should be rendered in compact mode * @default false */ "compact": boolean; /** * List of tags to render */ "tags": JsonDocsTag[]; } /** * Floating table-of-contents menu. Clicking the button reveals an overlay * listing the entries. Selecting an entry updates the URL hash with a slug * anchor (e.g. `#/component/my-component#basic-example`) so the page can * scroll to the target and the location can be shared. * @private */ interface KompendiumToc { /** * Entries to show in the menu. A flat or nested list of links. * @default [] */ "entries": TocEntry[]; } interface KompendiumType { /** * Matched route parameters */ "match": MatchResults; "types": TypeDescription[]; } } declare global { /** * Inline paragraph-link (¶) placed next to a heading. Picks up the parent * heading's font-size, stays hidden until the heading is hovered, and * highlights persistently when its slug matches the current URL anchor. * @private */ interface HTMLKompendiumAnchorElement extends Components.KompendiumAnchor, HTMLStencilElement { } var HTMLKompendiumAnchorElement: { prototype: HTMLKompendiumAnchorElement; new (): HTMLKompendiumAnchorElement; }; interface HTMLKompendiumAppElement extends Components.KompendiumApp, HTMLStencilElement { } var HTMLKompendiumAppElement: { prototype: HTMLKompendiumAppElement; new (): HTMLKompendiumAppElement; }; /** * @exampleComponent kompendium-example-code */ interface HTMLKompendiumCodeElement extends Components.KompendiumCode, HTMLStencilElement { } var HTMLKompendiumCodeElement: { prototype: HTMLKompendiumCodeElement; new (): HTMLKompendiumCodeElement; }; interface HTMLKompendiumComponentElement extends Components.KompendiumComponent, HTMLStencilElement { } var HTMLKompendiumComponentElement: { prototype: HTMLKompendiumComponentElement; new (): HTMLKompendiumComponentElement; }; /** * @private */ 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; }; /** * Inline `@link` references * Demonstrates how inline `{@link Target }` references in markdown are * turned into clickable links. * @sourceFile inline-links-example.ts */ interface HTMLKompendiumExampleInlineLinksElement extends Components.KompendiumExampleInlineLinks, HTMLStencilElement { } var HTMLKompendiumExampleInlineLinksElement: { prototype: HTMLKompendiumExampleInlineLinksElement; new (): HTMLKompendiumExampleInlineLinksElement; }; /** * This is a simple example of how the `kompendium-markdown` component is used * @sourceFile markdown-example.ts */ interface HTMLKompendiumExampleMarkdownElement extends Components.KompendiumExampleMarkdown, HTMLStencilElement { } var HTMLKompendiumExampleMarkdownElement: { prototype: HTMLKompendiumExampleMarkdownElement; new (): HTMLKompendiumExampleMarkdownElement; }; interface HTMLKompendiumGuideElement extends Components.KompendiumGuide, HTMLStencilElement { } var HTMLKompendiumGuideElement: { prototype: HTMLKompendiumGuideElement; new (): HTMLKompendiumGuideElement; }; /** * This component renders markdown * @exampleComponent kompendium-example-markdown * @exampleComponent kompendium-example-inline-links */ interface HTMLKompendiumMarkdownElement extends Components.KompendiumMarkdown, HTMLStencilElement { } var HTMLKompendiumMarkdownElement: { prototype: HTMLKompendiumMarkdownElement; new (): HTMLKompendiumMarkdownElement; }; /** * @private */ 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; }; /** * asd */ interface HTMLKompendiumTaglistElement extends Components.KompendiumTaglist, HTMLStencilElement { } var HTMLKompendiumTaglistElement: { prototype: HTMLKompendiumTaglistElement; new (): HTMLKompendiumTaglistElement; }; /** * Floating table-of-contents menu. Clicking the button reveals an overlay * listing the entries. Selecting an entry updates the URL hash with a slug * anchor (e.g. `#/component/my-component#basic-example`) so the page can * scroll to the target and the location can be shared. * @private */ interface HTMLKompendiumTocElement extends Components.KompendiumToc, HTMLStencilElement { } var HTMLKompendiumTocElement: { prototype: HTMLKompendiumTocElement; new (): HTMLKompendiumTocElement; }; interface HTMLKompendiumTypeElement extends Components.KompendiumType, HTMLStencilElement { } var HTMLKompendiumTypeElement: { prototype: HTMLKompendiumTypeElement; new (): HTMLKompendiumTypeElement; }; interface HTMLElementTagNameMap { "kompendium-anchor": HTMLKompendiumAnchorElement; "kompendium-app": HTMLKompendiumAppElement; "kompendium-code": HTMLKompendiumCodeElement; "kompendium-component": HTMLKompendiumComponentElement; "kompendium-darkmode-switch": HTMLKompendiumDarkmodeSwitchElement; "kompendium-debug": HTMLKompendiumDebugElement; "kompendium-example-code": HTMLKompendiumExampleCodeElement; "kompendium-example-inline-links": HTMLKompendiumExampleInlineLinksElement; "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-toc": HTMLKompendiumTocElement; "kompendium-type": HTMLKompendiumTypeElement; } } declare namespace LocalJSX { /** * Inline paragraph-link (¶) placed next to a heading. Picks up the parent * heading's font-size, stays hidden until the heading is hovered, and * highlights persistently when its slug matches the current URL anchor. * @private */ interface KompendiumAnchor { /** * Human-readable label for the target, used for the aria-label. */ "label"?: string; /** * Slug used as the URL anchor fragment and scroll target. */ "slug"?: string; } interface KompendiumApp { /** * Factory for creating props for example components */ "examplePropsFactory"?: PropsFactory; /** * Path to `kompendium.json` * @default '/kompendium.json' */ "path"?: string; } /** * @exampleComponent kompendium-example-code */ 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>; } /** * @private */ interface KompendiumDarkmodeSwitch { } interface KompendiumDebug { /** * The generated documentation data */ "docs"?: JsonDocs; /** * Factory for creating props for example components * @returns props * @default () => ({}) */ "examplePropsFactory"?: PropsFactory; /** * Matched route parameters */ "match"?: MatchResults; /** * Component schemas */ "schemas"?: Array>; } interface KompendiumExampleCode { } /** * Inline `@link` references * Demonstrates how inline `{@link Target }` references in markdown are * turned into clickable links. * @sourceFile inline-links-example.ts */ interface KompendiumExampleInlineLinks { } /** * This is a simple example of how the `kompendium-markdown` component is used * @sourceFile markdown-example.ts */ interface KompendiumExampleMarkdown { } interface KompendiumGuide { "data"?: KompendiumData; } /** * This component renders markdown * @exampleComponent kompendium-example-markdown * @exampleComponent kompendium-example-inline-links */ interface KompendiumMarkdown { /** * The text to render */ "text"?: string; } /** * @private */ 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 { /** * Slug used as the URL anchor for linking to this example. */ "anchorSlug"?: string; /** * The component to display */ "component"?: JsonDocsComponent; /** * Factory for creating props for example components * @returns props * @default () => ({}) */ "propsFactory"?: PropsFactory; /** * Schema for the component */ "schema"?: Record; } interface KompendiumProplist { /** * List of properties */ "items"?: ProplistItem[]; } interface KompendiumSearch { /** * Index containing searchable documents */ "index"?: any; } /** * asd */ interface KompendiumTaglist { /** * Set to `true` if the list should be rendered in compact mode * @default false */ "compact"?: boolean; /** * List of tags to render */ "tags"?: JsonDocsTag[]; } /** * Floating table-of-contents menu. Clicking the button reveals an overlay * listing the entries. Selecting an entry updates the URL hash with a slug * anchor (e.g. `#/component/my-component#basic-example`) so the page can * scroll to the target and the location can be shared. * @private */ interface KompendiumToc { /** * Entries to show in the menu. A flat or nested list of links. * @default [] */ "entries"?: TocEntry[]; } interface KompendiumType { /** * Matched route parameters */ "match"?: MatchResults; "types"?: TypeDescription[]; } interface KompendiumAnchorAttributes { "slug": string; "label": string; } interface KompendiumAppAttributes { "path": string; } interface KompendiumCodeAttributes { "language": string; } interface KompendiumMarkdownAttributes { "text": string; } interface KompendiumNavigationAttributes { "header": string; "logo": string; "index": string; } interface KompendiumPlaygroundAttributes { "anchorSlug": string; } interface KompendiumSearchAttributes { "index": string; } interface KompendiumTaglistAttributes { "compact": boolean; } interface IntrinsicElements { "kompendium-anchor": Omit & { [K in keyof KompendiumAnchor & keyof KompendiumAnchorAttributes]?: KompendiumAnchor[K] } & { [K in keyof KompendiumAnchor & keyof KompendiumAnchorAttributes as `attr:${K}`]?: KompendiumAnchorAttributes[K] } & { [K in keyof KompendiumAnchor & keyof KompendiumAnchorAttributes as `prop:${K}`]?: KompendiumAnchor[K] }; "kompendium-app": Omit & { [K in keyof KompendiumApp & keyof KompendiumAppAttributes]?: KompendiumApp[K] } & { [K in keyof KompendiumApp & keyof KompendiumAppAttributes as `attr:${K}`]?: KompendiumAppAttributes[K] } & { [K in keyof KompendiumApp & keyof KompendiumAppAttributes as `prop:${K}`]?: KompendiumApp[K] }; "kompendium-code": Omit & { [K in keyof KompendiumCode & keyof KompendiumCodeAttributes]?: KompendiumCode[K] } & { [K in keyof KompendiumCode & keyof KompendiumCodeAttributes as `attr:${K}`]?: KompendiumCodeAttributes[K] } & { [K in keyof KompendiumCode & keyof KompendiumCodeAttributes as `prop:${K}`]?: KompendiumCode[K] }; "kompendium-component": KompendiumComponent; "kompendium-darkmode-switch": KompendiumDarkmodeSwitch; "kompendium-debug": KompendiumDebug; "kompendium-example-code": KompendiumExampleCode; "kompendium-example-inline-links": KompendiumExampleInlineLinks; "kompendium-example-markdown": KompendiumExampleMarkdown; "kompendium-guide": KompendiumGuide; "kompendium-markdown": Omit & { [K in keyof KompendiumMarkdown & keyof KompendiumMarkdownAttributes]?: KompendiumMarkdown[K] } & { [K in keyof KompendiumMarkdown & keyof KompendiumMarkdownAttributes as `attr:${K}`]?: KompendiumMarkdownAttributes[K] } & { [K in keyof KompendiumMarkdown & keyof KompendiumMarkdownAttributes as `prop:${K}`]?: KompendiumMarkdown[K] }; "kompendium-navigation": Omit & { [K in keyof KompendiumNavigation & keyof KompendiumNavigationAttributes]?: KompendiumNavigation[K] } & { [K in keyof KompendiumNavigation & keyof KompendiumNavigationAttributes as `attr:${K}`]?: KompendiumNavigationAttributes[K] } & { [K in keyof KompendiumNavigation & keyof KompendiumNavigationAttributes as `prop:${K}`]?: KompendiumNavigation[K] }; "kompendium-playground": Omit & { [K in keyof KompendiumPlayground & keyof KompendiumPlaygroundAttributes]?: KompendiumPlayground[K] } & { [K in keyof KompendiumPlayground & keyof KompendiumPlaygroundAttributes as `attr:${K}`]?: KompendiumPlaygroundAttributes[K] } & { [K in keyof KompendiumPlayground & keyof KompendiumPlaygroundAttributes as `prop:${K}`]?: KompendiumPlayground[K] }; "kompendium-proplist": KompendiumProplist; "kompendium-search": Omit & { [K in keyof KompendiumSearch & keyof KompendiumSearchAttributes]?: KompendiumSearch[K] } & { [K in keyof KompendiumSearch & keyof KompendiumSearchAttributes as `attr:${K}`]?: KompendiumSearchAttributes[K] } & { [K in keyof KompendiumSearch & keyof KompendiumSearchAttributes as `prop:${K}`]?: KompendiumSearch[K] }; "kompendium-taglist": Omit & { [K in keyof KompendiumTaglist & keyof KompendiumTaglistAttributes]?: KompendiumTaglist[K] } & { [K in keyof KompendiumTaglist & keyof KompendiumTaglistAttributes as `attr:${K}`]?: KompendiumTaglistAttributes[K] } & { [K in keyof KompendiumTaglist & keyof KompendiumTaglistAttributes as `prop:${K}`]?: KompendiumTaglist[K] }; "kompendium-toc": KompendiumToc; "kompendium-type": KompendiumType; } } export { LocalJSX as JSX }; declare module "@stencil/core" { export namespace JSX { interface IntrinsicElements { /** * Inline paragraph-link (¶) placed next to a heading. Picks up the parent * heading's font-size, stays hidden until the heading is hovered, and * highlights persistently when its slug matches the current URL anchor. * @private */ "kompendium-anchor": LocalJSX.IntrinsicElements["kompendium-anchor"] & JSXBase.HTMLAttributes; "kompendium-app": LocalJSX.IntrinsicElements["kompendium-app"] & JSXBase.HTMLAttributes; /** * @exampleComponent kompendium-example-code */ "kompendium-code": LocalJSX.IntrinsicElements["kompendium-code"] & JSXBase.HTMLAttributes; "kompendium-component": LocalJSX.IntrinsicElements["kompendium-component"] & JSXBase.HTMLAttributes; /** * @private */ "kompendium-darkmode-switch": LocalJSX.IntrinsicElements["kompendium-darkmode-switch"] & JSXBase.HTMLAttributes; "kompendium-debug": LocalJSX.IntrinsicElements["kompendium-debug"] & JSXBase.HTMLAttributes; "kompendium-example-code": LocalJSX.IntrinsicElements["kompendium-example-code"] & JSXBase.HTMLAttributes; /** * Inline `@link` references * Demonstrates how inline `{@link Target }` references in markdown are * turned into clickable links. * @sourceFile inline-links-example.ts */ "kompendium-example-inline-links": LocalJSX.IntrinsicElements["kompendium-example-inline-links"] & JSXBase.HTMLAttributes; /** * This is a simple example of how the `kompendium-markdown` component is used * @sourceFile markdown-example.ts */ "kompendium-example-markdown": LocalJSX.IntrinsicElements["kompendium-example-markdown"] & JSXBase.HTMLAttributes; "kompendium-guide": LocalJSX.IntrinsicElements["kompendium-guide"] & JSXBase.HTMLAttributes; /** * This component renders markdown * @exampleComponent kompendium-example-markdown * @exampleComponent kompendium-example-inline-links */ "kompendium-markdown": LocalJSX.IntrinsicElements["kompendium-markdown"] & JSXBase.HTMLAttributes; /** * @private */ "kompendium-navigation": LocalJSX.IntrinsicElements["kompendium-navigation"] & JSXBase.HTMLAttributes; "kompendium-playground": LocalJSX.IntrinsicElements["kompendium-playground"] & JSXBase.HTMLAttributes; "kompendium-proplist": LocalJSX.IntrinsicElements["kompendium-proplist"] & JSXBase.HTMLAttributes; "kompendium-search": LocalJSX.IntrinsicElements["kompendium-search"] & JSXBase.HTMLAttributes; /** * asd */ "kompendium-taglist": LocalJSX.IntrinsicElements["kompendium-taglist"] & JSXBase.HTMLAttributes; /** * Floating table-of-contents menu. Clicking the button reveals an overlay * listing the entries. Selecting an entry updates the URL hash with a slug * anchor (e.g. `#/component/my-component#basic-example`) so the page can * scroll to the target and the location can be shared. * @private */ "kompendium-toc": LocalJSX.IntrinsicElements["kompendium-toc"] & JSXBase.HTMLAttributes; "kompendium-type": LocalJSX.IntrinsicElements["kompendium-type"] & JSXBase.HTMLAttributes; } } }