@limetech/kompendium 1.1.1

package/dist/types/components/app/app.d.ts

@@ -0,0 +1,22 @@
+import { KompendiumData } from '../../types';
+import { PropsFactory } from '../playground/playground.types';
+export declare class App {
+    /**
+     * Path to `kompendium.json`
+     */
+    path: string;
+    /**
+     * Factory for creating props for example components
+     */
+    examplePropsFactory?: PropsFactory;
+    data: KompendiumData;
+    private index;
+    private socket;
+    constructor();
+    protected componentWillLoad(): void;
+    protected watchData(): void;
+    private createWebSocket;
+    private onMessage;
+    private fetchData;
+    protected render(): HTMLElement;
+}

package/dist/types/components/code/code.d.ts

@@ -0,0 +1,26 @@
+import 'prismjs/components/prism-jsx.js';
+import 'prismjs/components/prism-scss.js';
+import 'prismjs/components/prism-less.js';
+import 'prismjs/components/prism-tsx.js';
+import 'prismjs/components/prism-typescript.js';
+import 'prismjs/plugins/toolbar/prism-toolbar.js';
+import 'prismjs/plugins/copy-to-clipboard/prism-copy-to-clipboard.js';
+/**
+ * @exampleComponent kompendium-example-code
+ */
+export declare class Code {
+    /**
+     * The language of the code
+     */
+    language: string;
+    /**
+     * Source code
+     */
+    code: string;
+    private host;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    componentDidRender(): void;
+    render(): HTMLElement;
+    private findCode;
+}

package/dist/types/components/code/examples/code.d.ts

@@ -0,0 +1,3 @@
+export declare class CodeExample {
+    render(): HTMLElement;
+}

package/dist/types/components/component/component.d.ts

@@ -0,0 +1,32 @@
+import { JsonDocs } from '../../stencil-public-runtime';
+import { MatchResults } from '@limetech/stencil-router';
+import { PropsFactory } from '../playground/playground.types';
+export declare class KompendiumComponent {
+    /**
+     * The generated documentation data
+     */
+    docs: JsonDocs;
+    /**
+     * Component schemas
+     */
+    schemas: Array<Record<string, any>>;
+    /**
+     * Matched route parameters
+     */
+    match: MatchResults;
+    /**
+     * Factory for creating props for example components
+     */
+    examplePropsFactory: PropsFactory;
+    private host;
+    private scrollToOnNextUpdate;
+    constructor();
+    protected connectedCallback(): void;
+    protected disconnectedCallback(): void;
+    protected componentDidLoad(): void;
+    protected componentDidUpdate(): void;
+    private handleRouteChange;
+    render(): HTMLElement;
+    private renderDocs;
+    private getId;
+}

package/dist/types/components/component/templates/events.d.ts

@@ -0,0 +1,5 @@
+import { JsonDocsEvent } from '../../../stencil-public-runtime';
+export declare function EventList({ events, id, }: {
+    id: string;
+    events: JsonDocsEvent[];
+}): HTMLElement[];

package/dist/types/components/component/templates/examples.d.ts

@@ -0,0 +1,9 @@
+import { JsonDocsComponent, JsonDocsTag } from '../../../stencil-public-runtime';
+import { PropsFactory } from '../../playground/playground.types';
+export declare function ExampleList({ examples, id, schema, propsFactory, }: {
+    id: string;
+    examples: JsonDocsComponent[];
+    schema: Record<string, any>;
+    propsFactory?: PropsFactory;
+}): HTMLElement[];
+export declare const isExampleTag: (name: string) => (tag: JsonDocsTag) => boolean;

package/dist/types/components/component/templates/methods.d.ts

@@ -0,0 +1,5 @@
+import { JsonDocsMethod } from '../../../stencil-public-runtime';
+export declare function MethodList({ methods, id, }: {
+    id?: string;
+    methods: Array<Partial<JsonDocsMethod>>;
+}): HTMLElement[];

package/dist/types/components/component/templates/props.d.ts

@@ -0,0 +1,5 @@
+import { JsonDocsProp } from '../../../stencil-public-runtime';
+export declare function PropertyList({ props, id, }: {
+    id?: string;
+    props: Array<Partial<JsonDocsProp>>;
+}): HTMLElement[];

package/dist/types/components/component/templates/slots.d.ts

@@ -0,0 +1,5 @@
+import { JsonDocsSlot } from '../../../stencil-public-runtime';
+export declare function SlotList({ slots, id, }: {
+    id: string;
+    slots: JsonDocsSlot[];
+}): HTMLElement[];

package/dist/types/components/component/templates/style.d.ts

@@ -0,0 +1,5 @@
+import { JsonDocsStyle } from '../../../stencil-public-runtime';
+export declare function StyleList({ styles, id, }: {
+    id: string;
+    styles: JsonDocsStyle[];
+}): HTMLElement[];

package/dist/types/components/darkmode-switch/darkmode-switch.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @private
+ */
+export declare class DarkmodeSwitch {
+    private theme;
+    private systemSettingIsDark;
+    private checkbox;
+    private colorSchemeMediaQuery;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    componentWillLoad(): void;
+    render(): HTMLElement;
+    private getSelectRef;
+    private handleSystemThemeChange;
+    private handleThemeChange;
+    private setTheme;
+}

