@taiga-ui/addon-doc 3.19.0 → 3.20.0

package/fesm2015/taiga-ui-addon-doc.js

@@ -40,8 +40,18 @@ function tuiTryParseMarkdownCodeBlock(text = ``) {
     return result.length ? result : [text];
 }
 
-const TUI_DOC_EXAMPLE_CONTENT_PROCESSOR = new InjectionToken(`[TUI_DOC_EXAMPLE_CONTENT_PROCESSOR]: Processes content in example`, { factory: () => identity });
-const TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR = new InjectionToken(`[TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR]: Processes markdown in code block`, { factory: () => tuiTryParseMarkdownCodeBlock });
+/**
+ * Processes content in example
+ */
+const TUI_DOC_EXAMPLE_CONTENT_PROCESSOR = new InjectionToken(`[TUI_DOC_EXAMPLE_CONTENT_PROCESSOR]`, {
+    factory: () => identity,
+});
+/**
+ * Processes markdown in code block
+ */
+const TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR = new InjectionToken(`[TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR]`, {
+    factory: () => tuiTryParseMarkdownCodeBlock,
+});
 
 function tuiRawLoad(content) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -149,13 +159,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
  * 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']
  */
-const TUI_DOC_DEMO_TEXTS = new InjectionToken(`[TUI_DOC_DEMO_TEXTS]: tui-doc-demo i18n texts`, {
+const TUI_DOC_DEMO_TEXTS = new InjectionToken(`[TUI_DOC_DEMO_TEXTS]`, {
     factory: () => [`Read more more about modes: `, `Background`, `Form value`],
 });
 /**
+ * tui-doc-documentation i18n texts
  * Works with a tuple
  * [
  * @string word 'argument',
@@ -165,7 +177,7 @@ const TUI_DOC_DEMO_TEXTS = new InjectionToken(`[TUI_DOC_DEMO_TEXTS]: tui-doc-dem
  * @string message for tooltip about ng-polymorpheus
  * ]
  */
-const TUI_DOC_DOCUMENTATION_TEXTS = new InjectionToken(`[TUI_DOC_DOCUMENTATION_TEXTS]: tui-doc-documentation i18n texts`, {
+const TUI_DOC_DOCUMENTATION_TEXTS = new InjectionToken(`[TUI_DOC_DOCUMENTATION_TEXTS]`, {
     factory: () => [
         `Argument`,
         `Type`,
@@ -175,6 +187,7 @@ const TUI_DOC_DOCUMENTATION_TEXTS = new InjectionToken(`[TUI_DOC_DOCUMENTATION_T
     ],
 });
 /**
+ * tui-doc-example i18n texts
  * Works with a tuple
  * [
  * @string default tab name,
@@ -182,19 +195,19 @@ const TUI_DOC_DOCUMENTATION_TEXTS = new InjectionToken(`[TUI_DOC_DOCUMENTATION_T
  * @string link to a sample copied message label
  * ]
  */
-const TUI_DOC_EXAMPLE_TEXTS = new InjectionToken(`[TUI_DOC_EXAMPLE_TEXTS]: tui-doc-example i18n texts`, {
+const TUI_DOC_EXAMPLE_TEXTS = new InjectionToken(`[TUI_DOC_EXAMPLE_TEXTS]`, {
     factory: () => [`Preview`, `Link to a sample was successfully copied`, `Done`],
 });
-const TUI_DOC_MENU_TEXT = new InjectionToken(`[TUI_DOC_MENU_TEXT]: menu i18n text`, {
+const TUI_DOC_MENU_TEXT = new InjectionToken(`[TUI_DOC_MENU_TEXT]`, {
     factory: () => `Menu`,
 });
-const TUI_DOC_SEARCH_TEXT = new InjectionToken(`[TUI_DOC_SEARCH_TEXT]: search i18n text`, {
+const TUI_DOC_SEARCH_TEXT = new InjectionToken(`[TUI_DOC_SEARCH_TEXT]`, {
     factory: () => `Search`,
 });
-const TUI_DOC_SEE_ALSO_TEXT = new InjectionToken(`[TUI_DOC_SEE_ALSO_TEXT]: tui-doc-see-also i18n text`, {
+const TUI_DOC_SEE_ALSO_TEXT = new InjectionToken(`[TUI_DOC_SEE_ALSO_TEXT]`, {
     factory: () => `See also`,
 });
-const TUI_DOC_SOURCE_CODE_TEXT = new InjectionToken(`[TUI_DOC_SOURCE_CODE_TEXT]: tui-doc-source-code i18n text`, {
+const TUI_DOC_SOURCE_CODE_TEXT = new InjectionToken(`[TUI_DOC_SOURCE_CODE_TEXT]`, {
     factory: () => `Source code`,
 });
 
@@ -413,7 +426,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 }]
         }] });
 
-const TUI_DOC_EXCLUDED_PROPERTIES = new InjectionToken(`[TUI_DOC_EXCLUDED_PROPERTIES]: Token to exclude inherited documentation properties`, { factory: () => new Set([]) });
+/**
+ * Token to exclude inherited documentation properties
+ */
+const TUI_DOC_EXCLUDED_PROPERTIES = new InjectionToken(`[TUI_DOC_EXCLUDED_PROPERTIES]`, { factory: () => new Set([]) });
 function tuiDocExcludeProperties(properties) {
     return { provide: TUI_DOC_EXCLUDED_PROPERTIES, useValue: new Set(properties) };
 }
@@ -1008,11 +1024,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 }]
         }] });
 
-const TUI_DOC_CODE_ACTIONS = new InjectionToken(`[TUI_DOC_CODE_ACTIONS]: Code actions for the opened tab with code example`, {
+/**
+ * Code actions for the opened tab with code example
+ */
+const TUI_DOC_CODE_ACTIONS = new InjectionToken(`[TUI_DOC_CODE_ACTIONS]`, {
     factory: () => ``,
 });
 
-const TUI_DOC_CODE_EDITOR = new InjectionToken(`[TUI_DOC_CODE_EDITOR]: Contains service for opening online IDE e.g. Stackblitz`);
+/**
+ * Service for opening online IDE e.g. Stackblitz
+ */
+const TUI_DOC_CODE_EDITOR = new InjectionToken(`[TUI_DOC_CODE_EDITOR]`);
 
 function tuiRawLoadRecord(example) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -1036,7 +1058,10 @@ const TUI_DOC_EXAMPLE_DEFAULT_OPTIONS = {
     codeEditorVisibilityHandler: files => Boolean(files[TUI_EXAMPLE_PRIMARY_FILE_NAME.TS] &&
         files[TUI_EXAMPLE_PRIMARY_FILE_NAME.HTML]),
 };
-const TUI_DOC_EXAMPLE_OPTIONS = new InjectionToken(`[TUI_DOC_EXAMPLE_OPTIONS]: Default parameters for DocExample component`, {
+/**
+ * Default parameters for DocExample component
+ */
+const TUI_DOC_EXAMPLE_OPTIONS = new InjectionToken(`[TUI_DOC_EXAMPLE_OPTIONS]`, {
     factory: () => TUI_DOC_EXAMPLE_DEFAULT_OPTIONS,
 });
 function tuiDocExampleOptionsProvider(options) {
@@ -1327,9 +1352,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 }]
         }] });
 
-const TUI_DOC_PAGE_LOADED = new InjectionToken(`[TUI_DOC_PAGE_LOADED] Stream that emits if loading of page is over (for example, to begin scrollIntoView)`, { factory: () => defer(() => timer(200).pipe(switchMap(() => of(true)))) });
+/**
+ * Stream that emits if loading of page is over (for example, to begin scrollIntoView)
+ */
+const TUI_DOC_PAGE_LOADED = new InjectionToken(`[TUI_DOC_PAGE_LOADED]`, { factory: () => defer(() => timer(200).pipe(switchMap(() => of(true)))) });
 
-const TUI_DOC_SCROLL_BEHAVIOR = new InjectionToken(`[TUI_DOC_SCROLL_BEHAVIOR] Defines the transition animation for scroll`, { factory: () => `smooth` });
+/**
+ * Defines the transition animation for scroll
+ */
+const TUI_DOC_SCROLL_BEHAVIOR = new InjectionToken(`[TUI_DOC_SCROLL_BEHAVIOR]`, { factory: () => `smooth` });
 
 const MAP = {
     а: `f`,
@@ -1378,17 +1409,32 @@ function tuiTransliterateKeyboardLayout(string) {
     return newStr;
 }
 
-const TUI_DOC_PAGES = new InjectionToken(`[TUI_DOC_PAGES]: Documentation pages`, {
+/**
+ * Documentation pages
+ */
+const TUI_DOC_PAGES = new InjectionToken(`[TUI_DOC_PAGES]`, {
     factory: () => [],
 });
 
-const TUI_DOC_TITLE = new InjectionToken(`[TUI_DOC_TITLE]: Page title`, {
+/**
+ * Page title prefix
+ */
+const TUI_DOC_TITLE = new InjectionToken(`[TUI_DOC_TITLE]`, {
     factory: () => ``,
 });
 
-const NAVIGATION_TITLE = new InjectionToken(`[NAVIGATION_TITLE]: Page title`);
-const NAVIGATION_LABELS = new InjectionToken(`[NAVIGATION_LABELS]: Navigation sections labels for search`);
-const NAVIGATION_ITEMS = new InjectionToken(`[NAVIGATION_ITEMS]: Navigation pages`);
+/**
+ * Page title
+ */
+const NAVIGATION_TITLE = new InjectionToken(`[NAVIGATION_TITLE]`);
+/**
+ * Navigation sections labels for search
+ */
+const NAVIGATION_LABELS = new InjectionToken(`[NAVIGATION_LABELS]`);
+/**
+ * Navigation pages
+ */
+const NAVIGATION_ITEMS = new InjectionToken(`[NAVIGATION_ITEMS]`);
 const NAVIGATION_PROVIDERS = [
     TuiDestroyService,
     {
@@ -1644,7 +1690,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 args: ['class._open']
             }], filterItems: [], flattenSubPages: [] } });
 
-const TUI_DOC_LOGO = new InjectionToken(`[TUI_DOC_LOGO]: Main logo`, {
+/**
+ * Main logo
+ */
+const TUI_DOC_LOGO = new InjectionToken(`[TUI_DOC_LOGO]`, {
     factory: () => ``,
 });
 
@@ -1911,15 +1960,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 }]
         }] });
 
-const TUI_DOC_DEFAULT_TABS = new InjectionToken(`[TUI_DOC_DEFAULT_TABS]: Array of default tab names`, {
+/**
+ * Array of default tab names
+ */
+const TUI_DOC_DEFAULT_TABS = new InjectionToken(`[TUI_DOC_DEFAULT_TABS]`, {
     factory: () => [],
 });
 
-const TUI_DOC_SEE_ALSO = new InjectionToken(`[TUI_DOC_SEE_ALSO]: Array of arrays of related pages`, {
+/**
+ * Array of arrays of related pages
+ */
+const TUI_DOC_SEE_ALSO = new InjectionToken(`[TUI_DOC_SEE_ALSO]`, {
     factory: () => [],
 });
 
-const PAGE_SEE_ALSO = new InjectionToken(`[PAGE_SEE_ALSO]: Page see also`);
+/**
+ * Array if related page titles
+ */
+const PAGE_SEE_ALSO = new InjectionToken(`[PAGE_SEE_ALSO]`);
 const PAGE_PROVIDERS = [
     {
         provide: PAGE_SEE_ALSO,
@@ -1958,7 +2016,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
                 type: Input
             }] } });
 
-const TUI_DOC_SOURCE_CODE = new InjectionToken(`[TUI_DOC_SOURCE_CODE]: Source code link`, {
+/**
+ * Source code link
+ */
+const TUI_DOC_SOURCE_CODE = new InjectionToken(`[TUI_DOC_SOURCE_CODE]`, {
     factory: () => null,
 });