@ng-doc/app 22.0.0 → 22.1.0

package/types/ng-doc-app-services-highlighter.d.ts

@@ -1,7 +1,7 @@
 import * as _ng_doc_app_tokens from '@ng-doc/app/tokens';
 import * as i0 from '@angular/core';
 import { OnDestroy, Signal } from '@angular/core';
-import { ThemeInput } from 'shiki';
+import { ThemeInput, LanguageInput } from 'shiki/core';
 
 /** Shiki configuration of the code highlighter. */
 interface NgDocHighlighterConfig {
@@ -9,6 +9,13 @@ interface NgDocHighlighterConfig {
      * Themes sources.
      */
     themes?: ThemeInput[];
+    /**
+     * Shiki languages to load besides `angular-html`, the language of playground code, and the
+     * languages it embeds. A language named like one of them replaces it, so register here the
+     * languages of `shiki.langs` in `ng-doc.config.ts` that playground code uses, for example a newer
+     * Angular template grammar.
+     */
+    langs?: LanguageInput[];
     /**
      * Has no effect, and is reported in development mode.
      *
@@ -41,12 +48,12 @@ declare class NgDocHighlighterService implements OnDestroy {
     readonly ready: Signal<boolean>;
     /**
      * Loads Shiki with the built-in themes (`github-light`, `ayu-dark` and NgDoc's `css-variables`)
-     * and the given ones. Concurrent and repeated calls share one initialization; a failed one can
-     * be retried.
-     * @param config - Custom Shiki themes to load.
+     * and the given ones, and the given languages. Concurrent and repeated calls share one
+     * initialization; a failed one can be retried.
+     * @param config - Custom Shiki themes and languages to load.
      */
     initialize(config?: NgDocHighlighterConfig): Promise<void>;
-    /** Disposes the highlighter this service created for custom themes. */
+    /** Disposes the highlighter this service created for custom themes or languages. */
     ngOnDestroy(): void;
     private static create;
     /**

package/types/ng-doc-app-services-route-preloader.d.ts

@@ -95,11 +95,23 @@ declare class NgDocRoutePreloader {
     /**
      * Returns the application URL of a link, or `undefined` for a link that leaves the
      * application, opens elsewhere, downloads a file or points into the current page.
+     *
+     * The link is read through the location strategy: with `PathLocationStrategy` the route is the
+     * link's path, and with `HashLocationStrategy` (`withHashLocation()`) it is the link's fragment
+     * (`#/docs/page`), so a fragment that is not a route (`#usage`) is an anchor on the page.
      * @param anchor - The link.
      * @returns The URL relative to the application's base, with its query.
      */
     private linkUrl;
-    /** The base path of the application, ending with a slash. */
+    /**
+     * Whether the location strategy keeps the route in the document's fragment, as
+     * `HashLocationStrategy` does.
+     */
+    private hashLocation;
+    /**
+     * The base path of the application's routes, ending with a slash: the base href, which a
+     * fragment route carries only when `APP_BASE_HREF` sets one.
+     */
     private basePath;
     private destroy;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgDocRoutePreloader, never>;

package/types/ng-doc-app-type-controls-type-alias-control.d.ts

@@ -1,20 +1,42 @@
 import * as _angular_core from '@angular/core';
+import { Signal } from '@angular/core';
+import { NgDocResolvedPlaygroundOption } from '@ng-doc/app/helpers';
 import { NgDocTypeControl } from '@ng-doc/app/interfaces';
+import { NgDocPlaygroundOption } from '@ng-doc/core/interfaces';
 import { DIControl } from 'di-controls';
 
 /**
- * The playground control of union type aliases: a select that shows the value and whether it is
- * the default. The inspector shows the value type under the input's name.
+ * The playground control of union type aliases and enums: a select that shows the value (or the
+ * name of an enum member) and whether it is the default. The inspector shows the value type under
+ * the input's name.
  */
 declare class NgDocTypeAliasControlComponent<T> extends DIControl<T> implements NgDocTypeControl<T> {
     /** Default value of the input; clearing the selection returns to it. */
     readonly default: _angular_core.InputSignal<T | undefined>;
-    /** Values the input accepts: literal source text, or plain values when `isManual` is set. */
-    readonly options: _angular_core.InputSignal<string[] | undefined>;
+    /**
+     * Values the input accepts: literal source text, plain values when `isManual` is set, or the
+     * names and values of enum members.
+     */
+    readonly options: _angular_core.InputSignal<(string | NgDocPlaygroundOption)[] | undefined>;
     /** Whether `options` are values the user listed in the playground config. */
     readonly isManual: _angular_core.InputSignal<boolean | undefined>;
+    /**
+     * The options of the select. `undefined` and `null` get no option: clearing the selection
+     * returns to the default value instead.
+     */
+    protected readonly items: Signal<NgDocResolvedPlaygroundOption[]>;
     constructor();
     typeOf(value: unknown): string;
+    /**
+     * The text of a value: the name of its option, such as the name of an enum member.
+     * @param value - A value of the input.
+     */
+    labelOf(value: unknown): string;
+    /**
+     * Whether the reset button is shown: a value other than the default is selected.
+     * @param value - The selected value.
+     */
+    protected canReset(value: T | null): boolean;
     changeModel(value: T | null): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgDocTypeAliasControlComponent<any>, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgDocTypeAliasControlComponent<any>, "ng-doc-type-alias-control", never, { "default": { "alias": "default"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; "isManual": { "alias": "isManual"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;