@ng-doc/app 22.0.0-beta.2 → 22.1.0

package/types/ng-doc-app-components-members.d.ts

@@ -0,0 +1,13 @@
+import * as i0 from '@angular/core';
+import * as i1 from '@ng-doc/app/directives/members-filter';
+
+/**
+ * The members table of an API page in the symbol view. The builder renders its tabs, filter and
+ * rows as the component's content, and the component adds the member filter to them.
+ */
+declare class NgDocMembersComponent {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocMembersComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocMembersComponent, "ng-doc-members", never, {}, {}, never, ["*"], true, [{ directive: typeof i1.NgDocMembersFilterDirective; inputs: {}; outputs: {}; }]>;
+}
+
+export { NgDocMembersComponent };

package/types/ng-doc-app-components-mermaid-viewer.d.ts

@@ -1,18 +1,33 @@
 import * as _angular_core from '@angular/core';
-import { OnInit, ChangeDetectorRef } from '@angular/core';
 import { Mermaid } from 'mermaid';
 
-declare class NgDocMermaidViewerComponent implements OnInit {
-    graph: _angular_core.InputSignal<string>;
+/**
+ * Renders a Mermaid graph in a zoomable, pannable viewer. The graph is rendered in the browser
+ * only, again when it changes and when the theme changes.
+ *
+ * In the dark theme (or `auto` with a dark OS theme) the graph uses Mermaid's dark theme, unless
+ * the graph or `provideMermaid` chooses a theme of its own.
+ */
+declare class NgDocMermaidViewerComponent {
+    /** Source of the Mermaid graph. */
+    readonly graph: _angular_core.InputSignal<string>;
     protected readonly html: _angular_core.WritableSignal<string>;
     protected readonly pending: _angular_core.WritableSignal<boolean>;
     protected readonly error: _angular_core.WritableSignal<Error | null>;
     protected readonly mermaid: Mermaid;
-    protected readonly changeDetectorRef: ChangeDetectorRef;
-    protected readonly platform: Object;
     protected readonly id: string;
+    private renderId;
+    private readonly document;
+    private readonly themeService;
     constructor();
-    ngOnInit(): Promise<void>;
+    /**
+     * Adds Mermaid's dark theme to the graph when the page is dark. A graph with front matter or an
+     * init directive, and a theme set in `provideMermaid`, are left as they are.
+     * @param graph - The graph source.
+     * @returns The graph to render.
+     */
+    private themed;
+    private render;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocMermaidViewerComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocMermaidViewerComponent, "ng-doc-mermaid-viewer", never, { "graph": { "alias": "graph"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }

package/types/ng-doc-app-components-navbar.d.ts

@@ -1,33 +1,43 @@
-import { NgDocSidebarService } from '@ng-doc/app/services';
-import * as i0 from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { NgDocSidebarService } from '@ng-doc/app/services/sidebar';
 
 /**
- * Navbar component for ng-doc application
+ * Navbar of the NgDoc application: the header bar above the sidebar and the page.
+ *
+ * It lays out, from left to right: the menu button (only where the sidebar is an overlay), the
+ * content marked with `ngDocNavbarLeft` (for example the logo), the content marked with
+ * `ngDocNavbarCenter` (for example the section links, hidden at 1024px and below), the search, and
+ * the content marked with `ngDocNavbarRight` (for example the theme toggle).
+ * @example
+ * ```html
+ * <ng-doc-navbar>
+ *   <a ngDocNavbarLeft routerLink="/">My library</a>
+ *   <nav ngDocNavbarCenter aria-label="Primary"><a routerLink="/docs">Guides</a></nav>
+ *   <ng-doc-theme-toggle ngDocNavbarRight />
+ * </ng-doc-navbar>
+ * ```
  */
 declare class NgDocNavbarComponent {
-    private readonly window;
-    private readonly ngZone;
-    private readonly changeDetectorRef;
     protected readonly sidebarService: NgDocSidebarService;
     /**
      * Show search input
      */
-    search: boolean;
+    readonly search: _angular_core.InputSignalWithTransform<boolean, unknown>;
     /**
-     * Show hamburger button
+     * Show the menu button that opens the sidebar where it is an overlay (900px and below).
      */
-    hamburger: boolean;
+    readonly hamburger: _angular_core.InputSignalWithTransform<boolean, unknown>;
     /**
      * Use glass effect for navbar
      */
-    glassEffect: boolean;
+    readonly glassEffect: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    private readonly menuButton;
     /**
-     * Indicates if navbar has border
+     * Closes the sidebar overlay and moves focus back to the menu button that opened it.
      */
-    hasBorder: boolean;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocNavbarComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocNavbarComponent, "ng-doc-navbar", never, { "search": { "alias": "search"; "required": false; }; "hamburger": { "alias": "hamburger"; "required": false; }; "glassEffect": { "alias": "glassEffect"; "required": false; }; }, {}, never, ["[ngDocNavbarLeft]", "[ngDocNavbarRight]"], true, never>;
+    protected closeSidebar(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocNavbarComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocNavbarComponent, "ng-doc-navbar", never, { "search": { "alias": "search"; "required": false; "isSignal": true; }; "hamburger": { "alias": "hamburger"; "required": false; "isSignal": true; }; "glassEffect": { "alias": "glassEffect"; "required": false; "isSignal": true; }; }, {}, never, ["[ngDocNavbarLeft]", "[ngDocNavbarCenter]", "[ngDocNavbarRight]"], true, never>;
 }
 
 export { NgDocNavbarComponent };

package/types/ng-doc-app-components-page-header.d.ts

@@ -1,9 +1,33 @@
-import * as i0 from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { NgDocContentController } from '@ng-doc/app/classes/content-controller';
+import { NgDocContentSource } from '@ng-doc/core/interfaces';
 
+/**
+ * The header of a documentation page: the rendered header HTML, or the header of an
+ * asynchronous content source.
+ */
 declare class NgDocPageHeaderComponent {
-    headerContent: string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageHeaderComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageHeaderComponent, "ng-doc-page-header", never, { "headerContent": { "alias": "headerContent"; "required": true; }; }, {}, never, never, true, never>;
+    /** The rendered header HTML, used when there is no content source. */
+    readonly headerContent: _angular_core.InputSignal<string>;
+    /** The source of the header content, for pages whose content loads asynchronously. */
+    readonly headerContentSource: _angular_core.InputSignal<NgDocContentSource | undefined>;
+    protected readonly contentController: NgDocContentController;
+    private readonly host;
+    private readonly browser;
+    /** Removes the server-rendered copy shown while asynchronous content loads. */
+    private snapshot?;
+    constructor();
+    /**
+     * Shows the loaded header in place of the server-rendered copy when a pass of it is about to
+     * render, in the same task. The pass of the empty header before the source has loaded keeps
+     * the copy.
+     * @param version - The content version of the pass.
+     * @internal
+     */
+    protected revealLoaded(version: number): void;
+    private releaseSnapshot;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocPageHeaderComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocPageHeaderComponent, "ng-doc-page-header", never, { "headerContent": { "alias": "headerContent"; "required": true; "isSignal": true; }; "headerContentSource": { "alias": "headerContentSource"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 export { NgDocPageHeaderComponent };

package/types/ng-doc-app-components-page-link.d.ts

@@ -1,22 +1,41 @@
-import * as i0 from '@angular/core';
-import { OnInit, OnChanges } from '@angular/core';
-import { Params } from '@angular/router';
+import * as _angular_core from '@angular/core';
+import { OnInit } from '@angular/core';
+import { UrlTree, Params } from '@angular/router';
 
-declare class NgDocPageLinkComponent implements OnInit, OnChanges {
-    href: string;
-    classes: string;
-    protected isInCode: boolean;
-    private link;
+/**
+ * A link in the page content. Links inside the application navigate with the router; other links
+ * open in a new tab and, outside code, show an external-link icon.
+ */
+declare class NgDocPageLinkComponent implements OnInit {
+    /**
+     * The link target, as written in the content. It is optional so that a render before the
+     * page processor sets it (auto-detected change detection) does not fail.
+     */
+    readonly href: _angular_core.InputSignal<string>;
+    /** Classes of the link element. */
+    readonly classes: _angular_core.InputSignal<string>;
+    /** Whether the link sits inside a code element. */
+    protected readonly isInCode: _angular_core.WritableSignal<boolean>;
     private readonly location;
+    private readonly locationStrategy;
+    private readonly router;
     private readonly elementRef;
+    private readonly resolved;
+    /** Whether the link navigates with the router. */
+    protected readonly usesRouterLink: _angular_core.Signal<boolean>;
+    /** The router target of an application link. */
+    protected readonly routerLink: _angular_core.Signal<UrlTree | undefined>;
+    /** Whether the link leaves the application's origin. */
+    readonly isExternalLink: _angular_core.Signal<boolean>;
+    /** The path of an application link, or the `href` of any other link. */
+    readonly path: _angular_core.Signal<string>;
+    /** The fragment of the link, without `#`. */
+    readonly fragment: _angular_core.Signal<string | undefined>;
+    /** The query parameters of the link. */
+    readonly queryParams: _angular_core.Signal<Params>;
     ngOnInit(): void;
-    ngOnChanges(): void;
-    get isExternalLink(): boolean;
-    get path(): string;
-    get fragment(): string | undefined;
-    get queryParams(): Params;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageLinkComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageLinkComponent, "ng-doc-page-link", never, { "href": { "alias": "href"; "required": true; }; "classes": { "alias": "classes"; "required": false; }; }, {}, never, ["*"], true, never>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocPageLinkComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocPageLinkComponent, "ng-doc-page-link", never, { "href": { "alias": "href"; "required": false; "isSignal": true; }; "classes": { "alias": "classes"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
 }
 
 export { NgDocPageLinkComponent };

package/types/ng-doc-app-components-page-navigation.d.ts

@@ -1,11 +1,16 @@
+import * as _angular_core from '@angular/core';
 import { NgDocPageNavigation, NgDocNavigation } from '@ng-doc/app/interfaces';
-import * as i0 from '@angular/core';
 
+/**
+ * Links to the previous and the next page, as two cards at the bottom of a guide.
+ */
 declare class NgDocPageNavigationComponent implements NgDocPageNavigation {
-    prevPage?: NgDocNavigation;
-    nextPage?: NgDocNavigation;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageNavigationComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageNavigationComponent, "ng-doc-page-navigation", never, { "prevPage": { "alias": "prevPage"; "required": true; }; "nextPage": { "alias": "nextPage"; "required": true; }; }, {}, never, never, true, never>;
+    /** The page before this one in the sidebar. */
+    readonly prevPage: _angular_core.InputSignal<NgDocNavigation | undefined>;
+    /** The page after this one in the sidebar. */
+    readonly nextPage: _angular_core.InputSignal<NgDocNavigation | undefined>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocPageNavigationComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocPageNavigationComponent, "ng-doc-page-navigation", never, { "prevPage": { "alias": "prevPage"; "required": false; "isSignal": true; }; "nextPage": { "alias": "nextPage"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 export { NgDocPageNavigationComponent };

package/types/ng-doc-app-components-page-wrapper.d.ts

@@ -1,26 +1,50 @@
 import * as _ng_doc_app_interfaces from '@ng-doc/app/interfaces';
-import * as i0 from '@angular/core';
+import * as _angular_core from '@angular/core';
 import { OnInit, ViewContainerRef } from '@angular/core';
 import { Routes, Router, ActivatedRoute } from '@angular/router';
+import { NgDocFullscreenRouteService } from '@ng-doc/app/services/fullscreen-route';
+import { NgDocContentSource } from '@ng-doc/core/interfaces';
 import { NgDocPageType } from '@ng-doc/core/types';
 
+/**
+ * Layout of a generated page: the breadcrumbs, the page header, the tabs of a page with several
+ * routes, the page itself, the previous and next page links, and the table of contents beside it.
+ *
+ * The breadcrumbs, the page links and the table of contents are the page skeleton's components,
+ * created in the containers this component exposes.
+ *
+ * While the page shows one of its fullscreen routes (`NgDocFullscreenRouteService`), only the page
+ * is shown.
+ */
 declare class NgDocPageWrapperComponent implements OnInit {
-    routes: Routes;
-    headerContent: string;
-    hasBreadcrumb: boolean;
-    pageType: NgDocPageType;
-    pageBreadcrumbs: ViewContainerRef;
-    pageToc?: ViewContainerRef;
-    pageNavigation: ViewContainerRef;
+    /** Routes of the page; a page with more than one gets tabs. */
+    readonly routes: _angular_core.InputSignal<Routes>;
+    /** HTML of the page header. */
+    readonly headerContent: _angular_core.InputSignal<string>;
+    /** Deferred source of the page header, for generated pages that load it separately. */
+    readonly headerContentSource: _angular_core.InputSignal<NgDocContentSource | undefined>;
+    /** Whether the page shows breadcrumbs. */
+    readonly hasBreadcrumb: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /** Type of the page: guides get previous and next page links, API pages do not. */
+    readonly pageType: _angular_core.InputSignal<NgDocPageType>;
+    /** Container of the breadcrumbs. */
+    readonly pageBreadcrumbs: _angular_core.Signal<ViewContainerRef>;
+    /** Container of the table of contents. */
+    readonly pageToc: _angular_core.Signal<ViewContainerRef>;
+    /** Container of the previous and next page links. */
+    readonly pageNavigation: _angular_core.Signal<ViewContainerRef>;
     protected skeleton: _ng_doc_app_interfaces.NgDocPageSkeleton;
     protected router: Router;
     protected route: ActivatedRoute;
     protected context: _ng_doc_app_interfaces.NgDocContext;
+    protected readonly fullscreenRoute: NgDocFullscreenRouteService;
     private breadcrumbs;
+    private readonly preloader;
+    private readonly injector;
     ngOnInit(): void;
-    private navigationInputs;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageWrapperComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageWrapperComponent, "ng-doc-page-wrapper", never, { "routes": { "alias": "routes"; "required": true; }; "headerContent": { "alias": "headerContent"; "required": true; }; "hasBreadcrumb": { "alias": "hasBreadcrumb"; "required": false; }; "pageType": { "alias": "pageType"; "required": false; }; }, {}, never, never, true, never>;
+    private adjacentPages;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocPageWrapperComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocPageWrapperComponent, "ng-doc-page-wrapper", never, { "routes": { "alias": "routes"; "required": true; "isSignal": true; }; "headerContent": { "alias": "headerContent"; "required": true; "isSignal": true; }; "headerContentSource": { "alias": "headerContentSource"; "required": false; "isSignal": true; }; "hasBreadcrumb": { "alias": "hasBreadcrumb"; "required": false; "isSignal": true; }; "pageType": { "alias": "pageType"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 export { NgDocPageWrapperComponent };

package/types/ng-doc-app-components-page.d.ts

@@ -1,19 +1,70 @@
-import * as i0 from '@angular/core';
-import { ElementRef, TemplateRef, ChangeDetectorRef } from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { ElementRef, ChangeDetectorRef } from '@angular/core';
+import { NgDocContentController } from '@ng-doc/app/classes/content-controller';
 import { NgDocRootPage } from '@ng-doc/app/classes/root-page';
 import { NgDocPageWrapperComponent } from '@ng-doc/app/components/page-wrapper';
 import { NgDocPageSkeleton } from '@ng-doc/app/interfaces';
 
+/**
+ * A generated page: its rendered content, the page actions (copy link, edit and view the source),
+ * the table of contents it fills in, and the outlet of its fullscreen routes.
+ *
+ * A fullscreen route (a child route of the page, unless the page sets `disableFullscreenRoutes`)
+ * replaces the page: it is shown on its own on the canvas of demos, with a link back to the page,
+ * and `NgDocFullscreenRouteService` tells the root layout and the page wrapper to hide their
+ * chrome.
+ */
 declare class NgDocPageComponent {
-    pageContainer: ElementRef<HTMLElement>;
-    childOutlet?: TemplateRef<never>;
+    /** The element that holds the rendered page content. */
+    readonly pageContainer: _angular_core.Signal<ElementRef<any> | undefined>;
     protected rootPage: NgDocRootPage;
     protected skeleton: NgDocPageSkeleton;
     protected changeDetectorRef: ChangeDetectorRef;
     protected pageWrapper: NgDocPageWrapperComponent;
+    protected readonly contentController: NgDocContentController;
+    /** Whether the link to the page was just copied. */
+    protected readonly linkCopied: _angular_core.WritableSignal<boolean>;
+    /** Whether one of the page's fullscreen routes is shown instead of the page. */
+    protected readonly fullscreenRoute: _angular_core.WritableSignal<boolean>;
+    /** URL of the page, for the link back from a fullscreen route. */
+    protected readonly pageUrl: _angular_core.WritableSignal<string>;
+    private readonly route;
+    private readonly fullscreenRoutes;
+    private readonly contentAnchorController;
+    private readonly clipboard;
+    private readonly ngZone;
+    private readonly location;
+    private readonly locationStrategy;
+    private linkCopiedTimer?;
+    /** Removes the server-rendered copy shown while asynchronous content loads. */
+    private snapshot?;
+    constructor();
+    /**
+     * Shows one of the page's fullscreen routes instead of the page, or the page again. The outlet
+     * of the fullscreen routes calls it when a route opens or closes.
+     * @param shown - Whether a fullscreen route is shown.
+     */
+    protected showFullscreenRoute(shown: boolean): void;
+    /**
+     * Creates the table of contents from the headings of the rendered page.
+     */
     createToc(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageComponent, "ng-doc-page", never, {}, {}, never, never, true, never>;
+    /**
+     * Shows the page's own content in place of the server-rendered copy when a pass of the loaded
+     * content is about to render, in the same task, so its components render and measure visible.
+     * The pass of the empty content before the source has loaded keeps the copy.
+     * @param version - The content version of the pass.
+     * @internal
+     */
+    protected revealLoaded(version: number): void;
+    /**
+     * Copies the link to the page, without its query and fragment.
+     */
+    copyLink(): void;
+    private connectContent;
+    private releaseSnapshot;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocPageComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocPageComponent, "ng-doc-page", never, {}, {}, never, never, true, never>;
 }
 
 export { NgDocPageComponent };