@ng-doc/app/types/ng-doc-app-classes-root-page.d.ts

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>

import { NgDocDemoAssets } from '@ng-doc/app/interfaces';
import { NgDocPage } from '@ng-doc/core/interfaces';
import { NgDocPageType } from '@ng-doc/core/types';

/**
 * Base class for NgDoc page
 */
declare abstract class NgDocRootPage {
    /**
     * The type of the page
     */
    abstract readonly pageType: NgDocPageType;
    /**
     * Html content of the page
     */
    abstract readonly pageContent: string;
    /**
     * Edit URL that can be used to edit the page source file in the repository
     */
    abstract readonly editSourceFileUrl?: string;
    /**
     * View URL that can be used to view the page source file in the repository
     */
    abstract readonly viewSourceFileUrl?: string;
    /**
     * The page dependencies file
     */
    readonly page?: NgDocPage;
    /**
     * The page demo assets that have code examples of the demo components
     */
    readonly demoAssets?: NgDocDemoAssets;
}

export { NgDocRootPage };