@taiga-ui/addon-doc 3.19.0 → 3.20.0-dev.main-c462c1e
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/bundles/taiga-ui-addon-doc.umd.js +86 -25
- package/bundles/taiga-ui-addon-doc.umd.js.map +1 -1
- package/components/example/example-options.d.ts +3 -0
- package/components/language-switcher/language-switcher.component.d.ts +1 -1
- package/components/navigation/navigation.providers.d.ts +9 -0
- package/components/page/page.providers.d.ts +3 -0
- package/esm2015/components/example/example-options.js +5 -2
- package/esm2015/components/language-switcher/language-switcher.component.js +1 -1
- package/esm2015/components/navigation/navigation.providers.js +13 -4
- package/esm2015/components/page/page.providers.js +5 -2
- package/esm2015/tokens/code-actions.js +5 -2
- package/esm2015/tokens/code-editor.js +5 -2
- package/esm2015/tokens/default-tabs.js +5 -2
- package/esm2015/tokens/example-content-processor.js +13 -3
- package/esm2015/tokens/excluded-properties.js +5 -2
- package/esm2015/tokens/i18n.js +11 -8
- package/esm2015/tokens/logo.js +5 -2
- package/esm2015/tokens/page-loaded.js +5 -2
- package/esm2015/tokens/pages.js +5 -2
- package/esm2015/tokens/scroll-behavior.js +5 -2
- package/esm2015/tokens/see-also.js +5 -2
- package/esm2015/tokens/source-code.js +5 -2
- package/esm2015/tokens/title.js +5 -2
- package/fesm2015/taiga-ui-addon-doc.js +86 -25
- package/fesm2015/taiga-ui-addon-doc.js.map +1 -1
- package/package.json +5 -5
- package/tokens/code-actions.d.ts +3 -0
- package/tokens/code-editor.d.ts +3 -0
- package/tokens/default-tabs.d.ts +3 -0
- package/tokens/example-content-processor.d.ts +6 -0
- package/tokens/excluded-properties.d.ts +3 -0
- package/tokens/i18n.d.ts +3 -0
- package/tokens/logo.d.ts +3 -0
- package/tokens/page-loaded.d.ts +3 -0
- package/tokens/pages.d.ts +3 -0
- package/tokens/scroll-behavior.d.ts +3 -0
- package/tokens/see-also.d.ts +3 -0
- package/tokens/source-code.d.ts +3 -0
- package/tokens/title.d.ts +3 -0
|
@@ -55,8 +55,18 @@
|
|
|
55
55
|
return result.length ? result : [text];
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
|
|
59
|
-
|
|
58
|
+
/**
|
|
59
|
+
* Processes content in example
|
|
60
|
+
*/
|
|
61
|
+
var TUI_DOC_EXAMPLE_CONTENT_PROCESSOR = new i0.InjectionToken("[TUI_DOC_EXAMPLE_CONTENT_PROCESSOR]", {
|
|
62
|
+
factory: function () { return i9.identity; },
|
|
63
|
+
});
|
|
64
|
+
/**
|
|
65
|
+
* Processes markdown in code block
|
|
66
|
+
*/
|
|
67
|
+
var TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR = new i0.InjectionToken("[TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR]", {
|
|
68
|
+
factory: function () { return tuiTryParseMarkdownCodeBlock; },
|
|
69
|
+
});
|
|
60
70
|
|
|
61
71
|
/*! *****************************************************************************
|
|
62
72
|
Copyright (c) Microsoft Corporation.
|
|
@@ -521,13 +531,15 @@
|
|
|
521
531
|
* TODO: think about reorganization in @taiga-ui/i18n way
|
|
522
532
|
*/
|
|
523
533
|
/**
|
|
534
|
+
* tui-doc-demo i18n texts
|
|
524
535
|
* Works with a tuple
|
|
525
536
|
* [@string tuiMode tooltip content, @string word 'background', @string 'form value']
|
|
526
537
|
*/
|
|
527
|
-
var TUI_DOC_DEMO_TEXTS = new i0.InjectionToken("[TUI_DOC_DEMO_TEXTS]
|
|
538
|
+
var TUI_DOC_DEMO_TEXTS = new i0.InjectionToken("[TUI_DOC_DEMO_TEXTS]", {
|
|
528
539
|
factory: function () { return ["Read more more about modes: ", "Background", "Form value"]; },
|
|
529
540
|
});
|
|
530
541
|
/**
|
|
542
|
+
* tui-doc-documentation i18n texts
|
|
531
543
|
* Works with a tuple
|
|
532
544
|
* [
|
|
533
545
|
* @string word 'argument',
|
|
@@ -537,7 +549,7 @@
|
|
|
537
549
|
* @string message for tooltip about ng-polymorpheus
|
|
538
550
|
* ]
|
|
539
551
|
*/
|
|
540
|
-
var TUI_DOC_DOCUMENTATION_TEXTS = new i0.InjectionToken("[TUI_DOC_DOCUMENTATION_TEXTS]
|
|
552
|
+
var TUI_DOC_DOCUMENTATION_TEXTS = new i0.InjectionToken("[TUI_DOC_DOCUMENTATION_TEXTS]", {
|
|
541
553
|
factory: function () { return [
|
|
542
554
|
"Argument",
|
|
543
555
|
"Type",
|
|
@@ -547,6 +559,7 @@
|
|
|
547
559
|
]; },
|
|
548
560
|
});
|
|
549
561
|
/**
|
|
562
|
+
* tui-doc-example i18n texts
|
|
550
563
|
* Works with a tuple
|
|
551
564
|
* [
|
|
552
565
|
* @string default tab name,
|
|
@@ -554,19 +567,19 @@
|
|
|
554
567
|
* @string link to a sample copied message label
|
|
555
568
|
* ]
|
|
556
569
|
*/
|
|
557
|
-
var TUI_DOC_EXAMPLE_TEXTS = new i0.InjectionToken("[TUI_DOC_EXAMPLE_TEXTS]
|
|
570
|
+
var TUI_DOC_EXAMPLE_TEXTS = new i0.InjectionToken("[TUI_DOC_EXAMPLE_TEXTS]", {
|
|
558
571
|
factory: function () { return ["Preview", "Link to a sample was successfully copied", "Done"]; },
|
|
559
572
|
});
|
|
560
|
-
var TUI_DOC_MENU_TEXT = new i0.InjectionToken("[TUI_DOC_MENU_TEXT]
|
|
573
|
+
var TUI_DOC_MENU_TEXT = new i0.InjectionToken("[TUI_DOC_MENU_TEXT]", {
|
|
561
574
|
factory: function () { return "Menu"; },
|
|
562
575
|
});
|
|
563
|
-
var TUI_DOC_SEARCH_TEXT = new i0.InjectionToken("[TUI_DOC_SEARCH_TEXT]
|
|
576
|
+
var TUI_DOC_SEARCH_TEXT = new i0.InjectionToken("[TUI_DOC_SEARCH_TEXT]", {
|
|
564
577
|
factory: function () { return "Search"; },
|
|
565
578
|
});
|
|
566
|
-
var TUI_DOC_SEE_ALSO_TEXT = new i0.InjectionToken("[TUI_DOC_SEE_ALSO_TEXT]
|
|
579
|
+
var TUI_DOC_SEE_ALSO_TEXT = new i0.InjectionToken("[TUI_DOC_SEE_ALSO_TEXT]", {
|
|
567
580
|
factory: function () { return "See also"; },
|
|
568
581
|
});
|
|
569
|
-
var TUI_DOC_SOURCE_CODE_TEXT = new i0.InjectionToken("[TUI_DOC_SOURCE_CODE_TEXT]
|
|
582
|
+
var TUI_DOC_SOURCE_CODE_TEXT = new i0.InjectionToken("[TUI_DOC_SOURCE_CODE_TEXT]", {
|
|
570
583
|
factory: function () { return "Source code"; },
|
|
571
584
|
});
|
|
572
585
|
|
|
@@ -796,7 +809,10 @@
|
|
|
796
809
|
}]
|
|
797
810
|
}] });
|
|
798
811
|
|
|
799
|
-
|
|
812
|
+
/**
|
|
813
|
+
* Token to exclude inherited documentation properties
|
|
814
|
+
*/
|
|
815
|
+
var TUI_DOC_EXCLUDED_PROPERTIES = new i0.InjectionToken("[TUI_DOC_EXCLUDED_PROPERTIES]", { factory: function () { return new Set([]); } });
|
|
800
816
|
function tuiDocExcludeProperties(properties) {
|
|
801
817
|
return { provide: TUI_DOC_EXCLUDED_PROPERTIES, useValue: new Set(properties) };
|
|
802
818
|
}
|
|
@@ -1455,11 +1471,17 @@
|
|
|
1455
1471
|
}]
|
|
1456
1472
|
}] });
|
|
1457
1473
|
|
|
1458
|
-
|
|
1474
|
+
/**
|
|
1475
|
+
* Code actions for the opened tab with code example
|
|
1476
|
+
*/
|
|
1477
|
+
var TUI_DOC_CODE_ACTIONS = new i0.InjectionToken("[TUI_DOC_CODE_ACTIONS]", {
|
|
1459
1478
|
factory: function () { return ""; },
|
|
1460
1479
|
});
|
|
1461
1480
|
|
|
1462
|
-
|
|
1481
|
+
/**
|
|
1482
|
+
* Service for opening online IDE e.g. Stackblitz
|
|
1483
|
+
*/
|
|
1484
|
+
var TUI_DOC_CODE_EDITOR = new i0.InjectionToken("[TUI_DOC_CODE_EDITOR]");
|
|
1463
1485
|
|
|
1464
1486
|
function tuiRawLoadRecord(example) {
|
|
1465
1487
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -1514,7 +1536,10 @@
|
|
|
1514
1536
|
codeEditorVisibilityHandler: function (files) { return Boolean(files[TUI_EXAMPLE_PRIMARY_FILE_NAME.TS] &&
|
|
1515
1537
|
files[TUI_EXAMPLE_PRIMARY_FILE_NAME.HTML]); },
|
|
1516
1538
|
};
|
|
1517
|
-
|
|
1539
|
+
/**
|
|
1540
|
+
* Default parameters for DocExample component
|
|
1541
|
+
*/
|
|
1542
|
+
var TUI_DOC_EXAMPLE_OPTIONS = new i0.InjectionToken("[TUI_DOC_EXAMPLE_OPTIONS]", {
|
|
1518
1543
|
factory: function () { return TUI_DOC_EXAMPLE_DEFAULT_OPTIONS; },
|
|
1519
1544
|
});
|
|
1520
1545
|
function tuiDocExampleOptionsProvider(options) {
|
|
@@ -1832,9 +1857,15 @@
|
|
|
1832
1857
|
}]
|
|
1833
1858
|
}] });
|
|
1834
1859
|
|
|
1835
|
-
|
|
1860
|
+
/**
|
|
1861
|
+
* Stream that emits if loading of page is over (for example, to begin scrollIntoView)
|
|
1862
|
+
*/
|
|
1863
|
+
var TUI_DOC_PAGE_LOADED = new i0.InjectionToken("[TUI_DOC_PAGE_LOADED]", { factory: function () { return i9.defer(function () { return i9.timer(200).pipe(operators.switchMap(function () { return i9.of(true); })); }); } });
|
|
1836
1864
|
|
|
1837
|
-
|
|
1865
|
+
/**
|
|
1866
|
+
* Defines the transition animation for scroll
|
|
1867
|
+
*/
|
|
1868
|
+
var TUI_DOC_SCROLL_BEHAVIOR = new i0.InjectionToken("[TUI_DOC_SCROLL_BEHAVIOR]", { factory: function () { return "smooth"; } });
|
|
1838
1869
|
|
|
1839
1870
|
var MAP = {
|
|
1840
1871
|
а: "f",
|
|
@@ -1883,17 +1914,32 @@
|
|
|
1883
1914
|
return newStr;
|
|
1884
1915
|
}
|
|
1885
1916
|
|
|
1886
|
-
|
|
1917
|
+
/**
|
|
1918
|
+
* Documentation pages
|
|
1919
|
+
*/
|
|
1920
|
+
var TUI_DOC_PAGES = new i0.InjectionToken("[TUI_DOC_PAGES]", {
|
|
1887
1921
|
factory: function () { return []; },
|
|
1888
1922
|
});
|
|
1889
1923
|
|
|
1890
|
-
|
|
1924
|
+
/**
|
|
1925
|
+
* Page title prefix
|
|
1926
|
+
*/
|
|
1927
|
+
var TUI_DOC_TITLE = new i0.InjectionToken("[TUI_DOC_TITLE]", {
|
|
1891
1928
|
factory: function () { return ""; },
|
|
1892
1929
|
});
|
|
1893
1930
|
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1931
|
+
/**
|
|
1932
|
+
* Page title
|
|
1933
|
+
*/
|
|
1934
|
+
var NAVIGATION_TITLE = new i0.InjectionToken("[NAVIGATION_TITLE]");
|
|
1935
|
+
/**
|
|
1936
|
+
* Navigation sections labels for search
|
|
1937
|
+
*/
|
|
1938
|
+
var NAVIGATION_LABELS = new i0.InjectionToken("[NAVIGATION_LABELS]");
|
|
1939
|
+
/**
|
|
1940
|
+
* Navigation pages
|
|
1941
|
+
*/
|
|
1942
|
+
var NAVIGATION_ITEMS = new i0.InjectionToken("[NAVIGATION_ITEMS]");
|
|
1897
1943
|
var NAVIGATION_PROVIDERS = [
|
|
1898
1944
|
i6.TuiDestroyService,
|
|
1899
1945
|
{
|
|
@@ -2182,7 +2228,10 @@
|
|
|
2182
2228
|
args: ['class._open']
|
|
2183
2229
|
}], filterItems: [], flattenSubPages: [] } });
|
|
2184
2230
|
|
|
2185
|
-
|
|
2231
|
+
/**
|
|
2232
|
+
* Main logo
|
|
2233
|
+
*/
|
|
2234
|
+
var TUI_DOC_LOGO = new i0.InjectionToken("[TUI_DOC_LOGO]", {
|
|
2186
2235
|
factory: function () { return ""; },
|
|
2187
2236
|
});
|
|
2188
2237
|
|
|
@@ -2471,15 +2520,24 @@
|
|
|
2471
2520
|
}]
|
|
2472
2521
|
}] });
|
|
2473
2522
|
|
|
2474
|
-
|
|
2523
|
+
/**
|
|
2524
|
+
* Array of default tab names
|
|
2525
|
+
*/
|
|
2526
|
+
var TUI_DOC_DEFAULT_TABS = new i0.InjectionToken("[TUI_DOC_DEFAULT_TABS]", {
|
|
2475
2527
|
factory: function () { return []; },
|
|
2476
2528
|
});
|
|
2477
2529
|
|
|
2478
|
-
|
|
2530
|
+
/**
|
|
2531
|
+
* Array of arrays of related pages
|
|
2532
|
+
*/
|
|
2533
|
+
var TUI_DOC_SEE_ALSO = new i0.InjectionToken("[TUI_DOC_SEE_ALSO]", {
|
|
2479
2534
|
factory: function () { return []; },
|
|
2480
2535
|
});
|
|
2481
2536
|
|
|
2482
|
-
|
|
2537
|
+
/**
|
|
2538
|
+
* Array if related page titles
|
|
2539
|
+
*/
|
|
2540
|
+
var PAGE_SEE_ALSO = new i0.InjectionToken("[PAGE_SEE_ALSO]");
|
|
2483
2541
|
var PAGE_PROVIDERS = [
|
|
2484
2542
|
{
|
|
2485
2543
|
provide: PAGE_SEE_ALSO,
|
|
@@ -2522,7 +2580,10 @@
|
|
|
2522
2580
|
type: i0.Input
|
|
2523
2581
|
}] } });
|
|
2524
2582
|
|
|
2525
|
-
|
|
2583
|
+
/**
|
|
2584
|
+
* Source code link
|
|
2585
|
+
*/
|
|
2586
|
+
var TUI_DOC_SOURCE_CODE = new i0.InjectionToken("[TUI_DOC_SOURCE_CODE]", {
|
|
2526
2587
|
factory: function () { return null; },
|
|
2527
2588
|
});
|
|
2528
2589
|
|