kompendium/dist/types/kompendium/menu.d.ts

Documentation generator for Stencil components

import { JsonDocsComponent, JsonDocs } from '../stencil-public-runtime';
import { MenuItem, KompendiumGuide, TypeDescription } from '../types';
export declare function createMenu(docs: JsonDocs, guides: KompendiumGuide[], types: TypeDescription[]): MenuItem[];
export declare const addGuide: (menu: MenuItem[], path: string) => (guide: KompendiumGuide) => void;
export declare function createComponentMenu(docs: JsonDocs): MenuItem;
export declare function isExample(component: JsonDocsComponent): boolean;
export declare function isPublic(component: JsonDocsComponent): boolean;
export declare function getComponentMenu(component: JsonDocsComponent): MenuItem;
export declare function getComponentTitle(tag: string): string;
export declare function createApiMenu(): MenuItem;
export declare function createVersionMenu(): MenuItem;
export declare function getTypeMenu(type: TypeDescription): MenuItem;