@taiga-ui/addon-doc 3.19.0 → 3.20.0-dev.main-c462c1e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taiga-ui/addon-doc",
-  "version": "3.19.0",
+  "version": "3.20.0-dev.main-c462c1e",
   "description": "Taiga UI based library for developing documentation portals for Angular libraries.",
   "keywords": [
     "angular",
@@ -27,10 +27,10 @@
     "@angular/forms": ">=12.0.0",
     "@angular/router": ">=12.0.0",
     "@ng-web-apis/common": ">=2.0.0",
-    "@taiga-ui/addon-mobile": ">=3.19.0",
-    "@taiga-ui/cdk": ">=3.19.0",
-    "@taiga-ui/core": ">=3.19.0",
-    "@taiga-ui/kit": ">=3.19.0",
+    "@taiga-ui/addon-mobile": ">=3.20.0",
+    "@taiga-ui/cdk": ">=3.20.0",
+    "@taiga-ui/core": ">=3.20.0",
+    "@taiga-ui/kit": ">=3.20.0",
     "@tinkoff/ng-polymorpheus": ">=4.0.0"
   },
   "main": "bundles/taiga-ui-addon-doc.umd.js",

package/tokens/code-actions.d.ts

@@ -1,4 +1,7 @@
 import { InjectionToken } from '@angular/core';
 import { TuiContextWithImplicit } from '@taiga-ui/cdk';
 import { PolymorpheusContent } from '@tinkoff/ng-polymorpheus';
+/**
+ * Code actions for the opened tab with code example
+ */
 export declare const TUI_DOC_CODE_ACTIONS: InjectionToken<PolymorpheusContent<TuiContextWithImplicit<string>>>;

package/tokens/code-editor.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken } from '@angular/core';
 import { TuiCodeEditor } from '../interfaces/code-editor';
+/**
+ * Service for opening online IDE e.g. Stackblitz
+ */
 export declare const TUI_DOC_CODE_EDITOR: InjectionToken<TuiCodeEditor>;

package/tokens/default-tabs.d.ts

@@ -1,2 +1,5 @@
 import { InjectionToken } from '@angular/core';
+/**
+ * Array of default tab names
+ */
 export declare const TUI_DOC_DEFAULT_TABS: InjectionToken<readonly string[]>;

package/tokens/example-content-processor.d.ts

@@ -1,4 +1,10 @@
 import { InjectionToken } from '@angular/core';
 import { TuiHandler } from '@taiga-ui/cdk';
+/**
+ * Processes content in example
+ */
 export declare const TUI_DOC_EXAMPLE_CONTENT_PROCESSOR: InjectionToken<TuiHandler<Record<string, string>, Record<string, string>>>;
+/**
+ * Processes markdown in code block
+ */
 export declare const TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR: InjectionToken<TuiHandler<string, string[]>>;

package/tokens/excluded-properties.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken, Provider } from '@angular/core';
+/**
+ * Token to exclude inherited documentation properties
+ */
 export declare const TUI_DOC_EXCLUDED_PROPERTIES: InjectionToken<Set<string>>;
 export declare function tuiDocExcludeProperties(properties: readonly string[]): Provider;

package/tokens/i18n.d.ts

@@ -3,11 +3,13 @@ import { InjectionToken } from '@angular/core';
  * TODO: think about reorganization in @taiga-ui/i18n way
  */
 /**
+ * tui-doc-demo i18n texts
  * Works with a tuple
  * [@string tuiMode tooltip content, @string word 'background', @string 'form value']
  */
 export declare const TUI_DOC_DEMO_TEXTS: InjectionToken<[string, string, string]>;
 /**
+ * tui-doc-documentation i18n texts
  * Works with a tuple
  * [
  * @string word 'argument',
@@ -19,6 +21,7 @@ export declare const TUI_DOC_DEMO_TEXTS: InjectionToken<[string, string, string]
  */
 export declare const TUI_DOC_DOCUMENTATION_TEXTS: InjectionToken<[string, string, string, string, string]>;
 /**
+ * tui-doc-example i18n texts
  * Works with a tuple
  * [
  * @string default tab name,

package/tokens/logo.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken } from '@angular/core';
 import { PolymorpheusContent } from '@tinkoff/ng-polymorpheus';
+/**
+ * Main logo
+ */
 export declare const TUI_DOC_LOGO: InjectionToken<PolymorpheusContent<any>>;

package/tokens/page-loaded.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken } from '@angular/core';
 import { Observable } from 'rxjs';
+/**
+ * Stream that emits if loading of page is over (for example, to begin scrollIntoView)
+ */
 export declare const TUI_DOC_PAGE_LOADED: InjectionToken<Observable<boolean>>;

package/tokens/pages.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken } from '@angular/core';
 import { TuiDocPages } from '../types/pages';
+/**
+ * Documentation pages
+ */
 export declare const TUI_DOC_PAGES: InjectionToken<TuiDocPages>;

package/tokens/scroll-behavior.d.ts

@@ -1,2 +1,5 @@
 import { InjectionToken } from '@angular/core';
+/**
+ * Defines the transition animation for scroll
+ */
 export declare const TUI_DOC_SCROLL_BEHAVIOR: InjectionToken<ScrollBehavior>;

package/tokens/see-also.d.ts

@@ -1,2 +1,5 @@
 import { InjectionToken } from '@angular/core';
+/**
+ * Array of arrays of related pages
+ */
 export declare const TUI_DOC_SEE_ALSO: InjectionToken<readonly (readonly string[])[]>;

package/tokens/source-code.d.ts

@@ -1,4 +1,7 @@
 import { InjectionToken } from '@angular/core';
 import { PolymorpheusContent } from '@tinkoff/ng-polymorpheus';
 import { TuiDocSourceCodePathOptions } from '../interfaces/source-code-path-options';
+/**
+ * Source code link
+ */
 export declare const TUI_DOC_SOURCE_CODE: InjectionToken<PolymorpheusContent<TuiDocSourceCodePathOptions>>;

package/tokens/title.d.ts

@@ -1,2 +1,5 @@
 import { InjectionToken } from '@angular/core';
+/**
+ * Page title prefix
+ */
 export declare const TUI_DOC_TITLE: InjectionToken<string>;