package/dist/types/components/darkmode-switch/types.d.ts

@@ -0,0 +1,2 @@
+export type Theme = 'system-default' | 'force-light' | 'force-dark';
+export declare const THEME_EVENT_NAME = "kompendiumTheme";

package/dist/types/components/debug/debug.d.ts

@@ -0,0 +1,24 @@
+import { JsonDocs } from '../../stencil-public-runtime';
+import { MatchResults } from '@limetech/stencil-router';
+import { PropsFactory } from '../playground/playground.types';
+export declare class KompendiumDebug {
+    /**
+     * The generated documentation data
+     */
+    docs: JsonDocs;
+    /**
+     * Component schemas
+     */
+    schemas: Array<Record<string, any>>;
+    /**
+     * Matched route parameters
+     */
+    match: MatchResults;
+    /**
+     * Factory for creating props for example components
+     * @returns {Record<string, unknown>} props
+     */
+    examplePropsFactory?: PropsFactory;
+    render(): HTMLElement;
+    private renderComponent;
+}

package/dist/types/components/guide/guide.d.ts

@@ -0,0 +1,14 @@
+import { KompendiumData } from '../../types';
+export declare class Guide {
+    /**
+     */
+    data: KompendiumData;
+    route: string;
+    private text;
+    constructor();
+    protected connectedCallback(): void;
+    protected disconnectedCallback(): void;
+    private setRoute;
+    render(): HTMLElement;
+    private findGuide;
+}

package/dist/types/components/markdown/examples/markdown-example.d.ts

@@ -0,0 +1 @@
+export declare const markdownExample = "\n## Headings\n\nThe following HTML `<h1>`\u2014`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.\n\n# H1\n## H2\n### H3\n#### H4\n##### H5\n###### H6\n\n## Paragraph\n\nXerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.\n\nItatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.\n\n## Blockquotes\n\nThe blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.\n\n#### Blockquote without attribution\n\n> Tiam, ad mint andaepu dandae nostion secatur sequo quae.\n> **Note** that you can use *Markdown syntax* within a blockquote.\n\n#### Blockquote with attribution\n\n> Don't communicate by sharing memory, share memory by communicating.</p>\n> \u2014 <cite>Rob Pike[^1]</cite>\n\n\n[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.\n\n## Tables\n\nTables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.\n\n   | Name  | Age |\n   | ----- | --- |\n   | Bob   | 27  |\n   | Alice | 23  |\n\n#### Inline Markdown within tables\n\n| Inline&nbsp;&nbsp;&nbsp; | Markdown&nbsp;&nbsp;&nbsp; | In&nbsp;&nbsp;&nbsp;                | Table  |\n| ------------------------ | -------------------------- | ----------------------------------- | ------ |\n| *italics*                | **bold**                   | ~~strikethrough~~&nbsp;&nbsp;&nbsp; | `code` |\n\n## Code Blocks\n\n#### Code block with backticks\n\n```\nhtml\n<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n  <meta charset=\"UTF-8\">\n  <title>Example HTML5 Document</title>\n</head>\n<body>\n  <p>Test</p>\n</body>\n</html>\n```\n\n#### Code block indented with four spaces\n\n    <!DOCTYPE html>\n    <html lang=\"en\">\n    <head>\n      <meta charset=\"UTF-8\">\n      <title>Example HTML5 Document</title>\n    </head>\n    <body>\n      <p>Test</p>\n    </body>\n    </html>\n\n## List Types\n\n#### Ordered List\n\n1. First item\n2. Second item\n3. Third item\n\n#### Unordered List\n\n* List item\n* Another item\n* And another item\n\n#### Nested list\n\n* Fruit\n  * Apple\n  * Orange\n  * Banana\n* Dairy\n  * Milk\n  * Cheese\n\n## Other Elements \u2014 abbr, sub, sup, kbd, mark\n\n<abbr title=\"Graphics Interchange Format\">GIF</abbr> is a bitmap image format.\n\nH<sub>2</sub>O\n\nX<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>\n\nPress <kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd> to end the session.\n\nMost <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.\n\n## Emoji Rendering\n\n<p><span class=\"nowrap\"><span class=\"emojify\">\uD83D\uDE48</span> <code>:see_no_evil:</code></span>  <span class=\"nowrap\"><span class=\"emojify\">\uD83D\uDE49</span> <code>:hear_no_evil:</code></span>  <span class=\"nowrap\"><span class=\"emojify\">\uD83D\uDE4A</span> <code>:speak_no_evil:</code></span></p>\n<br>\n\n## Callout Rendering\n\n:::note\nSome important note.\n:::\n\n:::tip\nA very useful tip!\n:::\n\n:::warning\nJust be careful.\n:::\n\n:::danger\nThis is too risky.\n:::\n\n:::important\nThis is vey important!\n:::\n\n:::info\nJust for your information\u2026\n:::\n\n";

