@taiga-ui/addon-doc 3.51.0 → 3.52.0

package/bundles/taiga-ui-addon-doc-components.umd.js

@@ -731,6 +731,7 @@
             }] });
 
     var SERIALIZED_SUFFIX = '$';
+    // @bad TODO: refactor output and value sync
     var TuiDocDocumentationPropertyConnectorDirective = /** @class */ (function () {
         function TuiDocDocumentationPropertyConnectorDirective(template, locationRef, activatedRoute, urlSerializer, urlStateHandler) {
             this.template = template;
@@ -789,6 +790,7 @@
             this.setQueryParam(value);
         };
         TuiDocDocumentationPropertyConnectorDirective.prototype.emitEvent = function (event) {
+            // For more convenient debugging
             console.info(this.attrName, event);
             this.emits$.next(this.emits$.value + 1);
         };
@@ -1026,6 +1028,13 @@
         TuiInspectPipe.prototype.transform = function (value, depth) {
             if (depth === void 0) { depth = 2; }
             if (this.isE2E && typeof value === "function") {
+                /**
+                 * @description:
+                 * When developing in production mode the webpack bundler minify
+                 * functions in different ways, then due to which the string content
+                 * of the function may differ from build to build, which can be to
+                 * various problems when screenshot testing on e2e.
+                 */
                 return "\u03BB(x) => y";
             }
             return utils.tuiInspectAny(value, depth);
@@ -1059,6 +1068,8 @@
                 args: [{ name: "tuiIsPrimitivePolymorpheusContentPipe" }]
             }] });
 
+    // @bad TODO subscribe propertiesConnectors changes
+    // @bad TODO refactor to make more flexible
     var TuiDocDocumentationComponent = /** @class */ (function () {
         function TuiDocDocumentationComponent(cdr, texts, excludedProperties, destroy$, getColor, getOpacity) {
             this.cdr = cdr;
@@ -1282,6 +1293,9 @@
         fullsize: true,
         linkIcon: "tuiIconLink",
     };
+    /**
+     * Default parameters for DocExample component
+     */
     var TUI_DOC_EXAMPLE_OPTIONS = i6.tuiCreateToken(TUI_DOC_EXAMPLE_DEFAULT_OPTIONS);
     function tuiDocExampleOptionsProvider(options) {
         return i6.tuiProvideOptions(TUI_DOC_EXAMPLE_OPTIONS, options, TUI_DOC_EXAMPLE_DEFAULT_OPTIONS);
@@ -1514,8 +1528,17 @@
                     }]
             }] });
 
+    /**
+     * Page title
+     */
     var NAVIGATION_TITLE = new i0.InjectionToken("[NAVIGATION_TITLE]");
+    /**
+     * Navigation sections labels for search
+     */
     var NAVIGATION_LABELS = new i0.InjectionToken("[NAVIGATION_LABELS]");
+    /**
+     * Navigation pages
+     */
     var NAVIGATION_ITEMS = new i0.InjectionToken("[NAVIGATION_ITEMS]");
     var NAVIGATION_PROVIDERS = [
         i6.TuiDestroyService,
@@ -1582,6 +1605,8 @@
             this.search = new i5.FormControl('');
             this.filtered$ = i6.tuiControlValue(this.search).pipe(operators.filter(function (search) { return search.trim().length > 2; }), operators.map(function (search) { return _this.filterItems(_this.flattenSubPages(_this.items), search); }));
             this.mode$ = this.mode.change$.pipe(operators.startWith(null), operators.map(function () { return _this.mode.mode || 'onLight'; }));
+            // Angular can't navigate no anchor links
+            // https://stackoverflow.com/questions/36101756/angular2-routing-with-hashtag-to-page-anchor
             title$.subscribe(function (title) {
                 cdr.markForCheck();
                 titleService.setTitle(title);
@@ -2089,6 +2114,10 @@
             ]);
             this.names = Array.from(this.flags.keys());
         }
+        /**
+         * @deprecated use `<img [src]="countryIsoCode | tuiFlagPipe" />`
+         * TODO drop in v4.0
+         */
         TuiLanguageSwitcherComponent.prototype.getFlagPath = function (code) {
             return this.flagPipe.transform(code);
         };
