@ng-doc/app 19.2.0 → 20.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/classes/default-search-engine/index.d.ts +44 -1
- package/classes/root-page/index.d.ts +35 -1
- package/classes/search-engine/index.d.ts +11 -1
- package/components/api-list/index.d.ts +30 -1
- package/components/breadcrumb/index.d.ts +10 -1
- package/components/code/index.d.ts +16 -1
- package/components/copy-button/index.d.ts +15 -1
- package/components/demo/index.d.ts +22 -1
- package/components/demo-displayer/index.d.ts +16 -1
- package/components/demo-pane/index.d.ts +21 -1
- package/components/fullscreen-button/index.d.ts +9 -1
- package/components/heading-anchor/index.d.ts +12 -1
- package/components/image-viewer/index.d.ts +19 -1
- package/components/kind-icon/index.d.ts +11 -1
- package/components/link/index.d.ts +9 -1
- package/components/mermaid-viewer/index.d.ts +20 -1
- package/components/navbar/index.d.ts +33 -1
- package/components/page/index.d.ts +19 -1
- package/components/page-header/index.d.ts +9 -1
- package/components/page-link/index.d.ts +22 -1
- package/components/page-navigation/index.d.ts +11 -1
- package/components/page-wrapper/index.d.ts +26 -1
- package/components/playground/index.d.ts +143 -7
- package/components/root/index.d.ts +60 -1
- package/components/search/index.d.ts +18 -1
- package/components/search-dialog/index.d.ts +28 -1
- package/components/search-result/index.d.ts +14 -1
- package/components/sidebar/index.d.ts +15 -1
- package/components/tabs/index.d.ts +12 -1
- package/components/theme-toggle/index.d.ts +19 -1
- package/components/toc/index.d.ts +38 -2
- package/constants/index.d.ts +3 -1
- package/defaults/default-processors/index.d.ts +5 -1
- package/defaults/default-skeleton/index.d.ts +5 -1
- package/directives/code-highlighter/index.d.ts +17 -1
- package/directives/route-active/index.d.ts +13 -1
- package/fesm2022/ng-doc-app-classes-default-search-engine.mjs.map +1 -1
- package/fesm2022/ng-doc-app-classes-root-page.mjs.map +1 -1
- package/fesm2022/ng-doc-app-classes-search-engine.mjs.map +1 -1
- package/fesm2022/ng-doc-app-classes.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-api-list.mjs +5 -8
- package/fesm2022/ng-doc-app-components-api-list.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-breadcrumb.mjs +6 -8
- package/fesm2022/ng-doc-app-components-breadcrumb.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-code.mjs +9 -14
- package/fesm2022/ng-doc-app-components-code.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-copy-button.mjs +5 -5
- package/fesm2022/ng-doc-app-components-copy-button.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-demo-displayer.mjs +6 -7
- package/fesm2022/ng-doc-app-components-demo-displayer.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-demo-pane.mjs +10 -12
- package/fesm2022/ng-doc-app-components-demo-pane.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-demo.mjs +10 -12
- package/fesm2022/ng-doc-app-components-demo.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-fullscreen-button.mjs +4 -4
- package/fesm2022/ng-doc-app-components-fullscreen-button.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-heading-anchor.mjs +6 -6
- package/fesm2022/ng-doc-app-components-heading-anchor.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-image-viewer.mjs +5 -6
- package/fesm2022/ng-doc-app-components-image-viewer.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-kind-icon.mjs +4 -4
- package/fesm2022/ng-doc-app-components-kind-icon.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-link.mjs +4 -4
- package/fesm2022/ng-doc-app-components-link.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-mermaid-viewer.mjs +4 -4
- package/fesm2022/ng-doc-app-components-mermaid-viewer.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-navbar.mjs +17 -37
- package/fesm2022/ng-doc-app-components-navbar.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-page-header.mjs +5 -6
- package/fesm2022/ng-doc-app-components-page-header.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-page-link.mjs +6 -6
- package/fesm2022/ng-doc-app-components-page-link.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-page-navigation.mjs +5 -8
- package/fesm2022/ng-doc-app-components-page-navigation.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-page-wrapper.mjs +4 -6
- package/fesm2022/ng-doc-app-components-page-wrapper.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-page.mjs +9 -24
- package/fesm2022/ng-doc-app-components-page.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-playground.mjs +38 -50
- package/fesm2022/ng-doc-app-components-playground.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-root.mjs +15 -20
- package/fesm2022/ng-doc-app-components-root.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-search-dialog.mjs +7 -10
- package/fesm2022/ng-doc-app-components-search-dialog.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-search-result.mjs +6 -8
- package/fesm2022/ng-doc-app-components-search-result.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-search.mjs +9 -32
- package/fesm2022/ng-doc-app-components-search.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-sidebar.mjs +15 -25
- package/fesm2022/ng-doc-app-components-sidebar.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-tabs.mjs +6 -17
- package/fesm2022/ng-doc-app-components-tabs.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-theme-toggle.mjs +4 -6
- package/fesm2022/ng-doc-app-components-theme-toggle.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components-toc.mjs +13 -18
- package/fesm2022/ng-doc-app-components-toc.mjs.map +1 -1
- package/fesm2022/ng-doc-app-components.mjs.map +1 -1
- package/fesm2022/ng-doc-app-constants.mjs.map +1 -1
- package/fesm2022/ng-doc-app-defaults-default-processors.mjs.map +1 -1
- package/fesm2022/ng-doc-app-defaults-default-skeleton.mjs +1 -1
- package/fesm2022/ng-doc-app-defaults-default-skeleton.mjs.map +1 -1
- package/fesm2022/ng-doc-app-defaults.mjs.map +1 -1
- package/fesm2022/ng-doc-app-directives-code-highlighter.mjs +3 -3
- package/fesm2022/ng-doc-app-directives-code-highlighter.mjs.map +1 -1
- package/fesm2022/ng-doc-app-directives-route-active.mjs +17 -25
- package/fesm2022/ng-doc-app-directives-route-active.mjs.map +1 -1
- package/fesm2022/ng-doc-app-directives.mjs.map +1 -1
- package/fesm2022/ng-doc-app-helpers.mjs.map +1 -1
- package/fesm2022/ng-doc-app-interfaces.mjs.map +1 -1
- package/fesm2022/ng-doc-app-pipes-decode-uri-component.mjs +3 -3
- package/fesm2022/ng-doc-app-pipes-decode-uri-component.mjs.map +1 -1
- package/fesm2022/ng-doc-app-pipes-extract-value.mjs +3 -3
- package/fesm2022/ng-doc-app-pipes-extract-value.mjs.map +1 -1
- package/fesm2022/ng-doc-app-pipes-filter-by-text.mjs +3 -3
- package/fesm2022/ng-doc-app-pipes-filter-by-text.mjs.map +1 -1
- package/fesm2022/ng-doc-app-pipes-sanitize-html.mjs +8 -8
- package/fesm2022/ng-doc-app-pipes-sanitize-html.mjs.map +1 -1
- package/fesm2022/ng-doc-app-pipes.mjs.map +1 -1
- package/fesm2022/ng-doc-app-processors-page-processor.mjs +4 -4
- package/fesm2022/ng-doc-app-processors-page-processor.mjs.map +1 -1
- package/fesm2022/ng-doc-app-processors-processors-link.mjs.map +1 -1
- package/fesm2022/ng-doc-app-processors-processors-tooltip.mjs +7 -7
- package/fesm2022/ng-doc-app-processors-processors-tooltip.mjs.map +1 -1
- package/fesm2022/ng-doc-app-processors-processors.mjs.map +1 -1
- package/fesm2022/ng-doc-app-processors.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-mermaid.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-ng-doc-app.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-page-skeleton.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-playground-demo.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-search-engine.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers-type-control.mjs.map +1 -1
- package/fesm2022/ng-doc-app-providers.mjs.map +1 -1
- package/fesm2022/ng-doc-app-services-highlighter.mjs +3 -3
- package/fesm2022/ng-doc-app-services-highlighter.mjs.map +1 -1
- package/fesm2022/ng-doc-app-services-sidebar.mjs +6 -13
- package/fesm2022/ng-doc-app-services-sidebar.mjs.map +1 -1
- package/fesm2022/ng-doc-app-services-store.mjs +3 -3
- package/fesm2022/ng-doc-app-services-store.mjs.map +1 -1
- package/fesm2022/ng-doc-app-services-theme.mjs +6 -12
- package/fesm2022/ng-doc-app-services-theme.mjs.map +1 -1
- package/fesm2022/ng-doc-app-services.mjs.map +1 -1
- package/fesm2022/ng-doc-app-tokens.mjs.map +1 -1
- package/fesm2022/ng-doc-app-type-controls-boolean-control.mjs +4 -4
- package/fesm2022/ng-doc-app-type-controls-boolean-control.mjs.map +1 -1
- package/fesm2022/ng-doc-app-type-controls-number-control.mjs +5 -7
- package/fesm2022/ng-doc-app-type-controls-number-control.mjs.map +1 -1
- package/fesm2022/ng-doc-app-type-controls-string-control.mjs +5 -7
- package/fesm2022/ng-doc-app-type-controls-string-control.mjs.map +1 -1
- package/fesm2022/ng-doc-app-type-controls-type-alias-control.mjs +6 -8
- package/fesm2022/ng-doc-app-type-controls-type-alias-control.mjs.map +1 -1
- package/fesm2022/ng-doc-app-type-controls.mjs.map +1 -1
- package/fesm2022/ng-doc-app-types.mjs.map +1 -1
- package/fesm2022/ng-doc-app.mjs.map +1 -1
- package/helpers/index.d.ts +49 -7
- package/interfaces/index.d.ts +221 -13
- package/package.json +27 -27
- package/pipes/decode-uri-component/index.d.ts +10 -1
- package/pipes/extract-value/index.d.ts +11 -1
- package/pipes/filter-by-text/index.d.ts +10 -1
- package/pipes/sanitize-html/index.d.ts +14 -1
- package/processors/page-processor/index.d.ts +26 -1
- package/processors/processors/index.d.ts +32 -10
- package/processors/processors/link/index.d.ts +6 -1
- package/processors/processors/tooltip/index.d.ts +17 -1
- package/providers/mermaid/index.d.ts +10 -1
- package/providers/ng-doc-app/index.d.ts +25 -1
- package/providers/page-skeleton/index.d.ts +13 -1
- package/providers/playground-demo/index.d.ts +20 -1
- package/providers/search-engine/index.d.ts +15 -1
- package/providers/type-control/index.d.ts +18 -1
- package/services/highlighter/index.d.ts +29 -1
- package/services/sidebar/index.d.ts +37 -1
- package/services/store/index.d.ts +13 -1
- package/services/theme/index.d.ts +27 -1
- package/styles/themes/dark.css +22 -22
- package/tokens/index.d.ts +63 -8
- package/type-controls/boolean-control/index.d.ts +16 -1
- package/type-controls/number-control/index.d.ts +13 -1
- package/type-controls/string-control/index.d.ts +14 -1
- package/type-controls/type-alias-control/index.d.ts +16 -1
- package/types/index.d.ts +7 -1
- package/classes/default-search-engine/default-search-engine.d.ts +0 -40
- package/classes/root-page/root-page.d.ts +0 -32
- package/classes/search-engine/search-engine.d.ts +0 -8
- package/components/api-list/api-list.component.d.ts +0 -28
- package/components/breadcrumb/breadcrumb.component.d.ts +0 -7
- package/components/code/code.component.d.ts +0 -14
- package/components/copy-button/copy-button.component.d.ts +0 -12
- package/components/demo/demo.component.d.ts +0 -20
- package/components/demo-displayer/demo-displayer.component.d.ts +0 -13
- package/components/demo-pane/demo-pane.component.d.ts +0 -19
- package/components/fullscreen-button/fullscreen-button.component.d.ts +0 -6
- package/components/heading-anchor/heading-anchor.component.d.ts +0 -9
- package/components/image-viewer/image-viewer.component.d.ts +0 -16
- package/components/kind-icon/kind-icon.component.d.ts +0 -8
- package/components/link/link.component.d.ts +0 -6
- package/components/mermaid-viewer/mermaid-viewer.component.d.ts +0 -17
- package/components/navbar/navbar.component.d.ts +0 -31
- package/components/page/page.component.d.ts +0 -16
- package/components/page-header/page-header.component.d.ts +0 -6
- package/components/page-link/page-link.component.d.ts +0 -19
- package/components/page-navigation/page-navigation.component.d.ts +0 -8
- package/components/page-wrapper/page-wrapper.component.d.ts +0 -22
- package/components/playground/base-playground.d.ts +0 -28
- package/components/playground/playground-demo/playground-demo.component.d.ts +0 -33
- package/components/playground/playground-form.d.ts +0 -5
- package/components/playground/playground-properties/playground-properties.component.d.ts +0 -35
- package/components/playground/playground-property/playground-property.component.d.ts +0 -20
- package/components/playground/playground-property-control.d.ts +0 -7
- package/components/playground/playground.component.d.ts +0 -30
- package/components/root/root.component.d.ts +0 -57
- package/components/search/search.component.d.ts +0 -15
- package/components/search-dialog/search-dialog.component.d.ts +0 -24
- package/components/search-result/search-result.component.d.ts +0 -11
- package/components/sidebar/sidebar-category/sidebar-category.component.d.ts +0 -20
- package/components/sidebar/sidebar-item/sidebar-item.component.d.ts +0 -12
- package/components/sidebar/sidebar.component.d.ts +0 -11
- package/components/tabs/tabs.component.d.ts +0 -9
- package/components/theme-toggle/theme-toggle.component.d.ts +0 -17
- package/components/toc/toc-element/toc-element.component.d.ts +0 -11
- package/components/toc/toc.component.d.ts +0 -25
- package/constants/store-keys.d.ts +0 -1
- package/defaults/default-processors/default-processors.d.ts +0 -2
- package/defaults/default-skeleton/default-skeleton.d.ts +0 -2
- package/directives/code-highlighter/code-highlighter.directive.d.ts +0 -14
- package/directives/route-active/route-active.directive.d.ts +0 -14
- package/helpers/as-boolean.d.ts +0 -5
- package/helpers/create-component.d.ts +0 -8
- package/helpers/format-html.d.ts +0 -5
- package/helpers/generate-toc.d.ts +0 -7
- package/helpers/is-dark-os-theme.d.ts +0 -4
- package/helpers/is-external-link.d.ts +0 -5
- package/helpers/is-playground-property.d.ts +0 -6
- package/interfaces/context.d.ts +0 -10
- package/interfaces/demo-assets.d.ts +0 -9
- package/interfaces/navigation.d.ts +0 -19
- package/interfaces/page-processor.d.ts +0 -27
- package/interfaces/page-skeleton.d.ts +0 -53
- package/interfaces/processor-options.d.ts +0 -7
- package/interfaces/provided-type-control.d.ts +0 -7
- package/interfaces/search-result.d.ts +0 -15
- package/interfaces/tab.d.ts +0 -6
- package/interfaces/theme.d.ts +0 -13
- package/interfaces/toc-item.d.ts +0 -7
- package/interfaces/type-control-provider-options.d.ts +0 -15
- package/interfaces/type-control.d.ts +0 -26
- package/pipes/decode-uri-component/decode-uri-component.pipe.d.ts +0 -7
- package/pipes/extract-value/extract-value.pipe.d.ts +0 -8
- package/pipes/filter-by-text/filter-by-text.pipe.d.ts +0 -7
- package/pipes/sanitize-html/sanitize-html.pipe.d.ts +0 -10
- package/processors/page-processor/page-processor.component.d.ts +0 -23
- package/processors/processors/blockquote.processor.d.ts +0 -3
- package/processors/processors/code.processor.d.ts +0 -3
- package/processors/processors/demo-pane.processor.d.ts +0 -3
- package/processors/processors/demo.processor.d.ts +0 -3
- package/processors/processors/heading-anchor.processor.d.ts +0 -3
- package/processors/processors/icon.processor.d.ts +0 -3
- package/processors/processors/image.processor.d.ts +0 -3
- package/processors/processors/link/link.processor.d.ts +0 -3
- package/processors/processors/mermaid.processor.d.ts +0 -3
- package/processors/processors/playground.processor.d.ts +0 -3
- package/processors/processors/tabs.processor.d.ts +0 -3
- package/processors/processors/tooltip/tooltip.processor.d.ts +0 -15
- package/providers/mermaid/provide-mermaid.d.ts +0 -7
- package/providers/ng-doc-app/provide-ng-doc-app.d.ts +0 -21
- package/providers/page-skeleton/provide-page-skeleton.d.ts +0 -9
- package/providers/playground-demo/provide-playground-demo.d.ts +0 -17
- package/providers/search-engine/provide-search-engine.d.ts +0 -12
- package/providers/type-control/provide-type-control.d.ts +0 -15
- package/services/highlighter/highlighter.service.d.ts +0 -24
- package/services/sidebar/sidebar.service.d.ts +0 -34
- package/services/store/store.service.d.ts +0 -10
- package/services/theme/theme.service.d.ts +0 -24
- package/tokens/context.d.ts +0 -3
- package/tokens/mermaid.d.ts +0 -3
- package/tokens/page-processor.d.ts +0 -15
- package/tokens/page-skeleton.d.ts +0 -3
- package/tokens/route-prefix.d.ts +0 -2
- package/tokens/shiki-theme.d.ts +0 -6
- package/tokens/theme.d.ts +0 -28
- package/tokens/type-control.d.ts +0 -3
- package/type-controls/boolean-control/boolean-control.component.d.ts +0 -13
- package/type-controls/number-control/number-control.component.d.ts +0 -10
- package/type-controls/string-control/string-control.component.d.ts +0 -11
- package/type-controls/type-alias-control/type-alias-control.component.d.ts +0 -13
- package/types/typed-form.d.ts +0 -4
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { NgDocThemeService } from '@ng-doc/app/services/theme';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
interface ToggleTheme {
|
|
4
|
-
name: string;
|
|
5
|
-
theme: string | null;
|
|
6
|
-
}
|
|
7
|
-
export declare class NgDocThemeToggleComponent {
|
|
8
|
-
protected readonly themes: ToggleTheme[];
|
|
9
|
-
protected readonly documentElement: HTMLElement;
|
|
10
|
-
protected readonly themeService: NgDocThemeService;
|
|
11
|
-
get currentTheme(): ToggleTheme;
|
|
12
|
-
get nextTheme(): ToggleTheme;
|
|
13
|
-
toggleTheme(): void;
|
|
14
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocThemeToggleComponent, never>;
|
|
15
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocThemeToggleComponent, "ng-doc-theme-toggle", never, {}, {}, never, never, true, never>;
|
|
16
|
-
}
|
|
17
|
-
export {};
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { ElementRef } from '@angular/core';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class NgDocTocElementComponent {
|
|
4
|
-
path: string;
|
|
5
|
-
hash: string;
|
|
6
|
-
selected: boolean;
|
|
7
|
-
level: number;
|
|
8
|
-
readonly elementRef: ElementRef<HTMLElement>;
|
|
9
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocTocElementComponent, never>;
|
|
10
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocTocElementComponent, "li[ng-doc-toc-element]", never, { "path": { "alias": "path"; "required": false; }; "hash": { "alias": "hash"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "level": { "alias": "level"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
11
|
-
}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { ChangeDetectorRef, ElementRef, NgZone, OnInit, QueryList, Renderer2, WritableSignal } from '@angular/core';
|
|
2
|
-
import { Router } from '@angular/router';
|
|
3
|
-
import { NgDocPageToc, NgDocTocItem } from '@ng-doc/app/interfaces';
|
|
4
|
-
import { NgDocTocElementComponent } from './toc-element/toc-element.component';
|
|
5
|
-
import * as i0 from "@angular/core";
|
|
6
|
-
export declare class NgDocTocComponent implements NgDocPageToc, OnInit {
|
|
7
|
-
tableOfContent: NgDocTocItem[];
|
|
8
|
-
selection?: ElementRef<HTMLElement>;
|
|
9
|
-
elements: QueryList<NgDocTocElementComponent>;
|
|
10
|
-
activeItem: WritableSignal<NgDocTocItem | undefined>;
|
|
11
|
-
protected readonly document: Document;
|
|
12
|
-
protected readonly ngZone: NgZone;
|
|
13
|
-
protected readonly changeDetectorRef: ChangeDetectorRef;
|
|
14
|
-
protected readonly renderer: Renderer2;
|
|
15
|
-
protected readonly router: Router;
|
|
16
|
-
constructor();
|
|
17
|
-
ngOnInit(): void;
|
|
18
|
-
/**
|
|
19
|
-
* Selects the item in the table of content.
|
|
20
|
-
* @param item - Item to select.
|
|
21
|
-
*/
|
|
22
|
-
protected select(item: NgDocTocItem): void;
|
|
23
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocTocComponent, never>;
|
|
24
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocTocComponent, "ng-doc-toc", never, { "tableOfContent": { "alias": "tableOfContent"; "required": false; }; }, {}, never, never, true, never>;
|
|
25
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const NG_DOC_STORE_THEME_KEY: string;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { Signal } from '@angular/core';
|
|
2
|
-
import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
|
|
3
|
-
import { NgDocHighlighterService } from '@ng-doc/app/services';
|
|
4
|
-
import * as i0 from "@angular/core";
|
|
5
|
-
export declare class NgDocCodeHighlighterDirective {
|
|
6
|
-
code: import("@angular/core").InputSignal<string>;
|
|
7
|
-
protected readonly highlightedCode: Signal<SafeHtml>;
|
|
8
|
-
protected readonly element: any;
|
|
9
|
-
protected readonly highlighter: NgDocHighlighterService;
|
|
10
|
-
protected readonly sanitizer: DomSanitizer;
|
|
11
|
-
constructor();
|
|
12
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocCodeHighlighterDirective, never>;
|
|
13
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<NgDocCodeHighlighterDirective, "[ngDocHighlighter]", never, { "code": { "alias": "ngDocHighlighter"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
14
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { ElementRef, Renderer2 } from '@angular/core';
|
|
2
|
-
import { IsActiveMatchOptions, Router } from '@angular/router';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class NgDocRouteActiveDirective {
|
|
5
|
-
private readonly elementRef;
|
|
6
|
-
private readonly router;
|
|
7
|
-
private readonly renderer;
|
|
8
|
-
link: string;
|
|
9
|
-
activeClass: string | string[];
|
|
10
|
-
matchOptions: IsActiveMatchOptions;
|
|
11
|
-
constructor(elementRef: ElementRef<HTMLElement>, router: Router, renderer: Renderer2);
|
|
12
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocRouteActiveDirective, never>;
|
|
13
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<NgDocRouteActiveDirective, "[ngDocRouteActive]", never, { "link": { "alias": "ngDocRouteActive"; "required": false; }; "activeClass": { "alias": "activeClass"; "required": false; }; "matchOptions": { "alias": "matchOptions"; "required": false; }; }, {}, never, never, true, never>;
|
|
14
|
-
}
|
package/helpers/as-boolean.d.ts
DELETED
package/helpers/format-html.d.ts
DELETED
package/interfaces/context.d.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { JSDocMetadata, NgDocBaseEntity } from '@ng-doc/core/interfaces';
|
|
2
|
-
/**
|
|
3
|
-
* Navigation item interface
|
|
4
|
-
*/
|
|
5
|
-
export interface NgDocNavigation extends NgDocBaseEntity {
|
|
6
|
-
expandable?: boolean;
|
|
7
|
-
/** Determines whether the category should be expanded by default */
|
|
8
|
-
expanded?: boolean;
|
|
9
|
-
/** Children of the navigation item */
|
|
10
|
-
children?: NgDocNavigation[];
|
|
11
|
-
/** The route of the entity (current sourceFileFolder name by default) */
|
|
12
|
-
route: string;
|
|
13
|
-
/**
|
|
14
|
-
* The item metadata.
|
|
15
|
-
* Collects all tags based on the JSDoc tags for `NgDocPage` or `NgDocCategory`
|
|
16
|
-
* entities.
|
|
17
|
-
*/
|
|
18
|
-
metadata?: JSDocMetadata;
|
|
19
|
-
}
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import { Injector, Type } from '@angular/core';
|
|
2
|
-
import { NgDocProcessorOptions } from './processor-options';
|
|
3
|
-
/**
|
|
4
|
-
* Interface to create a processor that will be used to replace html nodes with an Angular component.
|
|
5
|
-
*/
|
|
6
|
-
export interface NgDocPageProcessor<T = unknown> {
|
|
7
|
-
/**
|
|
8
|
-
* Target component to replace html nodes with.
|
|
9
|
-
*/
|
|
10
|
-
component: Type<T>;
|
|
11
|
-
/**
|
|
12
|
-
* Selector to find html nodes to replace.
|
|
13
|
-
*/
|
|
14
|
-
selector: string;
|
|
15
|
-
/**
|
|
16
|
-
* Extract options for Angular component from html node.
|
|
17
|
-
* @param element - Html node to extract options from.
|
|
18
|
-
* @param root - Root html node.
|
|
19
|
-
*/
|
|
20
|
-
extractOptions: (element: Element, root: HTMLElement) => NgDocProcessorOptions<T>;
|
|
21
|
-
/**
|
|
22
|
-
* Can be used to find a node to replace instead of the node that was found by selector.
|
|
23
|
-
* @param element - Html node to replace.
|
|
24
|
-
* @param injector - Injector to get dependencies.
|
|
25
|
-
*/
|
|
26
|
-
nodeToReplace?: (element: Element, injector: Injector) => Element;
|
|
27
|
-
}
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
import { Type } from '@angular/core';
|
|
2
|
-
import { NgDocNavigation } from './navigation';
|
|
3
|
-
import { NgDocTocItem } from './toc-item';
|
|
4
|
-
/**
|
|
5
|
-
* Interface for page navigation implementation
|
|
6
|
-
*/
|
|
7
|
-
export interface NgDocPageNavigation {
|
|
8
|
-
/**
|
|
9
|
-
* Previous page
|
|
10
|
-
*/
|
|
11
|
-
prevPage?: NgDocNavigation;
|
|
12
|
-
/**
|
|
13
|
-
* Next page
|
|
14
|
-
*/
|
|
15
|
-
nextPage?: NgDocNavigation;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Interface for page breadcrumb implementation
|
|
19
|
-
*/
|
|
20
|
-
export interface NgDocPageBreadcrumbs {
|
|
21
|
-
/**
|
|
22
|
-
* Breadcrumb items
|
|
23
|
-
*/
|
|
24
|
-
breadcrumbs: string[];
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Interface for page table of content implementation
|
|
28
|
-
*/
|
|
29
|
-
export interface NgDocPageToc {
|
|
30
|
-
/**
|
|
31
|
-
* Table of content items.
|
|
32
|
-
*/
|
|
33
|
-
tableOfContent: NgDocTocItem[];
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Page skeleton that should be used to create different parts of the page.
|
|
37
|
-
*
|
|
38
|
-
* You can use it to define your own components for the page navigation, breadcrumb, etc.
|
|
39
|
-
*/
|
|
40
|
-
export interface NgDocPageSkeleton {
|
|
41
|
-
/**
|
|
42
|
-
* Page breadcrumbs.
|
|
43
|
-
*/
|
|
44
|
-
breadcrumbs?: Type<NgDocPageBreadcrumbs>;
|
|
45
|
-
/**
|
|
46
|
-
* Bottom page navigation.
|
|
47
|
-
*/
|
|
48
|
-
navigation?: Type<NgDocPageNavigation>;
|
|
49
|
-
/**
|
|
50
|
-
* Table of content.
|
|
51
|
-
*/
|
|
52
|
-
toc?: Type<NgDocPageToc>;
|
|
53
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { Constructor } from '@ng-doc/core/types/constructor';
|
|
2
|
-
import { NgDocTypeControl } from './type-control';
|
|
3
|
-
import { NgDocTypeControlProviderOptions } from './type-control-provider-options';
|
|
4
|
-
export interface NgDocProvidedTypeControl {
|
|
5
|
-
control: Constructor<NgDocTypeControl>;
|
|
6
|
-
options?: NgDocTypeControlProviderOptions;
|
|
7
|
-
}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { NgDocPageIndex } from '@ng-doc/core/interfaces';
|
|
2
|
-
import { NgDocHighlightPosition } from '@ng-doc/ui-kit';
|
|
3
|
-
/**
|
|
4
|
-
* Results of a search query.
|
|
5
|
-
*/
|
|
6
|
-
export interface NgDocSearchResult {
|
|
7
|
-
/**
|
|
8
|
-
* Index that was found.
|
|
9
|
-
*/
|
|
10
|
-
index: NgDocPageIndex;
|
|
11
|
-
/**
|
|
12
|
-
* Positions of the found terms.
|
|
13
|
-
*/
|
|
14
|
-
positions: Partial<Record<keyof NgDocPageIndex, NgDocHighlightPosition[]>>;
|
|
15
|
-
}
|
package/interfaces/tab.d.ts
DELETED
package/interfaces/theme.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Interface describing a custom theme for the application
|
|
3
|
-
*/
|
|
4
|
-
export interface NgDocTheme {
|
|
5
|
-
/**
|
|
6
|
-
* Theme ID that you can use to set theme (e.g. `CustomTheme`)
|
|
7
|
-
*/
|
|
8
|
-
id: string;
|
|
9
|
-
/**
|
|
10
|
-
* Path that will be used to load theme dynamically (e.g. `/assets/themes/custom.css`)
|
|
11
|
-
*/
|
|
12
|
-
path: string;
|
|
13
|
-
}
|
package/interfaces/toc-item.d.ts
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Options for the type control provider
|
|
3
|
-
*/
|
|
4
|
-
export interface NgDocTypeControlProviderOptions {
|
|
5
|
-
/**
|
|
6
|
-
* Allows to hide the label of the type control,
|
|
7
|
-
* if the label is not needed or if you want to use a custom label
|
|
8
|
-
*/
|
|
9
|
-
hideLabel?: boolean;
|
|
10
|
-
/**
|
|
11
|
-
* You can use this to change the order of the type control
|
|
12
|
-
* NgDoc's controls start at 5 and go up to 10
|
|
13
|
-
*/
|
|
14
|
-
order?: number;
|
|
15
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { ControlValueAccessor } from '@angular/forms';
|
|
2
|
-
/**
|
|
3
|
-
* Interface describing Type Control
|
|
4
|
-
*/
|
|
5
|
-
export interface NgDocTypeControl<T = unknown> extends ControlValueAccessor {
|
|
6
|
-
/**
|
|
7
|
-
* The name of the input for which it is created
|
|
8
|
-
*/
|
|
9
|
-
name?: string;
|
|
10
|
-
/**
|
|
11
|
-
* The description of the input (based on the comment)
|
|
12
|
-
*/
|
|
13
|
-
description?: string;
|
|
14
|
-
/**
|
|
15
|
-
* The default value of the input
|
|
16
|
-
*/
|
|
17
|
-
default?: T;
|
|
18
|
-
/**
|
|
19
|
-
* The list of possible values, it usually works only for Type Aliases which has several values
|
|
20
|
-
*/
|
|
21
|
-
options?: string[];
|
|
22
|
-
/**
|
|
23
|
-
* Determines if the property is manually added by the user using `controls` property in playground config
|
|
24
|
-
*/
|
|
25
|
-
isManual?: boolean;
|
|
26
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { PipeTransform } from '@angular/core';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class NgDocDecodeUriComponentPipe implements PipeTransform {
|
|
4
|
-
transform(value: string): string;
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocDecodeUriComponentPipe, never>;
|
|
6
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<NgDocDecodeUriComponentPipe, "decodeUriComponent", true>;
|
|
7
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { PipeTransform } from '@angular/core';
|
|
2
|
-
import { NgDocExtractedValue } from '@ng-doc/core/types/extracted-value';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class NgDocExtractValuePipe implements PipeTransform {
|
|
5
|
-
transform(value: string): NgDocExtractedValue;
|
|
6
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocExtractValuePipe, never>;
|
|
7
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<NgDocExtractValuePipe, "ngDocExtractValue", true>;
|
|
8
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { PipeTransform } from '@angular/core';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class NgDocFilterByTextPipe<T> implements PipeTransform {
|
|
4
|
-
transform(items: readonly T[], searchTerm: string, matcher?: (item: T, searchTerm: string) => boolean): readonly T[];
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocFilterByTextPipe<any>, never>;
|
|
6
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<NgDocFilterByTextPipe<any>, "ngDocFilterByText", true>;
|
|
7
|
-
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { PipeTransform } from '@angular/core';
|
|
2
|
-
import { DomSanitizer, SafeHtml } from '@angular/platform-browser';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class NgDocSanitizeHtmlPipe implements PipeTransform {
|
|
5
|
-
private readonly sanitizer;
|
|
6
|
-
constructor(sanitizer: DomSanitizer);
|
|
7
|
-
transform(value: string): SafeHtml;
|
|
8
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocSanitizeHtmlPipe, never>;
|
|
9
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<NgDocSanitizeHtmlPipe, "ngDocSanitizeHtml", true>;
|
|
10
|
-
}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { ApplicationRef, ElementRef, EventEmitter, Injector, OnChanges, Renderer2, SimpleChanges, ViewContainerRef } from '@angular/core';
|
|
2
|
-
import { SafeHtml } from '@angular/platform-browser';
|
|
3
|
-
import { NgDocPageProcessor } from '@ng-doc/app/interfaces';
|
|
4
|
-
import * as i0 from "@angular/core";
|
|
5
|
-
/**
|
|
6
|
-
* Base processor class to create a processor directive that will be used to replace
|
|
7
|
-
* html nodes with an Angular component.
|
|
8
|
-
*/
|
|
9
|
-
export declare class NgDocPageProcessorComponent implements OnChanges {
|
|
10
|
-
html: SafeHtml;
|
|
11
|
-
afterRender: EventEmitter<void>;
|
|
12
|
-
processors: Array<NgDocPageProcessor<unknown>>;
|
|
13
|
-
customProcessors: Array<NgDocPageProcessor<unknown>>;
|
|
14
|
-
protected readonly elementRef: ElementRef<HTMLElement>;
|
|
15
|
-
protected readonly viewContainerRef: ViewContainerRef;
|
|
16
|
-
protected readonly applicationRef: ApplicationRef;
|
|
17
|
-
protected readonly injector: Injector;
|
|
18
|
-
protected readonly renderer: Renderer2;
|
|
19
|
-
ngOnChanges({ html }: SimpleChanges): void;
|
|
20
|
-
private process;
|
|
21
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocPageProcessorComponent, never>;
|
|
22
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocPageProcessorComponent, "[ngDocPageProcessor]", never, { "html": { "alias": "ngDocPageProcessor"; "required": true; }; }, { "afterRender": "afterRender"; }, never, ["*"], true, never>;
|
|
23
|
-
}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { AfterViewInit, ChangeDetectorRef } from '@angular/core';
|
|
2
|
-
import { NgDocPageProcessor } from '@ng-doc/app/interfaces';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
declare class NgDocTooltipWrapperComponent implements AfterViewInit {
|
|
5
|
-
private readonly changeDetectorRef;
|
|
6
|
-
content?: string;
|
|
7
|
-
protected tooltipElement: HTMLElement | null;
|
|
8
|
-
private contentProjection?;
|
|
9
|
-
constructor(changeDetectorRef: ChangeDetectorRef);
|
|
10
|
-
ngAfterViewInit(): void;
|
|
11
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgDocTooltipWrapperComponent, never>;
|
|
12
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<NgDocTooltipWrapperComponent, "ng-doc-tooltip-wrapper", never, { "content": { "alias": "content"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
13
|
-
}
|
|
14
|
-
export declare const tooltipProcessor: NgDocPageProcessor<NgDocTooltipWrapperComponent>;
|
|
15
|
-
export {};
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { EnvironmentProviders, Provider } from '@angular/core';
|
|
2
|
-
import { NgDocHighlighterConfig } from '@ng-doc/app/services/highlighter';
|
|
3
|
-
import { NgDocUiConfig } from '@ng-doc/ui-kit';
|
|
4
|
-
/**
|
|
5
|
-
* NgDoc application config.
|
|
6
|
-
*/
|
|
7
|
-
export interface NgDocApplicationConfig {
|
|
8
|
-
/**
|
|
9
|
-
* UI Kit configuration.
|
|
10
|
-
*/
|
|
11
|
-
uiKit?: NgDocUiConfig;
|
|
12
|
-
/**
|
|
13
|
-
* Shiki theme.
|
|
14
|
-
*/
|
|
15
|
-
shiki?: NgDocHighlighterConfig;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Provides the NgDoc application configuration.
|
|
19
|
-
* @param config - The optional application configuration.
|
|
20
|
-
*/
|
|
21
|
-
export declare function provideNgDocApp(config?: NgDocApplicationConfig): Array<EnvironmentProviders | Provider>;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { NgDocPageSkeleton } from '@ng-doc/app/interfaces';
|
|
2
|
-
/**
|
|
3
|
-
* Provides the skeleton components for the page.
|
|
4
|
-
* @param skeleton - The skeleton for the page.
|
|
5
|
-
*/
|
|
6
|
-
export declare function providePageSkeleton(skeleton: NgDocPageSkeleton): {
|
|
7
|
-
provide: import("@angular/core").InjectionToken<NgDocPageSkeleton>;
|
|
8
|
-
useValue: NgDocPageSkeleton;
|
|
9
|
-
}[];
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { InjectionToken, Provider } from '@angular/core';
|
|
2
|
-
import { Constructor } from '@ng-doc/core/types';
|
|
3
|
-
/**
|
|
4
|
-
*
|
|
5
|
-
* @param type
|
|
6
|
-
* @param control
|
|
7
|
-
* @param options
|
|
8
|
-
* @param playgroundId
|
|
9
|
-
* @param selector
|
|
10
|
-
* @param component
|
|
11
|
-
*/
|
|
12
|
-
export declare function providePlaygroundDemo(playgroundId: string, component: Constructor<unknown>): Provider;
|
|
13
|
-
/**
|
|
14
|
-
* Returns the token for the given playground id.
|
|
15
|
-
* @param playgroundId
|
|
16
|
-
*/
|
|
17
|
-
export declare function getPlaygroundDemoToken<T>(playgroundId: string): InjectionToken<T[]> | undefined;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { Provider } from '@angular/core';
|
|
2
|
-
import { NgDocSearchEngine } from '@ng-doc/app/classes/search-engine';
|
|
3
|
-
import { Constructor } from '@ng-doc/core/types';
|
|
4
|
-
/**
|
|
5
|
-
* Provides the `NgDocSearchEngine` to enable search in the documentation.
|
|
6
|
-
*
|
|
7
|
-
* You can create and provide your own `NgDocSearchEngine` if you want to handle the search yourself.
|
|
8
|
-
* @param engine - The search engine class.
|
|
9
|
-
* @param args - The arguments for the search engine class.
|
|
10
|
-
* @returns The provider for the search engine.
|
|
11
|
-
*/
|
|
12
|
-
export declare function provideSearchEngine<E extends Constructor<NgDocSearchEngine>>(engine: E, ...args: ConstructorParameters<E>): Provider;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { InjectionToken, Provider } from '@angular/core';
|
|
2
|
-
import { NgDocProvidedTypeControl, NgDocTypeControl, NgDocTypeControlProviderOptions } from '@ng-doc/app/interfaces';
|
|
3
|
-
import { Constructor } from '@ng-doc/core/types';
|
|
4
|
-
/**
|
|
5
|
-
*
|
|
6
|
-
* @param type
|
|
7
|
-
* @param control
|
|
8
|
-
* @param options
|
|
9
|
-
*/
|
|
10
|
-
export declare function provideTypeControl(type: string, control: Constructor<NgDocTypeControl>, options?: NgDocTypeControlProviderOptions): Provider;
|
|
11
|
-
/**
|
|
12
|
-
* Returns token for type control based on provided type
|
|
13
|
-
* @param type - type for searched control (e.g. `string`)
|
|
14
|
-
*/
|
|
15
|
-
export declare function getTokenForType(type: string): InjectionToken<NgDocProvidedTypeControl> | undefined;
|