@docgeni/template/interfaces/navigation-item.d.ts

Docgeni - Angular Template Components

import { HeadingLink } from './toc';
export type DocItemToc = 'menu' | 'content' | 'hidden' | false;
export interface DocItem {
    id: string;
    title: string;
    subtitle?: string;
    summary?: string;
    path: string;
    channelPath?: string;
    contentPath?: string;
    originPath?: string;
    content?: string;
    order?: number;
    hidden?: boolean;
    locales?: {
        [key: string]: {
            title: string;
            summary?: string;
            content?: string;
        };
    };
    toc?: DocItemToc;
    headings?: HeadingLink[];
    ancestors?: CategoryItem[];
}
export interface ComponentDocItem extends DocItem {
    examples?: string[];
    importSpecifier?: string;
    overview?: boolean;
    api?: boolean;
    category?: string;
    label?: {
        text: string;
        color: string;
    };
}
export interface CategoryItem {
    id?: string;
    title: string;
    subtitle?: string;
    items?: Array<DocItem | ComponentDocItem | CategoryItem>;
    locales?: {
        [key: string]: {
            title: string;
            subtitle?: string;
        };
    };
    toc?: DocItemToc;
    ancestors?: CategoryItem[];
}
export interface ChannelItem {
    id: string;
    title: string;
    path: string;
    fullPath?: string;
    isExternal?: boolean;
    lib?: string;
    locales?: {
        [key: string]: {
            title: string;
        };
    };
    items?: Array<CategoryItem | DocItem | ChannelItem>;
}
export type NavigationItem = ChannelItem & CategoryItem & DocItem & ComponentDocItem;
//# sourceMappingURL=navigation-item.d.ts.map