@@ -2096,6 +2125,7 @@
     }());
     TuiLanguageSwitcherComponent.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0__namespace, type: TuiLanguageSwitcherComponent, deps: [{ token: i5$2.TuiLanguageSwitcher }, { token: i2.TuiFlagPipe }], target: i0__namespace.ɵɵFactoryTarget.Component });
     TuiLanguageSwitcherComponent.ɵcmp = i0__namespace.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "12.2.17", type: TuiLanguageSwitcherComponent, selector: "tui-language-switcher", providers: [
+            // TODO: for backward compatibility only. Drop in v4.0
             i2.TuiFlagPipe,
         ], ngImport: i0__namespace, template: "<tui-select [formControl]=\"language\">\n    <ng-content></ng-content>\n    <tui-data-list *tuiDataList>\n        <button\n            *ngFor=\"let name of names\"\n            tuiOption\n            [value]=\"name | titlecase\"\n            (click)=\"switcher.setLanguage(name)\"\n        >\n            <img\n                alt=\"\"\n                class=\"t-flag\"\n                [src]=\"flags.get(name) | tuiFlag\"\n            />\n            {{ name | titlecase }}\n        </button>\n    </tui-data-list>\n</tui-select>\n", styles: [".t-flag{width:1.75rem;height:1.25rem;margin-right:.5rem}\n"], components: [{ type: i1__namespace.TuiSelectComponent, selector: "tui-select", inputs: ["stringify", "identityMatcher", "valueContent"] }, { type: i2__namespace.TuiDataListComponent, selector: "tui-data-list", inputs: ["role", "emptyContent", "size"] }, { type: i2__namespace.TuiOptionComponent, selector: "button[tuiOption], a[tuiOption]", inputs: ["size", "role", "disabled", "value"] }], directives: [{ type: i1__namespace.TuiSelectDirective, selector: "tui-select" }, { type: i5__namespace.NgControlStatus, selector: "[formControlName],[ngModel],[formControl]" }, { type: i5__namespace.FormControlDirective, selector: "[formControl]", inputs: ["disabled", "formControl", "ngModel"], outputs: ["ngModelChange"], exportAs: ["ngForm"] }, { type: i2__namespace.TuiDataListDirective, selector: "ng-template[tuiDataList]" }, { type: i4__namespace.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }], pipes: { "titlecase": i4__namespace.TitleCasePipe, "tuiFlag": i2__namespace.TuiFlagPipe }, changeDetection: i0__namespace.ChangeDetectionStrategy.OnPush });
     i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0__namespace, type: TuiLanguageSwitcherComponent, decorators: [{
@@ -2105,6 +2135,7 @@
                         templateUrl: './language-switcher.component.html',
                         styleUrls: ['./language-switcher.component.less'],
                         providers: [
+                            // TODO: for backward compatibility only. Drop in v4.0
                             i2.TuiFlagPipe,
                         ],
                         changeDetection: i0.ChangeDetectionStrategy.OnPush,
@@ -2192,6 +2223,8 @@
                         templateUrl: './main.template.html',
                         styleUrls: ['./main.style.less'],
                         encapsulation: i0.ViewEncapsulation.None,
+                        // @note: This one was default on purpose so we can test demo in default mode.
+                        // eslint-disable-next-line @angular-eslint/prefer-on-push-component-change-detection
                         changeDetection: i0.ChangeDetectionStrategy.Default,
                         providers: [
                             {
@@ -2265,6 +2298,9 @@
                     }]
             }] });
 
+    /**
+     * Array if related page titles
+     */
     var PAGE_SEE_ALSO = new i0.InjectionToken("[PAGE_SEE_ALSO]");
     var PAGE_PROVIDERS = [
         {
@@ -2401,6 +2437,10 @@
                     }]
             }] });
 
+    /**
+     * Generated bundle index. Do not edit.
+     */
+
     exports.PAGE_PROVIDERS = PAGE_PROVIDERS;
     exports.PAGE_SEE_ALSO = PAGE_SEE_ALSO;
     exports.TUI_DOC_EXAMPLE_DEFAULT_OPTIONS = TUI_DOC_EXAMPLE_DEFAULT_OPTIONS;