@ng-doc/app
Version:
<!-- 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>
61 lines (58 loc) • 2.49 kB
TypeScript
import { NgDocSidebarService } from '@ng-doc/app/services';
import { NgDocContent, NgDocSidenavComponent } from '@ng-doc/ui-kit';
import * as i0 from '@angular/core';
/**
* Directive uses for providing custom navbar, you should mark element with this directive
* and the `NgDocRootComponent` will use it as a navbar
*
* ```html
* <ng-doc-root>
* <my-custom-navbar ngDocCustomNavbar></my-custom-navbar>
*
* <ng-doc-sidebar></ng-doc-sidebar>
* <router-outlet></router-outlet>
* </ng-doc-root>
* ```
*/
declare class NgDocCustomNavbarDirective {
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocCustomNavbarDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<NgDocCustomNavbarDirective, "[ngDocCustomNavbar]", never, {}, {}, never, never, true, never>;
}
/**
* Directive uses for providing custom sidebar, you should mark element with this directive
* and the `NgDocRootComponent` will use it as a sidebar
*
* ```html
* <ng-doc-root>
* <ng-doc-navbar></ng-doc-sidebar>
*
* <my-custom-sidebar ngDocCustomSidebar></my-custom-sidebar>
* <router-outlet></router-outlet>
* </ng-doc-root>
* ```
*/
declare class NgDocCustomSidebarDirective {
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocCustomSidebarDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<NgDocCustomSidebarDirective, "[ngDocCustomSidebar]", never, {}, {}, never, never, true, never>;
}
declare class NgDocRootComponent {
/**
* If `true` then the sidebar will be shown
* You can use it for example for landing page to hide sidebar
*/
sidebar: boolean;
/**
* Content for footer
*/
footerContent: NgDocContent;
/**
* If `true` then page will be shown without width limit.
* You can use it for example for landing page
*/
noWidthLimit: boolean;
sidenav?: NgDocSidenavComponent;
protected readonly sidebarService: NgDocSidebarService;
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocRootComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocRootComponent, "ng-doc-root", never, { "sidebar": { "alias": "sidebar"; "required": false; }; "footerContent": { "alias": "footerContent"; "required": false; }; "noWidthLimit": { "alias": "noWidthLimit"; "required": false; }; }, {}, never, ["ng-doc-navbar", "[ngDocCustomNavbar]", "ng-doc-sidebar", "[ngDocCustomSidebar]", "*"], true, never>;
}
export { NgDocCustomNavbarDirective, NgDocCustomSidebarDirective, NgDocRootComponent };