package/dist/types/components/markdown/examples/markdown.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This is a simple example of how the `kompendium-markdown` component is used
+ * @sourceFile markdown-example.ts
+ */
+export declare class MarkdownExample {
+    render(): HTMLElement;
+}

package/dist/types/components/markdown/markdown-types.d.ts

@@ -0,0 +1,2 @@
+export declare function getTypes(): string[];
+export declare function setTypes(newTypes: string[]): void;

package/dist/types/components/markdown/markdown.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This component renders markdown
+ * @exampleComponent kompendium-example-markdown
+ */
+export declare class Markdown {
+    private renderSeq;
+    /**
+     * The text to render
+     */
+    text: string;
+    private host;
+    constructor();
+    protected connectedCallback(): void;
+    protected disconnectedCallback(): void;
+    protected componentDidLoad(): void;
+    protected componentDidUpdate(): void;
+    private handleHashChange;
+    private renderMarkdown;
+    render(): HTMLElement;
+}

package/dist/types/components/navigation/navigation.d.ts

@@ -0,0 +1,35 @@
+import { MenuItem } from '../../types';
+/**
+ * @private
+ */
+export declare class Navigation {
+    /**
+     * The menu to display
+     */
+    menu: MenuItem[];
+    /**
+     * Title to display at the top of the navigation
+     */
+    header: string;
+    /**
+     * Optional logo to display instead of the header
+     */
+    logo: string;
+    /**
+     * Index containing searchable documents
+     */
+    index: any;
+    private route;
+    private displayNavPanel;
+    constructor();
+    protected connectedCallback(): void;
+    protected disconnectedCallback(): void;
+    private setRoute;
+    render(): HTMLElement[];
+    private renderHeader;
+    private toggleMenu;
+    private renderChapters;
+    private renderMenuItem;
+    private isRouteActive;
+    private stopPropagationOfNavClick;
+}

package/dist/types/components/playground/playground.d.ts

@@ -0,0 +1,32 @@
+import { JsonDocsComponent } from '../../stencil-public-runtime';
+import { PropsFactory } from './playground.types';
+export declare class Playground {
+    /**
+     * The component to display
+     */
+    component: JsonDocsComponent;
+    /**
+     * Schema for the component
+     */
+    schema: Record<string, any>;
+    /**
+     * Factory for creating props for example components
+     * @returns {Record<string, unknown>} props
+     */
+    propsFactory?: PropsFactory;
+    private activeTab;
+    private theme;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): HTMLElement;
+    private renderTabs;
+    private renderTab;
+    private renderItems;
+    private renderResult;
+    private renderItem;
+    private renderDebugButton;
+    private activateTab;
+    private isTabActive;
+    private themeListener;
+}

package/dist/types/components/playground/playground.types.d.ts

@@ -0,0 +1 @@
+export type PropsFactory = (name: string) => Record<string, unknown>;

package/dist/types/components/proplist/proplist.d.ts

@@ -0,0 +1,12 @@
+export interface ProplistItem {
+    key: string;
+    value: string;
+}
+export declare class Proplist {
+    /**
+     * List of properties
+     */
+    items: ProplistItem[];
+    render(): HTMLElement;
+    private renderProperty;
+}

package/dist/types/components/search/search.d.ts

@@ -0,0 +1,15 @@
+export declare class Search {
+    /**
+     * Index containing searchable documents
+     */
+    index: any;
+    private documents;
+    private host;
+    constructor();
+    componentDidLoad(): void;
+    render(): HTMLElement;
+    private renderDocument;
+    private handleChangeInput;
+    private search;
+    private handleLinkClick;
+}

package/dist/types/components/taglist/taglist.d.ts

@@ -0,0 +1,16 @@
+import { JsonDocsTag } from '../../stencil-public-runtime';
+/**
+ * asd
+ */
+export declare class Taglist {
+    /**
+     * List of tags to render
+     */
+    tags: JsonDocsTag[];
+    /**
+     * Set to `true` if the list should be rendered in compact mode
+     */
+    compact: boolean;
+    render(): HTMLElement[];
+    private renderTag;
+}

package/dist/types/components/type/templates/alias.d.ts

@@ -0,0 +1,4 @@
+import { AliasDescription } from '../../../types';
+export declare function Alias({ type }: {
+    type: AliasDescription;
+}): HTMLElement[];

package/dist/types/components/type/templates/enum.d.ts

@@ -0,0 +1,4 @@
+import { EnumDescription } from '../../../types';
+export declare function Enum({ type }: {
+    type: EnumDescription;
+}): HTMLElement[];

package/dist/types/components/type/templates/interface.d.ts

@@ -0,0 +1,4 @@
+import { InterfaceDescription } from '../../../types';
+export declare function Interface({ type, }: {
+    type: InterfaceDescription;
+}): HTMLElement[];

package/dist/types/components/type/type.d.ts

@@ -0,0 +1,15 @@
+import { TypeDescription } from '../../types';
+import { MatchResults } from '@limetech/stencil-router';
+export declare class Type {
+    /**
+     */
+    types: TypeDescription[];
+    /**
+     * Matched route parameters
+     */
+    match: MatchResults;
+    private type;
+    componentWillRender(): void;
+    render(): HTMLElement;
+    private findType;
+}